DpsCertificatesClient Interface

Package:

com.azure.resourcemanager.deviceprovisioningservices.fluent

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-deviceprovisioningservices:1.2.0

public interface DpsCertificatesClient

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

Method Summary

Modifier and Type	Method and Description
abstract CertificateResponseInner	createOrUpdate(String resourceGroupName, String provisioningServiceName, String certificateName, CertificateResponseInner certificateDescription) Add new certificate or update an existing certificate.
abstract Response<CertificateResponseInner>	createOrUpdateWithResponse(String resourceGroupName, String provisioningServiceName, String certificateName, CertificateResponseInner certificateDescription, String ifMatch, Context context) Add new certificate or update an existing certificate.
abstract void	delete(String resourceGroupName, String ifMatch, String provisioningServiceName, String certificateName) Deletes the specified certificate associated with the Provisioning Service.
abstract Response<Void>	deleteWithResponse(String resourceGroupName, String ifMatch, String provisioningServiceName, String certificateName, String certificateNameParam, byte[] certificateRawBytes, Boolean certificateIsVerified, CertificatePurpose certificatePurpose, OffsetDateTime certificateCreated, OffsetDateTime certificateLastUpdated, Boolean certificateHasPrivateKey, String certificateNonce, Context context) Deletes the specified certificate associated with the Provisioning Service.
abstract VerificationCodeResponseInner	generateVerificationCode(String certificateName, String ifMatch, String resourceGroupName, String provisioningServiceName) Generate verification code for Proof of Possession.
abstract Response<VerificationCodeResponseInner>	generateVerificationCodeWithResponse(String certificateName, String ifMatch, String resourceGroupName, String provisioningServiceName, String certificateNameParam, byte[] certificateRawBytes, Boolean certificateIsVerified, CertificatePurpose certificatePurpose, OffsetDateTime certificateCreated, OffsetDateTime certificateLastUpdated, Boolean certificateHasPrivateKey, String certificateNonce, Context context) Generate verification code for Proof of Possession.
abstract CertificateResponseInner	get(String certificateName, String resourceGroupName, String provisioningServiceName) Get the certificate from the provisioning service.
abstract Response<CertificateResponseInner>	getWithResponse(String certificateName, String resourceGroupName, String provisioningServiceName, String ifMatch, Context context) Get the certificate from the provisioning service.
abstract PagedIterable<CertificateResponseInner>	list(String resourceGroupName, String provisioningServiceName) Get all the certificates tied to the provisioning service.
abstract PagedIterable<CertificateResponseInner>	list(String resourceGroupName, String provisioningServiceName, Context context) Get all the certificates tied to the provisioning service.
abstract 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.
abstract Response<CertificateResponseInner>	verifyCertificateWithResponse(String certificateName, String ifMatch, String resourceGroupName, String provisioningServiceName, VerificationCodeRequest request, String certificateNameParam, byte[] certificateRawBytes, Boolean certificateIsVerified, CertificatePurpose certificatePurpose, OffsetDateTime certificateCreated, OffsetDateTime certificateLastUpdated, Boolean certificateHasPrivateKey, String certificateNonce, Context context) Verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate.

Method Details

createOrUpdate

public abstract CertificateResponseInner createOrUpdate(String resourceGroupName, String provisioningServiceName, String certificateName, CertificateResponseInner certificateDescription)

Add new certificate or update an existing certificate.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

provisioningServiceName - Name of the provisioning service to retrieve.

certificateName - Name of the certificate to retrieve.

certificateDescription - The certificate body.

Returns:

the X509 Certificate.

createOrUpdateWithResponse

public abstract Response<CertificateResponseInner> createOrUpdateWithResponse(String resourceGroupName, String provisioningServiceName, String certificateName, CertificateResponseInner certificateDescription, String ifMatch, Context context)

Add new certificate or update an existing certificate.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

provisioningServiceName - Name of the provisioning service to retrieve.

certificateName - Name of the certificate to retrieve.

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

delete

public abstract void delete(String resourceGroupName, String ifMatch, String provisioningServiceName, String certificateName)

Deletes the specified certificate associated with the Provisioning Service.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

ifMatch - ETag of the certificate.

provisioningServiceName - Name of the provisioning service to retrieve.

certificateName - Name of the certificate to retrieve.

deleteWithResponse

public abstract Response<Void> deleteWithResponse(String resourceGroupName, String ifMatch, String provisioningServiceName, String certificateName, String certificateNameParam, byte[] certificateRawBytes, Boolean certificateIsVerified, CertificatePurpose certificatePurpose, OffsetDateTime certificateCreated, OffsetDateTime certificateLastUpdated, Boolean certificateHasPrivateKey, String certificateNonce, Context context)

Deletes the specified certificate associated with the Provisioning Service.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

ifMatch - ETag of the certificate.

provisioningServiceName - Name of the provisioning service to retrieve.

certificateName - Name of the certificate to retrieve.

certificateNameParam - 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 - Certificate last updated time.

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

generateVerificationCode

public abstract VerificationCodeResponseInner generateVerificationCode(String certificateName, String ifMatch, String resourceGroupName, String provisioningServiceName)

Generate verification code for Proof of Possession.

Parameters:

certificateName - Name of the certificate to retrieve.

ifMatch - ETag of the certificate. This is required to update an existing certificate, and ignored while creating a brand new certificate.

resourceGroupName - The name of the resource group. The name is case insensitive.

provisioningServiceName - Name of the provisioning service to retrieve.

Returns:

description of the response of the verification code.

generateVerificationCodeWithResponse

public abstract Response<VerificationCodeResponseInner> generateVerificationCodeWithResponse(String certificateName, String ifMatch, String resourceGroupName, String provisioningServiceName, String certificateNameParam, byte[] certificateRawBytes, Boolean certificateIsVerified, CertificatePurpose certificatePurpose, OffsetDateTime certificateCreated, OffsetDateTime certificateLastUpdated, Boolean certificateHasPrivateKey, String certificateNonce, Context context)

Generate verification code for Proof of Possession.

Parameters:

certificateName - Name of the certificate to retrieve.

ifMatch - ETag of the certificate. This is required to update an existing certificate, and ignored while creating a brand new certificate.

resourceGroupName - The name of the resource group. The name is case insensitive.

provisioningServiceName - Name of the provisioning service to retrieve.

certificateNameParam - 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 - Time the certificate is created.

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

get

public abstract CertificateResponseInner get(String certificateName, String resourceGroupName, String provisioningServiceName)

Get the certificate from the provisioning service.

Parameters:

certificateName - Name of the certificate to retrieve.

resourceGroupName - The name of the resource group. The name is case insensitive.

provisioningServiceName - Name of the provisioning service to retrieve.

Returns:

the certificate from the provisioning service.

getWithResponse

public abstract Response<CertificateResponseInner> getWithResponse(String certificateName, String resourceGroupName, String provisioningServiceName, String ifMatch, Context context)

Get the certificate from the provisioning service.

Parameters:

certificateName - Name of the certificate to retrieve.

resourceGroupName - The name of the resource group. The name is case insensitive.

provisioningServiceName - Name of the provisioning service to retrieve.

ifMatch - ETag of the certificate.

context - The context to associate with this operation.

Returns:

the certificate from the provisioning service along with Response<T>.

list

public abstract PagedIterable<CertificateResponseInner> list(String resourceGroupName, String provisioningServiceName)

Get all the certificates tied to the provisioning service.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

provisioningServiceName - Name of the provisioning service to retrieve.

Returns:

all the certificates tied to the provisioning service as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<CertificateResponseInner> list(String resourceGroupName, String provisioningServiceName, Context context)

Get all the certificates tied to the provisioning service.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

provisioningServiceName - Name of the provisioning service to retrieve.

context - The context to associate with this operation.

Returns:

all the certificates tied to the provisioning service as paginated response with PagedIterable<T>.

verifyCertificate

public abstract 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 - Name of the certificate to retrieve.

ifMatch - ETag of the certificate.

resourceGroupName - The name of the resource group. The name is case insensitive.

provisioningServiceName - Name of the provisioning service to retrieve.

request - The name of the certificate.

Returns:

the X509 Certificate.

verifyCertificateWithResponse

public abstract Response<CertificateResponseInner> verifyCertificateWithResponse(String certificateName, String ifMatch, String resourceGroupName, String provisioningServiceName, VerificationCodeRequest request, String certificateNameParam, byte[] certificateRawBytes, Boolean certificateIsVerified, CertificatePurpose certificatePurpose, OffsetDateTime certificateCreated, OffsetDateTime certificateLastUpdated, Boolean certificateHasPrivateKey, String certificateNonce, Context context)

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

Parameters:

certificateName - Name of the certificate to retrieve.

ifMatch - ETag of the certificate.

resourceGroupName - The name of the resource group. The name is case insensitive.

provisioningServiceName - Name of the provisioning service to retrieve.

request - The name of the certificate.

certificateNameParam - 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 - Time the certificate is created.

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