DpsCertificate interface
Interface representing a DpsCertificate.
Methods
| create |
Add new certificate or update an existing certificate. |
| delete(string, string, string, string, Dps |
Deletes the specified certificate associated with the Provisioning Service |
| generate |
Generate verification code for Proof of Possession. |
| get(string, string, string, Dps |
Get the certificate from the provisioning service. |
| list(string, string, Dps |
Get all the certificates tied to the provisioning service. |
| verify |
Verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate. |
Method Details
createOrUpdate(string, string, string, CertificateResponse, DpsCertificateCreateOrUpdateOptionalParams)
Add new certificate or update an existing certificate.
function createOrUpdate(resourceGroupName: string, provisioningServiceName: string, certificateName: string, certificateDescription: CertificateResponse, options?: DpsCertificateCreateOrUpdateOptionalParams): Promise<CertificateResponse>Parameters
- resourceGroupName
-
string
Resource group identifier.
- provisioningServiceName
-
string
The name of the provisioning service.
- certificateName
-
string
The name of the certificate create or update.
- certificateDescription
- CertificateResponse
The certificate body.
The options parameters.
Returns
Promise<CertificateResponse>
delete(string, string, string, string, DpsCertificateDeleteOptionalParams)
Deletes the specified certificate associated with the Provisioning Service
function delete(resourceGroupName: string, ifMatch: string, provisioningServiceName: string, certificateName: string, options?: DpsCertificateDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Resource group identifier.
- ifMatch
-
string
ETag of the certificate
- provisioningServiceName
-
string
The name of the provisioning service.
- certificateName
-
string
This is a mandatory field, and is the logical name of the certificate that the provisioning service will access by.
The options parameters.
Returns
Promise<void>
generateVerificationCode(string, string, string, string, DpsCertificateGenerateVerificationCodeOptionalParams)
Generate verification code for Proof of Possession.
function generateVerificationCode(certificateName: string, ifMatch: string, resourceGroupName: string, provisioningServiceName: string, options?: DpsCertificateGenerateVerificationCodeOptionalParams): Promise<VerificationCodeResponse>Parameters
- certificateName
-
string
The mandatory logical name of the certificate, that the provisioning service uses to access.
- ifMatch
-
string
ETag of the certificate. This is required to update an existing certificate, and ignored while creating a brand new certificate.
- resourceGroupName
-
string
name of resource group.
- provisioningServiceName
-
string
Name of provisioning service.
The options parameters.
Returns
Promise<VerificationCodeResponse>
get(string, string, string, DpsCertificateGetOptionalParams)
Get the certificate from the provisioning service.
function get(certificateName: string, resourceGroupName: string, provisioningServiceName: string, options?: DpsCertificateGetOptionalParams): Promise<CertificateResponse>Parameters
- certificateName
-
string
Name of the certificate to retrieve.
- resourceGroupName
-
string
Resource group identifier.
- provisioningServiceName
-
string
Name of the provisioning service the certificate is associated with.
- options
- DpsCertificateGetOptionalParams
The options parameters.
Returns
Promise<CertificateResponse>
list(string, string, DpsCertificateListOptionalParams)
Get all the certificates tied to the provisioning service.
function list(resourceGroupName: string, provisioningServiceName: string, options?: DpsCertificateListOptionalParams): Promise<CertificateListDescription>Parameters
- resourceGroupName
-
string
Name of resource group.
- provisioningServiceName
-
string
Name of provisioning service to retrieve certificates for.
- options
- DpsCertificateListOptionalParams
The options parameters.
Returns
Promise<CertificateListDescription>
verifyCertificate(string, string, string, string, VerificationCodeRequest, DpsCertificateVerifyCertificateOptionalParams)
Verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate.
function verifyCertificate(certificateName: string, ifMatch: string, resourceGroupName: string, provisioningServiceName: string, request: VerificationCodeRequest, options?: DpsCertificateVerifyCertificateOptionalParams): Promise<CertificateResponse>Parameters
- certificateName
-
string
The mandatory logical name of the certificate, that the provisioning service uses to access.
- ifMatch
-
string
ETag of the certificate.
- resourceGroupName
-
string
Resource group name.
- provisioningServiceName
-
string
Provisioning service name.
- request
- VerificationCodeRequest
The name of the certificate
The options parameters.
Returns
Promise<CertificateResponse>