Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DpsCertificate

Package version

Class representing a DpsCertificate.

Hierarchy

  • DpsCertificate

Index

Constructors

Methods

Constructors

constructor

Methods

createOrUpdate

  • Add new certificate or update an existing certificate.

    summary

    Upload the certificate to the provisioning service.

    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: CertificateBodyDescription

      The certificate body.

    • Optional options: Models.DpsCertificateCreateOrUpdateOptionalParams

    Returns Promise<Models.DpsCertificateCreateOrUpdateResponse>

    Promise<Models.DpsCertificateCreateOrUpdateResponse>

  • 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: CertificateBodyDescription

      The certificate body.

    • callback: msRest.ServiceCallback<CertificateResponse>

      The callback

    Returns void

  • Parameters

    Returns void

deleteMethod

  • deleteMethod(resourceGroupName: string, ifMatch: string, provisioningServiceName: string, certificateName: string, options?: Models.DpsCertificateDeleteMethodOptionalParams): Promise<msRest.RestResponse>
  • deleteMethod(resourceGroupName: string, ifMatch: string, provisioningServiceName: string, certificateName: string, callback: msRest.ServiceCallback<void>): void
  • deleteMethod(resourceGroupName: string, ifMatch: string, provisioningServiceName: string, certificateName: string, options: DpsCertificateDeleteMethodOptionalParams, callback: msRest.ServiceCallback<void>): void

  • Deletes the specified certificate assosciated with the Provisioning Service

    summary

    Delete the Provisioning Service Certificate.

    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.

    • Optional options: Models.DpsCertificateDeleteMethodOptionalParams

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

  • 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.

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns 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.

    • options: DpsCertificateDeleteMethodOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

generateVerificationCode

  • generateVerificationCode(certificateName: string, ifMatch: string, resourceGroupName: string, provisioningServiceName: string, options?: Models.DpsCertificateGenerateVerificationCodeOptionalParams): Promise<Models.DpsCertificateGenerateVerificationCodeResponse>
  • generateVerificationCode(certificateName: string, ifMatch: string, resourceGroupName: string, provisioningServiceName: string, callback: msRest.ServiceCallback<VerificationCodeResponse>): void
  • generateVerificationCode(certificateName: string, ifMatch: string, resourceGroupName: string, provisioningServiceName: string, options: DpsCertificateGenerateVerificationCodeOptionalParams, callback: msRest.ServiceCallback<VerificationCodeResponse>): void

  • Generate verification code for Proof of Possession.

    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.

    • Optional options: Models.DpsCertificateGenerateVerificationCodeOptionalParams

    Returns Promise<Models.DpsCertificateGenerateVerificationCodeResponse>

    Promise<Models.DpsCertificateGenerateVerificationCodeResponse>

  • 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.

    • callback: msRest.ServiceCallback<VerificationCodeResponse>

      The callback

    Returns void

  • 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.

    • options: DpsCertificateGenerateVerificationCodeOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<VerificationCodeResponse>

      The callback

    Returns void

get

  • get(certificateName: string, resourceGroupName: string, provisioningServiceName: string, options?: Models.DpsCertificateGetOptionalParams): Promise<Models.DpsCertificateGetResponse>
  • get(certificateName: string, resourceGroupName: string, provisioningServiceName: string, callback: msRest.ServiceCallback<CertificateResponse>): void
  • get(certificateName: string, resourceGroupName: string, provisioningServiceName: string, options: DpsCertificateGetOptionalParams, callback: msRest.ServiceCallback<CertificateResponse>): void

  • Get the certificate from the provisioning service.

    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.

    • Optional options: Models.DpsCertificateGetOptionalParams

    Returns Promise<Models.DpsCertificateGetResponse>

    Promise<Models.DpsCertificateGetResponse>

  • 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.

    • callback: msRest.ServiceCallback<CertificateResponse>

      The callback

    Returns void

  • 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 optional parameters

    • callback: msRest.ServiceCallback<CertificateResponse>

      The callback

    Returns void

list

  • list(resourceGroupName: string, provisioningServiceName: string, options?: msRest.RequestOptionsBase): Promise<Models.DpsCertificateListResponse>
  • list(resourceGroupName: string, provisioningServiceName: string, callback: msRest.ServiceCallback<CertificateListDescription>): void
  • list(resourceGroupName: string, provisioningServiceName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<CertificateListDescription>): void

  • Get all the certificates tied to the provisioning service.

    Parameters

    • resourceGroupName: string

      Name of resource group.

    • provisioningServiceName: string

      Name of provisioning service to retrieve certificates for.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.DpsCertificateListResponse>

    Promise<Models.DpsCertificateListResponse>

  • Parameters

    • resourceGroupName: string

      Name of resource group.

    • provisioningServiceName: string

      Name of provisioning service to retrieve certificates for.

    • callback: msRest.ServiceCallback<CertificateListDescription>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      Name of resource group.

    • provisioningServiceName: string

      Name of provisioning service to retrieve certificates for.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<CertificateListDescription>

      The callback

    Returns void

verifyCertificate

  • verifyCertificate(certificateName: string, ifMatch: string, request: VerificationCodeRequest, resourceGroupName: string, provisioningServiceName: string, options?: Models.DpsCertificateVerifyCertificateOptionalParams): Promise<Models.DpsCertificateVerifyCertificateResponse>
  • verifyCertificate(certificateName: string, ifMatch: string, request: VerificationCodeRequest, resourceGroupName: string, provisioningServiceName: string, callback: msRest.ServiceCallback<CertificateResponse>): void
  • verifyCertificate(certificateName: string, ifMatch: string, request: VerificationCodeRequest, resourceGroupName: string, provisioningServiceName: string, options: DpsCertificateVerifyCertificateOptionalParams, callback: msRest.ServiceCallback<CertificateResponse>): void

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

    summary

    Verify certificate's private key possession.

    Parameters

    • certificateName: string

      The mandatory logical name of the certificate, that the provisioning service uses to access.

    • ifMatch: string

      ETag of the certificate.

    • request: VerificationCodeRequest

      The name of the certificate

    • resourceGroupName: string

      Resource group name.

    • provisioningServiceName: string

      Provisioning service name.

    • Optional options: Models.DpsCertificateVerifyCertificateOptionalParams

    Returns Promise<Models.DpsCertificateVerifyCertificateResponse>

    Promise<Models.DpsCertificateVerifyCertificateResponse>

  • Parameters

    • certificateName: string

      The mandatory logical name of the certificate, that the provisioning service uses to access.

    • ifMatch: string

      ETag of the certificate.

    • request: VerificationCodeRequest

      The name of the certificate

    • resourceGroupName: string

      Resource group name.

    • provisioningServiceName: string

      Provisioning service name.

    • callback: msRest.ServiceCallback<CertificateResponse>

      The callback

    Returns void

  • Parameters

    • certificateName: string

      The mandatory logical name of the certificate, that the provisioning service uses to access.

    • ifMatch: string

      ETag of the certificate.

    • request: VerificationCodeRequest

      The name of the certificate

    • resourceGroupName: string

      Resource group name.

    • provisioningServiceName: string

      Provisioning service name.

    • options: DpsCertificateVerifyCertificateOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<CertificateResponse>

      The callback

    Returns void

Generated using TypeDoc