DpsCertificateOperations interface

Package:

@azure/arm-deviceprovisioningservices

Interface representing a DpsCertificate operations.

Properties

createOrUpdate	Add new certificate or update an existing certificate.
delete	Deletes the specified certificate associated with the Provisioning Service
generateVerificationCode	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.
verifyCertificate	Verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate.

Property Details

createOrUpdate

Add new certificate or update an existing certificate.

createOrUpdate: (resourceGroupName: string, provisioningServiceName: string, certificateName: string, certificateDescription: CertificateResponse, options?: DpsCertificateCreateOrUpdateOptionalParams) => Promise<CertificateResponse>

Property Value

(resourceGroupName: string, provisioningServiceName: string, certificateName: string, certificateDescription: CertificateResponse, options?: DpsCertificateCreateOrUpdateOptionalParams) => Promise<CertificateResponse>

delete

Deletes the specified certificate associated with the Provisioning Service

delete: (resourceGroupName: string, provisioningServiceName: string, certificateName: string, ifMatch: string, options?: DpsCertificateDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, provisioningServiceName: string, certificateName: string, ifMatch: string, options?: DpsCertificateDeleteOptionalParams) => Promise<void>

generateVerificationCode

Generate verification code for Proof of Possession.

generateVerificationCode: (certificateName: string, ifMatch: string, resourceGroupName: string, provisioningServiceName: string, options?: DpsCertificateGenerateVerificationCodeOptionalParams) => Promise<VerificationCodeResponse>

Property Value

(certificateName: string, ifMatch: string, resourceGroupName: string, provisioningServiceName: string, options?: DpsCertificateGenerateVerificationCodeOptionalParams) => Promise<VerificationCodeResponse>

get

Get the certificate from the provisioning service.

get: (certificateName: string, resourceGroupName: string, provisioningServiceName: string, options?: DpsCertificateGetOptionalParams) => Promise<CertificateResponse>

Property Value

(certificateName: string, resourceGroupName: string, provisioningServiceName: string, options?: DpsCertificateGetOptionalParams) => Promise<CertificateResponse>

list

Get all the certificates tied to the provisioning service.

list: (resourceGroupName: string, provisioningServiceName: string, options?: DpsCertificateListOptionalParams) => Promise<CertificateListDescription>

Property Value

(resourceGroupName: string, provisioningServiceName: string, options?: DpsCertificateListOptionalParams) => Promise<CertificateListDescription>

verifyCertificate

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

verifyCertificate: (certificateName: string, ifMatch: string, resourceGroupName: string, provisioningServiceName: string, request: VerificationCodeRequest, options?: DpsCertificateVerifyCertificateOptionalParams) => Promise<CertificateResponse>

Property Value

(certificateName: string, ifMatch: string, resourceGroupName: string, provisioningServiceName: string, request: VerificationCodeRequest, options?: DpsCertificateVerifyCertificateOptionalParams) => Promise<CertificateResponse>