Package com.azure.resourcemanager.deviceprovisioningservices.fluent

Interface DpsCertificatesClient

public interface DpsCertificatesClient
An instance of this class provides access to all the operations defined in DpsCertificatesClient.

  • Method Details

    • get

      CertificateResponseInner get(String certificateName, String resourceGroupName, String provisioningServiceName)
      Get the certificate from the provisioning service.
      Parameters:
      certificateName - Name of the certificate to retrieve.
      resourceGroupName - Resource group identifier.
      provisioningServiceName - Name of the provisioning service the certificate is associated with.
      Returns:
      the certificate from the provisioning service.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getWithResponse

      com.azure.core.http.rest.Response<CertificateResponseInner> getWithResponse(String certificateName, String resourceGroupName, String provisioningServiceName, String ifMatch, com.azure.core.util.Context context)
      Get the certificate from the provisioning service.
      Parameters:
      certificateName - Name of the certificate to retrieve.
      resourceGroupName - Resource group identifier.
      provisioningServiceName - Name of the provisioning service the certificate is associated with.
      ifMatch - ETag of the certificate.
      context - The context to associate with this operation.
      Returns:
      the certificate from the provisioning service along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createOrUpdate

      CertificateResponseInner createOrUpdate(String resourceGroupName, String provisioningServiceName, String certificateName, CertificateResponseInner certificateDescription)
      Add new certificate or update an existing certificate.
      Parameters:
      resourceGroupName - Resource group identifier.
      provisioningServiceName - The name of the provisioning service.
      certificateName - The name of the certificate create or update.
      certificateDescription - The certificate body.
      Returns:
      the X509 Certificate.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createOrUpdateWithResponse

      com.azure.core.http.rest.Response<CertificateResponseInner> createOrUpdateWithResponse(String resourceGroupName, String provisioningServiceName, String certificateName, CertificateResponseInner certificateDescription, String ifMatch, com.azure.core.util.Context context)
      Add new certificate or update an existing certificate.
      Parameters:
      resourceGroupName - Resource group identifier.
      provisioningServiceName - The name of the provisioning service.
      certificateName - The name of the certificate create or update.
      certificateDescription - The certificate body.
      ifMatch - ETag of the certificate. This is required to update an existing certificate, and ignored while creating a brand new certificate.
      context - The context to associate with this operation.
      Returns:
      the X509 Certificate along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • delete

      void delete(String resourceGroupName, String ifMatch, String provisioningServiceName, String certificateName)
      Deletes the specified certificate associated with the Provisioning Service.
      Parameters:
      resourceGroupName - Resource group identifier.
      ifMatch - ETag of the certificate.
      provisioningServiceName - The name of the provisioning service.
      certificateName - This is a mandatory field, and is the logical name of the certificate that the provisioning service will access by.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteWithResponse

      com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName, String ifMatch, String provisioningServiceName, String certificateName, String certificateName1, byte[] certificateRawBytes, Boolean certificateIsVerified, CertificatePurpose certificatePurpose, OffsetDateTime certificateCreated, OffsetDateTime certificateLastUpdated, Boolean certificateHasPrivateKey, String certificateNonce, com.azure.core.util.Context context)
      Deletes the specified certificate associated with the Provisioning Service.
      Parameters:
      resourceGroupName - Resource group identifier.
      ifMatch - ETag of the certificate.
      provisioningServiceName - The name of the provisioning service.
      certificateName - This is a mandatory field, and is the logical name of the certificate that the provisioning service will access by.
      certificateName1 - This is optional, and it is the Common Name of the certificate.
      certificateRawBytes - Raw data within the certificate.
      certificateIsVerified - Indicates if certificate has been verified by owner of the private key.
      certificatePurpose - A description that mentions the purpose of the certificate.
      certificateCreated - Time the certificate is created.
      certificateLastUpdated - Time the certificate is last updated.
      certificateHasPrivateKey - Indicates if the certificate contains a private key.
      certificateNonce - Random number generated to indicate Proof of Possession.
      context - The context to associate with this operation.
      Returns:
      the Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • list

      CertificateListDescriptionInner list(String resourceGroupName, String provisioningServiceName)
      Get all the certificates tied to the provisioning service.
      Parameters:
      resourceGroupName - Name of resource group.
      provisioningServiceName - Name of provisioning service to retrieve certificates for.
      Returns:
      all the certificates tied to the provisioning service.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listWithResponse

      com.azure.core.http.rest.Response<CertificateListDescriptionInner> listWithResponse(String resourceGroupName, String provisioningServiceName, com.azure.core.util.Context context)
      Get all the certificates tied to the provisioning service.
      Parameters:
      resourceGroupName - Name of resource group.
      provisioningServiceName - Name of provisioning service to retrieve certificates for.
      context - The context to associate with this operation.
      Returns:
      all the certificates tied to the provisioning service along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • generateVerificationCode

      VerificationCodeResponseInner generateVerificationCode(String certificateName, String ifMatch, String resourceGroupName, String provisioningServiceName)
      Generate verification code for Proof of Possession.
      Parameters:
      certificateName - The mandatory logical name of the certificate, that the provisioning service uses to access.
      ifMatch - ETag of the certificate. This is required to update an existing certificate, and ignored while creating a brand new certificate.
      resourceGroupName - name of resource group.
      provisioningServiceName - Name of provisioning service.
      Returns:
      description of the response of the verification code.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • generateVerificationCodeWithResponse

      com.azure.core.http.rest.Response<VerificationCodeResponseInner> generateVerificationCodeWithResponse(String certificateName, String ifMatch, String resourceGroupName, String provisioningServiceName, String certificateName1, byte[] certificateRawBytes, Boolean certificateIsVerified, CertificatePurpose certificatePurpose, OffsetDateTime certificateCreated, OffsetDateTime certificateLastUpdated, Boolean certificateHasPrivateKey, String certificateNonce, com.azure.core.util.Context context)
      Generate verification code for Proof of Possession.
      Parameters:
      certificateName - The mandatory logical name of the certificate, that the provisioning service uses to access.
      ifMatch - ETag of the certificate. This is required to update an existing certificate, and ignored while creating a brand new certificate.
      resourceGroupName - name of resource group.
      provisioningServiceName - Name of provisioning service.
      certificateName1 - Common Name for the certificate.
      certificateRawBytes - Raw data of certificate.
      certificateIsVerified - Indicates if the certificate has been verified by owner of the private key.
      certificatePurpose - Description mentioning the purpose of the certificate.
      certificateCreated - Certificate creation time.
      certificateLastUpdated - Certificate last updated time.
      certificateHasPrivateKey - Indicates if the certificate contains private key.
      certificateNonce - Random number generated to indicate Proof of Possession.
      context - The context to associate with this operation.
      Returns:
      description of the response of the verification code along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • verifyCertificate

      CertificateResponseInner verifyCertificate(String certificateName, String ifMatch, String resourceGroupName, String provisioningServiceName, VerificationCodeRequest request)
      Verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate.
      Parameters:
      certificateName - The mandatory logical name of the certificate, that the provisioning service uses to access.
      ifMatch - ETag of the certificate.
      resourceGroupName - Resource group name.
      provisioningServiceName - Provisioning service name.
      request - The name of the certificate.
      Returns:
      the X509 Certificate.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • verifyCertificateWithResponse

      com.azure.core.http.rest.Response<CertificateResponseInner> verifyCertificateWithResponse(String certificateName, String ifMatch, String resourceGroupName, String provisioningServiceName, VerificationCodeRequest request, String certificateName1, byte[] certificateRawBytes, Boolean certificateIsVerified, CertificatePurpose certificatePurpose, OffsetDateTime certificateCreated, OffsetDateTime certificateLastUpdated, Boolean certificateHasPrivateKey, String certificateNonce, com.azure.core.util.Context context)
      Verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate.
      Parameters:
      certificateName - The mandatory logical name of the certificate, that the provisioning service uses to access.
      ifMatch - ETag of the certificate.
      resourceGroupName - Resource group name.
      provisioningServiceName - Provisioning service name.
      request - The name of the certificate.
      certificateName1 - Common Name for the certificate.
      certificateRawBytes - Raw data of certificate.
      certificateIsVerified - Indicates if the certificate has been verified by owner of the private key.
      certificatePurpose - Describe the purpose of the certificate.
      certificateCreated - Certificate creation time.
      certificateLastUpdated - Certificate last updated time.
      certificateHasPrivateKey - Indicates if the certificate contains private key.
      certificateNonce - Random number generated to indicate Proof of Possession.
      context - The context to associate with this operation.
      Returns:
      the X509 Certificate along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.