Package com.azure.resourcemanager.iothub.fluent

Interface CertificatesClient

public interface CertificatesClient

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

Method Summary

Modifier and Type	Method	Description
CertificateDescriptionInner	createOrUpdate(String resourceGroupName, String resourceName, String certificateName, CertificateDescriptionInner certificateDescription)	Adds new or replaces existing certificate.
com.azure.core.http.rest.Response<CertificateDescriptionInner>	createOrUpdateWithResponse(String resourceGroupName, String resourceName, String certificateName, CertificateDescriptionInner certificateDescription, String ifMatch, com.azure.core.util.Context context)	Adds new or replaces existing certificate.
void	delete(String resourceGroupName, String resourceName, String certificateName, String ifMatch)	Deletes an existing X509 certificate or does nothing if it does not exist.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String resourceName, String certificateName, String ifMatch, com.azure.core.util.Context context)	Deletes an existing X509 certificate or does nothing if it does not exist.
CertificateWithNonceDescriptionInner	generateVerificationCode(String resourceGroupName, String resourceName, String certificateName, String ifMatch)	Generates verification code for proof of possession flow.
com.azure.core.http.rest.Response<CertificateWithNonceDescriptionInner>	generateVerificationCodeWithResponse(String resourceGroupName, String resourceName, String certificateName, String ifMatch, com.azure.core.util.Context context)	Generates verification code for proof of possession flow.
CertificateDescriptionInner	get(String resourceGroupName, String resourceName, String certificateName)	Returns the certificate.
com.azure.core.http.rest.Response<CertificateDescriptionInner>	getWithResponse(String resourceGroupName, String resourceName, String certificateName, com.azure.core.util.Context context)	Returns the certificate.
CertificateListDescriptionInner	listByIotHub(String resourceGroupName, String resourceName)	Returns the list of certificates.
com.azure.core.http.rest.Response<CertificateListDescriptionInner>	listByIotHubWithResponse(String resourceGroupName, String resourceName, com.azure.core.util.Context context)	Returns the list of certificates.
CertificateDescriptionInner	verify(String resourceGroupName, String resourceName, String certificateName, String ifMatch, CertificateVerificationDescription certificateVerificationBody)	Verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate.
com.azure.core.http.rest.Response<CertificateDescriptionInner>	verifyWithResponse(String resourceGroupName, String resourceName, String certificateName, String ifMatch, CertificateVerificationDescription certificateVerificationBody, 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.

Method Detail

listByIotHub

CertificateListDescriptionInner listByIotHub(String resourceGroupName,
                                             String resourceName)

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.

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.

listByIotHubWithResponse

com.azure.core.http.rest.Response<CertificateListDescriptionInner> listByIotHubWithResponse(String resourceGroupName,
                                                                                            String resourceName,
                                                                                            com.azure.core.util.Context context)

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.

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.

get

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

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.

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<CertificateDescriptionInner> getWithResponse(String resourceGroupName,
                                                                               String resourceName,
                                                                               String certificateName,
                                                                               com.azure.core.util.Context context)

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.

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

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

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.

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<CertificateDescriptionInner> createOrUpdateWithResponse(String resourceGroupName,
                                                                                          String resourceName,
                                                                                          String certificateName,
                                                                                          CertificateDescriptionInner certificateDescription,
                                                                                          String ifMatch,
                                                                                          com.azure.core.util.Context context)

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.

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 resourceName,
            String certificateName,
            String ifMatch)

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.

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 resourceName,
                                                           String certificateName,
                                                           String ifMatch,
                                                           com.azure.core.util.Context context)

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.

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

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

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.

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<CertificateWithNonceDescriptionInner> generateVerificationCodeWithResponse(String resourceGroupName,
                                                                                                             String resourceName,
                                                                                                             String certificateName,
                                                                                                             String ifMatch,
                                                                                                             com.azure.core.util.Context context)

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.

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.

verify

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

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.

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.

verifyWithResponse

com.azure.core.http.rest.Response<CertificateDescriptionInner> verifyWithResponse(String resourceGroupName,
                                                                                  String resourceName,
                                                                                  String certificateName,
                                                                                  String ifMatch,
                                                                                  CertificateVerificationDescription certificateVerificationBody,
                                                                                  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:

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.

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.