Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Certificates

Package version

Class representing a Certificates.

Hierarchy

  • Certificates

Index

Constructors

Methods

Constructors

constructor

Methods

createOrUpdate

  • createOrUpdate(resourceGroupName: string, resourceName: string, certificateName: string, options?: Models.CertificatesCreateOrUpdateOptionalParams): Promise<Models.CertificatesCreateOrUpdateResponse>
  • createOrUpdate(resourceGroupName: string, resourceName: string, certificateName: string, callback: msRest.ServiceCallback<CertificateDescription>): void
  • createOrUpdate(resourceGroupName: string, resourceName: string, certificateName: string, options: CertificatesCreateOrUpdateOptionalParams, callback: msRest.ServiceCallback<CertificateDescription>): void

  • Adds new or replaces existing certificate.

    summary

    Upload the certificate to the IoT hub.

    Parameters

    • resourceGroupName: string

      The name of the resource group that contains the IoT hub.

    • resourceName: string

      The name of the IoT hub.

    • certificateName: string

      The name of the certificate

    • Optional options: Models.CertificatesCreateOrUpdateOptionalParams

    Returns Promise<Models.CertificatesCreateOrUpdateResponse>

    Promise<Models.CertificatesCreateOrUpdateResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group that contains the IoT hub.

    • resourceName: string

      The name of the IoT hub.

    • certificateName: string

      The name of the certificate

    • callback: msRest.ServiceCallback<CertificateDescription>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group that contains the IoT hub.

    • resourceName: string

      The name of the IoT hub.

    • certificateName: string

      The name of the certificate

    • options: CertificatesCreateOrUpdateOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<CertificateDescription>

      The callback

    Returns void

deleteMethod

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

  • Deletes an existing X509 certificate or does nothing if it does not exist.

    summary

    Delete an X509 certificate.

    Parameters

    • resourceGroupName: string

      The name of the resource group that contains the IoT hub.

    • resourceName: string

      The name of the IoT hub.

    • certificateName: string

      The name of the certificate

    • ifMatch: string

      ETag of the Certificate.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group that contains the IoT hub.

    • resourceName: string

      The name of the IoT hub.

    • certificateName: string

      The name of the certificate

    • ifMatch: string

      ETag of the Certificate.

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group that contains the IoT hub.

    • resourceName: string

      The name of the IoT hub.

    • certificateName: string

      The name of the certificate

    • ifMatch: string

      ETag of the Certificate.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

generateVerificationCode

  • generateVerificationCode(resourceGroupName: string, resourceName: string, certificateName: string, ifMatch: string, options?: msRest.RequestOptionsBase): Promise<Models.CertificatesGenerateVerificationCodeResponse>
  • generateVerificationCode(resourceGroupName: string, resourceName: string, certificateName: string, ifMatch: string, callback: msRest.ServiceCallback<CertificateWithNonceDescription>): void
  • generateVerificationCode(resourceGroupName: string, resourceName: string, certificateName: string, ifMatch: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<CertificateWithNonceDescription>): void

  • Generates verification code for proof of possession flow. The verification code will be used to generate a leaf certificate.

    summary

    Generate verification code for proof of possession flow.

    Parameters

    • resourceGroupName: string

      The name of the resource group that contains the IoT hub.

    • resourceName: string

      The name of the IoT hub.

    • certificateName: string

      The name of the certificate

    • ifMatch: string

      ETag of the Certificate.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.CertificatesGenerateVerificationCodeResponse>

    Promise<Models.CertificatesGenerateVerificationCodeResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group that contains the IoT hub.

    • resourceName: string

      The name of the IoT hub.

    • certificateName: string

      The name of the certificate

    • ifMatch: string

      ETag of the Certificate.

    • callback: msRest.ServiceCallback<CertificateWithNonceDescription>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group that contains the IoT hub.

    • resourceName: string

      The name of the IoT hub.

    • certificateName: string

      The name of the certificate

    • ifMatch: string

      ETag of the Certificate.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<CertificateWithNonceDescription>

      The callback

    Returns void

get

  • get(resourceGroupName: string, resourceName: string, certificateName: string, options?: msRest.RequestOptionsBase): Promise<Models.CertificatesGetResponse>
  • get(resourceGroupName: string, resourceName: string, certificateName: string, callback: msRest.ServiceCallback<CertificateDescription>): void
  • get(resourceGroupName: string, resourceName: string, certificateName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<CertificateDescription>): void

  • Returns the certificate.

    summary

    Get the certificate.

    Parameters

    • resourceGroupName: string

      The name of the resource group that contains the IoT hub.

    • resourceName: string

      The name of the IoT hub.

    • certificateName: string

      The name of the certificate

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.CertificatesGetResponse>

    Promise<Models.CertificatesGetResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group that contains the IoT hub.

    • resourceName: string

      The name of the IoT hub.

    • certificateName: string

      The name of the certificate

    • callback: msRest.ServiceCallback<CertificateDescription>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group that contains the IoT hub.

    • resourceName: string

      The name of the IoT hub.

    • certificateName: string

      The name of the certificate

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<CertificateDescription>

      The callback

    Returns void

listByIotHub

  • listByIotHub(resourceGroupName: string, resourceName: string, options?: msRest.RequestOptionsBase): Promise<Models.CertificatesListByIotHubResponse>
  • listByIotHub(resourceGroupName: string, resourceName: string, callback: msRest.ServiceCallback<CertificateListDescription>): void
  • listByIotHub(resourceGroupName: string, resourceName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<CertificateListDescription>): void

  • Returns the list of certificates.

    summary

    Get the certificate list.

    Parameters

    • resourceGroupName: string

      The name of the resource group that contains the IoT hub.

    • resourceName: string

      The name of the IoT hub.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.CertificatesListByIotHubResponse>

    Promise<Models.CertificatesListByIotHubResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group that contains the IoT hub.

    • resourceName: string

      The name of the IoT hub.

    • callback: msRest.ServiceCallback<CertificateListDescription>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group that contains the IoT hub.

    • resourceName: string

      The name of the IoT hub.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<CertificateListDescription>

      The callback

    Returns void

verify

  • verify(resourceGroupName: string, resourceName: string, certificateName: string, ifMatch: string, options?: Models.CertificatesVerifyOptionalParams): Promise<Models.CertificatesVerifyResponse>
  • verify(resourceGroupName: string, resourceName: string, certificateName: string, ifMatch: string, callback: msRest.ServiceCallback<CertificateDescription>): void
  • verify(resourceGroupName: string, resourceName: string, certificateName: string, ifMatch: string, options: CertificatesVerifyOptionalParams, callback: msRest.ServiceCallback<CertificateDescription>): 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

    • resourceGroupName: string

      The name of the resource group that contains the IoT hub.

    • resourceName: string

      The name of the IoT hub.

    • certificateName: string

      The name of the certificate

    • ifMatch: string

      ETag of the Certificate.

    • Optional options: Models.CertificatesVerifyOptionalParams

    Returns Promise<Models.CertificatesVerifyResponse>

    Promise<Models.CertificatesVerifyResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group that contains the IoT hub.

    • resourceName: string

      The name of the IoT hub.

    • certificateName: string

      The name of the certificate

    • ifMatch: string

      ETag of the Certificate.

    • callback: msRest.ServiceCallback<CertificateDescription>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group that contains the IoT hub.

    • resourceName: string

      The name of the IoT hub.

    • certificateName: string

      The name of the certificate

    • ifMatch: string

      ETag of the Certificate.

    • options: CertificatesVerifyOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<CertificateDescription>

      The callback

    Returns void

Generated using TypeDoc