azure.mgmt.iothub.v2023_06_30.operations.CertificatesOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.iothub.v2023_06_30.operations.CertificatesOperations
name: CertificatesOperations
fullName: azure.mgmt.iothub.v2023_06_30.operations.CertificatesOperations
module: azure.mgmt.iothub.v2023_06_30.operations
inheritances:
- builtins.object
summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
  \ you should access the following operations through\n>\n> <xref:azure.mgmt.iothub.v2023_06_30.IotHubClient>'s\n\
  >\n> <xref:certificates> attribute.\n>"
constructor:
  syntax: CertificatesOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.iothub.v2023_06_30.operations.CertificatesOperations.create_or_update
  name: create_or_update
  summary: 'Upload the certificate to the IoT hub.


    Adds new or replaces existing certificate.'
  signature: 'create_or_update(resource_group_name: str, resource_name: str, certificate_name:
    str, certificate_description: _models.CertificateDescription, if_match: str |
    None = None, *, content_type: str = ''application/json'', **kwargs: Any) -> _models.CertificateDescription'
  parameters:
  - name: resource_group_name
    description: The name of the resource group that contains the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: certificate_name
    description: The name of the certificate. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: certificate_description
    description: 'The certificate body. Is either a CertificateDescription type

      or a IO type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.iothub.v2023_06_30.models.CertificateDescription>
    - <xref:typing.IO>
  - name: if_match
    description: 'ETag of the Certificate. Do not specify for creating a brand new
      certificate.

      Required to update an existing certificate. Default value is None.'
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: CertificateDescription or the result of cls(response)
    types:
    - <xref:azure.mgmt.iothub.v2023_06_30.models.CertificateDescription>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.iothub.v2023_06_30.operations.CertificatesOperations.delete
  name: delete
  summary: 'Delete an X509 certificate.


    Deletes an existing X509 certificate or does nothing if it does not exist.'
  signature: 'delete(resource_group_name: str, resource_name: str, certificate_name:
    str, if_match: str, **kwargs: Any) -> None'
  parameters:
  - name: resource_group_name
    description: The name of the resource group that contains the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: certificate_name
    description: The name of the certificate. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: if_match
    description: ETag of the Certificate. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: None or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.iothub.v2023_06_30.operations.CertificatesOperations.generate_verification_code
  name: generate_verification_code
  summary: 'Generate verification code for proof of possession flow.


    Generates verification code for proof of possession flow. The verification code
    will be used to

    generate a leaf certificate.'
  signature: 'generate_verification_code(resource_group_name: str, resource_name:
    str, certificate_name: str, if_match: str, **kwargs: Any) -> CertificateWithNonceDescription'
  parameters:
  - name: resource_group_name
    description: The name of the resource group that contains the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: certificate_name
    description: The name of the certificate. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: if_match
    description: ETag of the Certificate. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: CertificateWithNonceDescription or the result of cls(response)
    types:
    - <xref:azure.mgmt.iothub.v2023_06_30.models.CertificateWithNonceDescription>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.iothub.v2023_06_30.operations.CertificatesOperations.get
  name: get
  summary: 'Get the certificate.


    Returns the certificate.'
  signature: 'get(resource_group_name: str, resource_name: str, certificate_name:
    str, **kwargs: Any) -> CertificateDescription'
  parameters:
  - name: resource_group_name
    description: The name of the resource group that contains the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: certificate_name
    description: The name of the certificate. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: CertificateDescription or the result of cls(response)
    types:
    - <xref:azure.mgmt.iothub.v2023_06_30.models.CertificateDescription>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.iothub.v2023_06_30.operations.CertificatesOperations.list_by_iot_hub
  name: list_by_iot_hub
  summary: 'Get the certificate list.


    Returns the list of certificates.'
  signature: 'list_by_iot_hub(resource_group_name: str, resource_name: str, **kwargs:
    Any) -> CertificateListDescription'
  parameters:
  - name: resource_group_name
    description: The name of the resource group that contains the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: CertificateListDescription or the result of cls(response)
    types:
    - <xref:azure.mgmt.iothub.v2023_06_30.models.CertificateListDescription>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.iothub.v2023_06_30.operations.CertificatesOperations.verify
  name: verify
  summary: 'Verify certificate''s private key possession.


    Verifies the certificate''s private key possession by providing the leaf cert
    issued by the

    verifying pre uploaded certificate.'
  signature: 'verify(resource_group_name: str, resource_name: str, certificate_name:
    str, if_match: str, certificate_verification_body: _models.CertificateVerificationDescription,
    *, content_type: str = ''application/json'', **kwargs: Any) -> _models.CertificateDescription'
  parameters:
  - name: resource_group_name
    description: The name of the resource group that contains the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: certificate_name
    description: The name of the certificate. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: if_match
    description: ETag of the Certificate. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: certificate_verification_body
    description: 'The name of the certificate. Is either a

      CertificateVerificationDescription type or a IO type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.iothub.v2023_06_30.models.CertificateVerificationDescription>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: CertificateDescription or the result of cls(response)
    types:
    - <xref:azure.mgmt.iothub.v2023_06_30.models.CertificateDescription>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.iothub.v2023_06_30.operations.CertificatesOperations.models
  name: models
  signature: models = <module 'azure.mgmt.iothub.v2023_06_30.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\iothub\\v2023_06_30\\models\\__init__.py'>