CertificatesClient Interface

Package:

com.azure.resourcemanager.iothub.fluent

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-iothub:1.3.0

public interface CertificatesClient

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

Method Summary

Modifier and Type	Method and Description
abstract CertificateDescriptionInner	createOrUpdate(String resourceGroupName, String resourceName, String certificateName, CertificateDescriptionInner certificateDescription) Upload the certificate to the IoT hub.
abstract Response<CertificateDescriptionInner>	createOrUpdateWithResponse(String resourceGroupName, String resourceName, String certificateName, CertificateDescriptionInner certificateDescription, String ifMatch, Context context) Upload the certificate to the IoT hub.
abstract void	delete(String resourceGroupName, String resourceName, String certificateName, String ifMatch) Delete an X509 certificate.
abstract Response<Void>	deleteWithResponse(String resourceGroupName, String resourceName, String certificateName, String ifMatch, Context context) Delete an X509 certificate.
abstract CertificateWithNonceDescriptionInner	generateVerificationCode(String resourceGroupName, String resourceName, String certificateName, String ifMatch) Generate verification code for proof of possession flow.
abstract Response<CertificateWithNonceDescriptionInner>	generateVerificationCodeWithResponse(String resourceGroupName, String resourceName, String certificateName, String ifMatch, Context context) Generate verification code for proof of possession flow.
abstract CertificateDescriptionInner	get(String resourceGroupName, String resourceName, String certificateName) Get the certificate.
abstract Response<CertificateDescriptionInner>	getWithResponse(String resourceGroupName, String resourceName, String certificateName, Context context) Get the certificate.
abstract CertificateListDescriptionInner	listByIotHub(String resourceGroupName, String resourceName) Get the certificate list.
abstract Response<CertificateListDescriptionInner>	listByIotHubWithResponse(String resourceGroupName, String resourceName, Context context) Get the certificate list.
abstract CertificateDescriptionInner	verify(String resourceGroupName, String resourceName, String certificateName, String ifMatch, CertificateVerificationDescription certificateVerificationBody) Verify certificate's private key possession.
abstract Response<CertificateDescriptionInner>	verifyWithResponse(String resourceGroupName, String resourceName, String certificateName, String ifMatch, CertificateVerificationDescription certificateVerificationBody, Context context) Verify certificate's private key possession.

Method Details

createOrUpdate

public abstract CertificateDescriptionInner createOrUpdate(String resourceGroupName, String resourceName, String certificateName, CertificateDescriptionInner certificateDescription)

Upload the certificate to the IoT hub. Adds new or replaces existing certificate.

Parameters:

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

resourceName - The name of the IoT hub.

certificateName - The name of the certificate.

certificateDescription - The certificate body.

Returns:

the X509 Certificate.

createOrUpdateWithResponse

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

Upload the certificate to the IoT hub. Adds new or replaces existing certificate.

Parameters:

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

resourceName - The name of the IoT hub.

certificateName - The name of the certificate.

certificateDescription - The certificate body.

ifMatch - ETag of the Certificate. Do not specify for creating a brand new certificate. Required to update an existing 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 resourceName, String certificateName, String ifMatch)

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

Parameters:

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

resourceName - The name of the IoT hub.

certificateName - The name of the certificate.

ifMatch - ETag of the Certificate.

deleteWithResponse

public abstract Response<Void> deleteWithResponse(String resourceGroupName, String resourceName, String certificateName, String ifMatch, Context context)

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

Parameters:

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

resourceName - The name of the IoT hub.

certificateName - The name of the certificate.

ifMatch - ETag of the Certificate.

context - The context to associate with this operation.

Returns:

the Response<T>.

generateVerificationCode

public abstract CertificateWithNonceDescriptionInner generateVerificationCode(String resourceGroupName, String resourceName, String certificateName, String ifMatch)

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

Parameters:

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

resourceName - The name of the IoT hub.

certificateName - The name of the certificate.

ifMatch - ETag of the Certificate.

Returns:

the X509 Certificate.

generateVerificationCodeWithResponse

public abstract Response<CertificateWithNonceDescriptionInner> generateVerificationCodeWithResponse(String resourceGroupName, String resourceName, String certificateName, String ifMatch, Context context)

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

Parameters:

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

resourceName - The name of the IoT hub.

certificateName - The name of the certificate.

ifMatch - ETag of the Certificate.

context - The context to associate with this operation.

Returns:

the X509 Certificate along with Response<T>.

get

public abstract CertificateDescriptionInner get(String resourceGroupName, String resourceName, String certificateName)

Get the certificate. Returns the certificate.

Parameters:

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

resourceName - The name of the IoT hub.

certificateName - The name of the certificate.

Returns:

the X509 Certificate.

getWithResponse

public abstract Response<CertificateDescriptionInner> getWithResponse(String resourceGroupName, String resourceName, String certificateName, Context context)

Get the certificate. Returns the certificate.

Parameters:

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

resourceName - The name of the IoT hub.

certificateName - The name of the certificate.

context - The context to associate with this operation.

Returns:

the X509 Certificate along with Response<T>.

listByIotHub

public abstract CertificateListDescriptionInner listByIotHub(String resourceGroupName, String resourceName)

Get the certificate list. Returns the list of certificates.

Parameters:

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

resourceName - The name of the IoT hub.

Returns:

the JSON-serialized array of Certificate objects.

listByIotHubWithResponse

public abstract Response<CertificateListDescriptionInner> listByIotHubWithResponse(String resourceGroupName, String resourceName, Context context)

Get the certificate list. Returns the list of certificates.

Parameters:

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

resourceName - The name of the IoT hub.

context - The context to associate with this operation.

Returns:

the JSON-serialized array of Certificate objects along with Response<T>.

verify

public abstract CertificateDescriptionInner verify(String resourceGroupName, String resourceName, String certificateName, String ifMatch, CertificateVerificationDescription certificateVerificationBody)

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

Parameters:

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

resourceName - The name of the IoT hub.

certificateName - The name of the certificate.

ifMatch - ETag of the Certificate.

certificateVerificationBody - The name of the certificate.

Returns:

the X509 Certificate.

verifyWithResponse

public abstract Response<CertificateDescriptionInner> verifyWithResponse(String resourceGroupName, String resourceName, String certificateName, String ifMatch, CertificateVerificationDescription certificateVerificationBody, Context context)

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

Parameters:

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

resourceName - The name of the IoT hub.

certificateName - The name of the certificate.

ifMatch - ETag of the Certificate.

certificateVerificationBody - The name of the certificate.

context - The context to associate with this operation.

Returns:

the X509 Certificate along with Response<T>.