DpsCertificateOperations Class
DpsCertificateOperations async operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Inheritance
-
builtins.objectDpsCertificateOperations
Constructor
DpsCertificateOperations(client, config, serializer, deserializer)Parameters
- client
Client for service requests.
- config
Configuration of service client.
- serializer
An object model serializer.
- deserializer
An object model deserializer.
Variables
- models
Alias to model classes used in this operation group.
Methods
| create_or_update |
Upload the certificate to the provisioning service. Add new certificate or update an existing certificate. |
| delete |
Delete the Provisioning Service Certificate. Deletes the specified certificate associated with the Provisioning Service. |
| generate_verification_code |
Generate verification code for Proof of Possession. |
| get |
Get the certificate from the provisioning service. |
| list |
Get all the certificates tied to the provisioning service. |
| verify_certificate |
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. |
create_or_update
Upload the certificate to the provisioning service.
Add new certificate or update an existing certificate.
async create_or_update(resource_group_name: str, provisioning_service_name: str, certificate_name: str, certificate_description: azure.mgmt.iothubprovisioningservices.models._models_py3.CertificateBodyDescription, if_match: Optional[str] = None, **kwargs: Any) -> azure.mgmt.iothubprovisioningservices.models._models_py3.CertificateResponseParameters
- if_match
- str
ETag of the certificate. This is required to update an existing certificate, and ignored while creating a brand new certificate.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
CertificateResponse, or the result of cls(response)
Return type
Exceptions
delete
Delete the Provisioning Service Certificate.
Deletes the specified certificate associated with the Provisioning Service.
async delete(resource_group_name: str, if_match: str, provisioning_service_name: str, certificate_name: str, certificate_name1: Optional[str] = None, certificate_raw_bytes: Optional[bytearray] = None, certificate_is_verified: Optional[bool] = None, certificate_purpose: Optional[Union[str, azure.mgmt.iothubprovisioningservices.models._iot_dps_client_enums.CertificatePurpose]] = None, certificate_created: Optional[datetime.datetime] = None, certificate_last_updated: Optional[datetime.datetime] = None, certificate_has_private_key: Optional[bool] = None, certificate_nonce: Optional[str] = None, **kwargs: Any) -> NoneParameters
- certificate_name
- str
This is a mandatory field, and is the logical name of the certificate that the provisioning service will access by.
- certificate_is_verified
- bool
Indicates if certificate has been verified by owner of the private key.
- certificate_purpose
- str or CertificatePurpose
A description that mentions the purpose of the certificate.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
None, or the result of cls(response)
Return type
Exceptions
generate_verification_code
Generate verification code for Proof of Possession.
async generate_verification_code(certificate_name: str, if_match: str, resource_group_name: str, provisioning_service_name: str, certificate_name1: Optional[str] = None, certificate_raw_bytes: Optional[bytearray] = None, certificate_is_verified: Optional[bool] = None, certificate_purpose: Optional[Union[str, azure.mgmt.iothubprovisioningservices.models._iot_dps_client_enums.CertificatePurpose]] = None, certificate_created: Optional[datetime.datetime] = None, certificate_last_updated: Optional[datetime.datetime] = None, certificate_has_private_key: Optional[bool] = None, certificate_nonce: Optional[str] = None, **kwargs: Any) -> azure.mgmt.iothubprovisioningservices.models._models_py3.VerificationCodeResponseParameters
- certificate_name
- str
The mandatory logical name of the certificate, that the provisioning service uses to access.
- if_match
- str
ETag of the certificate. This is required to update an existing certificate, and ignored while creating a brand new certificate.
- certificate_is_verified
- bool
Indicates if the certificate has been verified by owner of the private key.
- certificate_purpose
- str or CertificatePurpose
Description mentioning the purpose of the certificate.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
VerificationCodeResponse, or the result of cls(response)
Return type
Exceptions
get
Get the certificate from the provisioning service.
async get(certificate_name: str, resource_group_name: str, provisioning_service_name: str, if_match: Optional[str] = None, **kwargs: Any) -> azure.mgmt.iothubprovisioningservices.models._models_py3.CertificateResponseParameters
- provisioning_service_name
- str
Name of the provisioning service the certificate is associated with.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
CertificateResponse, or the result of cls(response)
Return type
Exceptions
list
Get all the certificates tied to the provisioning service.
async list(resource_group_name: str, provisioning_service_name: str, **kwargs: Any) -> azure.mgmt.iothubprovisioningservices.models._models_py3.CertificateListDescriptionParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
CertificateListDescription, or the result of cls(response)
Return type
Exceptions
verify_certificate
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.
async verify_certificate(certificate_name: str, if_match: str, resource_group_name: str, provisioning_service_name: str, request: azure.mgmt.iothubprovisioningservices.models._models_py3.VerificationCodeRequest, certificate_name1: Optional[str] = None, certificate_raw_bytes: Optional[bytearray] = None, certificate_is_verified: Optional[bool] = None, certificate_purpose: Optional[Union[str, azure.mgmt.iothubprovisioningservices.models._iot_dps_client_enums.CertificatePurpose]] = None, certificate_created: Optional[datetime.datetime] = None, certificate_last_updated: Optional[datetime.datetime] = None, certificate_has_private_key: Optional[bool] = None, certificate_nonce: Optional[str] = None, **kwargs: Any) -> azure.mgmt.iothubprovisioningservices.models._models_py3.CertificateResponseParameters
- certificate_name
- str
The mandatory logical name of the certificate, that the provisioning service uses to access.
- certificate_is_verified
- bool
Indicates if the certificate has been verified by owner of the private key.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
CertificateResponse, or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.iothubprovisioningservices.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\iothubprovisioningservices\\models\\__init__.py'>Feedback
Submit and view feedback for