DpsCertificateOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:dps_certificate> attribute.

Constructor

DpsCertificateOperations(*args, **kwargs)

Methods

create_or_update	Add new certificate or update an existing certificate.
delete	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	Verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate.

create_or_update

Add new certificate or update an existing certificate.

create_or_update(resource_group_name: str, provisioning_service_name: str, certificate_name: str, certificate_description: _models.CertificateResponse, *, content_type: str = 'application/json', etag: str | None = None, match_condition: MatchConditions | None = None, **kwargs: Any) -> _models.CertificateResponse

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
provisioning_service_name Required	str Name of the provisioning service to retrieve. Required.
certificate_name Required	str Name of the certificate to retrieve. Required.
certificate_description Required	CertificateResponse or CertificateResponse or IO[bytes] The certificate body. Is either a CertificateResponse type or a IO[bytes] type. Required.

Keyword-Only Parameters

Name	Description
etag	str check if resource is changed. Set None to skip checking etag. Default value is None. Default value: None
match_condition	MatchConditions The match condition to use upon the etag. Default value is None. Default value: None

Returns

Type	Description
CertificateResponse	CertificateResponse. The CertificateResponse is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

delete

Deletes the specified certificate associated with the Provisioning Service.

delete(resource_group_name: str, provisioning_service_name: str, certificate_name: str, *, etag: str, match_condition: MatchConditions, certificate_name1: str | None = None, certificate_raw_bytes: bytes | None = None, certificate_is_verified: bool | None = None, certificate_purpose: str | CertificatePurpose | None = None, certificate_created: datetime | None = None, certificate_last_updated: datetime | None = None, certificate_has_private_key: bool | None = None, certificate_nonce: str | None = None, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
provisioning_service_name Required	str Name of the provisioning service to retrieve. Required.
certificate_name Required	str Name of the certificate to retrieve. Required.

Keyword-Only Parameters

Name	Description
etag	str check if resource is changed. Set None to skip checking etag. Required.
match_condition	MatchConditions The match condition to use upon the etag. Required.
certificate_name1	str This is optional, and it is the Common Name of the certificate. Default value is None. Default value: None
certificate_raw_bytes	bytes Raw data within the certificate. Default value is None. Default value: None
certificate_is_verified	bool Indicates if certificate has been verified by owner of the private key. Default value is None. Default value: None
certificate_purpose	str or CertificatePurpose A description that mentions the purpose of the certificate. Known values are: "clientAuthentication" and "serverAuthentication". Default value is None. Default value: None
certificate_created	datetime Time the certificate is created. Default value is None. Default value: None
certificate_last_updated	datetime Certificate last updated time. Default value is None. Default value: None
certificate_has_private_key	bool Indicates if the certificate contains a private key. Default value is None. Default value: None
certificate_nonce	str Random number generated to indicate Proof of Possession. Default value is None. Default value: None

Returns

Type	Description
None	None

Exceptions

Type	Description
HttpResponseError

generate_verification_code

Generate verification code for Proof of Possession.

generate_verification_code(certificate_name: str, resource_group_name: str, provisioning_service_name: str, *, etag: str, match_condition: MatchConditions, certificate_name1: str | None = None, certificate_raw_bytes: bytes | None = None, certificate_is_verified: bool | None = None, certificate_purpose: str | CertificatePurpose | None = None, certificate_created: datetime | None = None, certificate_last_updated: datetime | None = None, certificate_has_private_key: bool | None = None, certificate_nonce: str | None = None, **kwargs: Any) -> VerificationCodeResponse

Parameters

Name	Description
certificate_name Required	str Name of the certificate to retrieve. Required.
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
provisioning_service_name Required	str Name of the provisioning service to retrieve. Required.

Keyword-Only Parameters

Name	Description
etag	str check if resource is changed. Set None to skip checking etag. Required.
match_condition	MatchConditions The match condition to use upon the etag. Required.
certificate_name1	str Common Name for the certificate. Default value is None. Default value: None
certificate_raw_bytes	bytes Raw data of certificate. Default value is None. Default value: None
certificate_is_verified	bool Indicates if the certificate has been verified by owner of the private key. Default value is None. Default value: None
certificate_purpose	str or CertificatePurpose Description mentioning the purpose of the certificate. Known values are: "clientAuthentication" and "serverAuthentication". Default value is None. Default value: None
certificate_created	datetime Time the certificate is created. Default value is None. Default value: None
certificate_last_updated	datetime Certificate last updated time. Default value is None. Default value: None
certificate_has_private_key	bool Indicates if the certificate contains private key. Default value is None. Default value: None
certificate_nonce	str Random number generated to indicate Proof of Possession. Default value is None. Default value: None

Returns

Type	Description
VerificationCodeResponse	VerificationCodeResponse. The VerificationCodeResponse is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

get

Get the certificate from the provisioning service.

get(certificate_name: str, resource_group_name: str, provisioning_service_name: str, *, etag: str | None = None, match_condition: MatchConditions | None = None, **kwargs: Any) -> CertificateResponse

Parameters

Name	Description
certificate_name Required	str Name of the certificate to retrieve. Required.
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
provisioning_service_name Required	str Name of the provisioning service to retrieve. Required.

Keyword-Only Parameters

Name	Description
etag	str check if resource is changed. Set None to skip checking etag. Default value is None. Default value: None
match_condition	MatchConditions The match condition to use upon the etag. Default value is None. Default value: None

Returns

Type	Description
CertificateResponse	CertificateResponse. The CertificateResponse is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list

Get all the certificates tied to the provisioning service.

list(resource_group_name: str, provisioning_service_name: str, **kwargs: Any) -> CertificateListDescription

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
provisioning_service_name Required	str Name of the provisioning service to retrieve. Required.

Returns

Type	Description
CertificateListDescription	CertificateListDescription. The CertificateListDescription is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

verify_certificate

Verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate.

verify_certificate(certificate_name: str, resource_group_name: str, provisioning_service_name: str, request: _models.VerificationCodeRequest, *, etag: str, match_condition: MatchConditions, certificate_name1: str | None = None, certificate_raw_bytes: bytes | None = None, certificate_is_verified: bool | None = None, certificate_purpose: str | _models.CertificatePurpose | None = None, certificate_created: datetime.datetime | None = None, certificate_last_updated: datetime.datetime | None = None, certificate_has_private_key: bool | None = None, certificate_nonce: str | None = None, content_type: str = 'application/json', **kwargs: Any) -> _models.CertificateResponse

Parameters

Name	Description
certificate_name Required	str Name of the certificate to retrieve. Required.
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
provisioning_service_name Required	str Name of the provisioning service to retrieve. Required.
request Required	VerificationCodeRequest or VerificationCodeRequest or IO[bytes] The name of the certificate. Is either a VerificationCodeRequest type or a IO[bytes] type. Required.

Keyword-Only Parameters

Name	Description
etag	str check if resource is changed. Set None to skip checking etag. Required.
match_condition	MatchConditions The match condition to use upon the etag. Required.
certificate_name1	str Common Name for the certificate. Default value is None. Default value: None
certificate_raw_bytes	bytes Raw data of certificate. Default value is None. Default value: None
certificate_is_verified	bool Indicates if the certificate has been verified by owner of the private key. Default value is None. Default value: None
certificate_purpose	str or CertificatePurpose Describe the purpose of the certificate. Known values are: "clientAuthentication" and "serverAuthentication". Default value is None. Default value: None
certificate_created	datetime Time the certificate is created. Default value is None. Default value: None
certificate_last_updated	datetime Certificate last updated time. Default value is None. Default value: None
certificate_has_private_key	bool Indicates if the certificate contains private key. Default value is None. Default value: None
certificate_nonce	str Random number generated to indicate Proof of Possession. Default value is None. Default value: None

Returns

Type	Description
CertificateResponse	CertificateResponse. The CertificateResponse is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

Feedback

Was this page helpful?