Certificates Interface

  • Reference
Package:
com.microsoft.azure.batch.protocol

public interface Certificates

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

Method Summary

Modifier and Type Method and Description
void add(CertificateAddParameter certificate)

Adds a certificate to the specified account.
void add(CertificateAddParameter certificate, CertificateAddOptions certificateAddOptions)

Adds a certificate to the specified account.
Observable<Void> addAsync(CertificateAddParameter certificate)

Adds a certificate to the specified account.
Observable<Void> addAsync(CertificateAddParameter certificate, CertificateAddOptions certificateAddOptions)

Adds a certificate to the specified account.
ServiceFuture<Void> addAsync(CertificateAddParameter certificate, CertificateAddOptions certificateAddOptions, final ServiceCallback<Void> serviceCallback)

Adds a certificate to the specified account.
ServiceFuture<Void> addAsync(CertificateAddParameter certificate, final ServiceCallback<Void> serviceCallback)

Adds a certificate to the specified account.
Observable<ServiceResponseWithHeaders<Void, CertificateAddHeaders>> addWithServiceResponseAsync(CertificateAddParameter certificate)

Adds a certificate to the specified account.
Observable<ServiceResponseWithHeaders<Void, CertificateAddHeaders>> addWithServiceResponseAsync(CertificateAddParameter certificate, CertificateAddOptions certificateAddOptions)

Adds a certificate to the specified account.
void cancelDeletion(String thumbprintAlgorithm, String thumbprint)

Cancels a failed deletion of a certificate from the specified account. If you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate.
void cancelDeletion(String thumbprintAlgorithm, String thumbprint, CertificateCancelDeletionOptions certificateCancelDeletionOptions)

Cancels a failed deletion of a certificate from the specified account. If you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate.
Observable<Void> cancelDeletionAsync(String thumbprintAlgorithm, String thumbprint)

Cancels a failed deletion of a certificate from the specified account. If you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate.
Observable<Void> cancelDeletionAsync(String thumbprintAlgorithm, String thumbprint, CertificateCancelDeletionOptions certificateCancelDeletionOptions)

Cancels a failed deletion of a certificate from the specified account. If you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate.
ServiceFuture<Void> cancelDeletionAsync(String thumbprintAlgorithm, String thumbprint, CertificateCancelDeletionOptions certificateCancelDeletionOptions, final ServiceCallback<Void> serviceCallback)

Cancels a failed deletion of a certificate from the specified account. If you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate.
ServiceFuture<Void> cancelDeletionAsync(String thumbprintAlgorithm, String thumbprint, final ServiceCallback<Void> serviceCallback)

Cancels a failed deletion of a certificate from the specified account. If you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate.
Observable<ServiceResponseWithHeaders<Void, CertificateCancelDeletionHeaders>> cancelDeletionWithServiceResponseAsync(String thumbprintAlgorithm, String thumbprint)

Cancels a failed deletion of a certificate from the specified account. If you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate.
Observable<ServiceResponseWithHeaders<Void, CertificateCancelDeletionHeaders>> cancelDeletionWithServiceResponseAsync(String thumbprintAlgorithm, String thumbprint, CertificateCancelDeletionOptions certificateCancelDeletionOptions)

Cancels a failed deletion of a certificate from the specified account. If you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate.
void delete(String thumbprintAlgorithm, String thumbprint)

Deletes a certificate from the specified account. You cannot delete a certificate if a resource (pool or compute node) is using it. Before you can delete a certificate, you must therefore make sure that the certificate is not associated with any existing pools, the certificate is not installed on any compute nodes (even if you remove a certificate from a pool, it is not removed from existing compute nodes in that pool until they restart), and no running tasks depend on the certificate. If you try to delete a certificate that is in use, the deletion fails. The certificate status changes to deleteFailed. You can use Cancel Delete Certificate to set the status back to active if you decide that you want to continue using the certificate.
void delete(String thumbprintAlgorithm, String thumbprint, CertificateDeleteOptions certificateDeleteOptions)

Deletes a certificate from the specified account. You cannot delete a certificate if a resource (pool or compute node) is using it. Before you can delete a certificate, you must therefore make sure that the certificate is not associated with any existing pools, the certificate is not installed on any compute nodes (even if you remove a certificate from a pool, it is not removed from existing compute nodes in that pool until they restart), and no running tasks depend on the certificate. If you try to delete a certificate that is in use, the deletion fails. The certificate status changes to deleteFailed. You can use Cancel Delete Certificate to set the status back to active if you decide that you want to continue using the certificate.
Observable<Void> deleteAsync(String thumbprintAlgorithm, String thumbprint)

Deletes a certificate from the specified account. You cannot delete a certificate if a resource (pool or compute node) is using it. Before you can delete a certificate, you must therefore make sure that the certificate is not associated with any existing pools, the certificate is not installed on any compute nodes (even if you remove a certificate from a pool, it is not removed from existing compute nodes in that pool until they restart), and no running tasks depend on the certificate. If you try to delete a certificate that is in use, the deletion fails. The certificate status changes to deleteFailed. You can use Cancel Delete Certificate to set the status back to active if you decide that you want to continue using the certificate.
Observable<Void> deleteAsync(String thumbprintAlgorithm, String thumbprint, CertificateDeleteOptions certificateDeleteOptions)

Deletes a certificate from the specified account. You cannot delete a certificate if a resource (pool or compute node) is using it. Before you can delete a certificate, you must therefore make sure that the certificate is not associated with any existing pools, the certificate is not installed on any compute nodes (even if you remove a certificate from a pool, it is not removed from existing compute nodes in that pool until they restart), and no running tasks depend on the certificate. If you try to delete a certificate that is in use, the deletion fails. The certificate status changes to deleteFailed. You can use Cancel Delete Certificate to set the status back to active if you decide that you want to continue using the certificate.
ServiceFuture<Void> deleteAsync(String thumbprintAlgorithm, String thumbprint, CertificateDeleteOptions certificateDeleteOptions, final ServiceCallback<Void> serviceCallback)

Deletes a certificate from the specified account. You cannot delete a certificate if a resource (pool or compute node) is using it. Before you can delete a certificate, you must therefore make sure that the certificate is not associated with any existing pools, the certificate is not installed on any compute nodes (even if you remove a certificate from a pool, it is not removed from existing compute nodes in that pool until they restart), and no running tasks depend on the certificate. If you try to delete a certificate that is in use, the deletion fails. The certificate status changes to deleteFailed. You can use Cancel Delete Certificate to set the status back to active if you decide that you want to continue using the certificate.
ServiceFuture<Void> deleteAsync(String thumbprintAlgorithm, String thumbprint, final ServiceCallback<Void> serviceCallback)

Deletes a certificate from the specified account. You cannot delete a certificate if a resource (pool or compute node) is using it. Before you can delete a certificate, you must therefore make sure that the certificate is not associated with any existing pools, the certificate is not installed on any compute nodes (even if you remove a certificate from a pool, it is not removed from existing compute nodes in that pool until they restart), and no running tasks depend on the certificate. If you try to delete a certificate that is in use, the deletion fails. The certificate status changes to deleteFailed. You can use Cancel Delete Certificate to set the status back to active if you decide that you want to continue using the certificate.
Observable<ServiceResponseWithHeaders<Void, CertificateDeleteHeaders>> deleteWithServiceResponseAsync(String thumbprintAlgorithm, String thumbprint)

Deletes a certificate from the specified account. You cannot delete a certificate if a resource (pool or compute node) is using it. Before you can delete a certificate, you must therefore make sure that the certificate is not associated with any existing pools, the certificate is not installed on any compute nodes (even if you remove a certificate from a pool, it is not removed from existing compute nodes in that pool until they restart), and no running tasks depend on the certificate. If you try to delete a certificate that is in use, the deletion fails. The certificate status changes to deleteFailed. You can use Cancel Delete Certificate to set the status back to active if you decide that you want to continue using the certificate.
Observable<ServiceResponseWithHeaders<Void, CertificateDeleteHeaders>> deleteWithServiceResponseAsync(String thumbprintAlgorithm, String thumbprint, CertificateDeleteOptions certificateDeleteOptions)

Deletes a certificate from the specified account. You cannot delete a certificate if a resource (pool or compute node) is using it. Before you can delete a certificate, you must therefore make sure that the certificate is not associated with any existing pools, the certificate is not installed on any compute nodes (even if you remove a certificate from a pool, it is not removed from existing compute nodes in that pool until they restart), and no running tasks depend on the certificate. If you try to delete a certificate that is in use, the deletion fails. The certificate status changes to deleteFailed. You can use Cancel Delete Certificate to set the status back to active if you decide that you want to continue using the certificate.
Certificate get(String thumbprintAlgorithm, String thumbprint)

Gets information about the specified certificate.
Certificate get(String thumbprintAlgorithm, String thumbprint, CertificateGetOptions certificateGetOptions)

Gets information about the specified certificate.
Observable<Certificate> getAsync(String thumbprintAlgorithm, String thumbprint)

Gets information about the specified certificate.
Observable<Certificate> getAsync(String thumbprintAlgorithm, String thumbprint, CertificateGetOptions certificateGetOptions)

Gets information about the specified certificate.
ServiceFuture<Certificate> getAsync(String thumbprintAlgorithm, String thumbprint, CertificateGetOptions certificateGetOptions, final ServiceCallback<Certificate> serviceCallback)

Gets information about the specified certificate.
ServiceFuture<Certificate> getAsync(String thumbprintAlgorithm, String thumbprint, final ServiceCallback<Certificate> serviceCallback)

Gets information about the specified certificate.
Observable<ServiceResponseWithHeaders<Certificate, CertificateGetHeaders>> getWithServiceResponseAsync(String thumbprintAlgorithm, String thumbprint)

Gets information about the specified certificate.
Observable<ServiceResponseWithHeaders<Certificate, CertificateGetHeaders>> getWithServiceResponseAsync(String thumbprintAlgorithm, String thumbprint, CertificateGetOptions certificateGetOptions)

Gets information about the specified certificate.
PagedList<Certificate> list()

Lists all of the certificates that have been added to the specified account.
PagedList<Certificate> list(final CertificateListOptions certificateListOptions)

Lists all of the certificates that have been added to the specified account.
Observable<Page<Certificate>> listAsync()

Lists all of the certificates that have been added to the specified account.
Observable<Page<Certificate>> listAsync(final CertificateListOptions certificateListOptions)

Lists all of the certificates that have been added to the specified account.
ServiceFuture<List<Certificate>> listAsync(final CertificateListOptions certificateListOptions, final ListOperationCallback<Certificate> serviceCallback)

Lists all of the certificates that have been added to the specified account.
ServiceFuture<List<Certificate>> listAsync(final ListOperationCallback<Certificate> serviceCallback)

Lists all of the certificates that have been added to the specified account.
PagedList<Certificate> listNext(final String nextPageLink)

Lists all of the certificates that have been added to the specified account.
PagedList<Certificate> listNext(final String nextPageLink, final CertificateListNextOptions certificateListNextOptions)

Lists all of the certificates that have been added to the specified account.
Observable<Page<Certificate>> listNextAsync(final String nextPageLink)

Lists all of the certificates that have been added to the specified account.
Observable<Page<Certificate>> listNextAsync(final String nextPageLink, final CertificateListNextOptions certificateListNextOptions)

Lists all of the certificates that have been added to the specified account.
ServiceFuture<List<Certificate>> listNextAsync(final String nextPageLink, final CertificateListNextOptions certificateListNextOptions, final ServiceFuture<List<Certificate>> serviceFuture, final ListOperationCallback<Certificate> serviceCallback)

Lists all of the certificates that have been added to the specified account.
ServiceFuture<List<Certificate>> listNextAsync(final String nextPageLink, final ServiceFuture<List<Certificate>> serviceFuture, final ListOperationCallback<Certificate> serviceCallback)

Lists all of the certificates that have been added to the specified account.
Observable<ServiceResponseWithHeaders<Page<Certificate>, CertificateListHeaders>> listNextWithServiceResponseAsync(final String nextPageLink)

Lists all of the certificates that have been added to the specified account.
Observable<ServiceResponseWithHeaders<Page<Certificate>, CertificateListHeaders>> listNextWithServiceResponseAsync(final String nextPageLink, final CertificateListNextOptions certificateListNextOptions)

Lists all of the certificates that have been added to the specified account.
Observable<ServiceResponseWithHeaders<Page<Certificate>, CertificateListHeaders>> listWithServiceResponseAsync()

Lists all of the certificates that have been added to the specified account.
Observable<ServiceResponseWithHeaders<Page<Certificate>, CertificateListHeaders>> listWithServiceResponseAsync(final CertificateListOptions certificateListOptions)

Lists all of the certificates that have been added to the specified account.

Method Details

add

public void add(CertificateAddParameter certificate)

Adds a certificate to the specified account.

Parameters:

certificate - The certificate to be added.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
BatchErrorException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

add

public void add(CertificateAddParameter certificate, CertificateAddOptions certificateAddOptions)

Adds a certificate to the specified account.

Parameters:

certificate - The certificate to be added.
certificateAddOptions - Additional parameters for the operation

Throws:

IllegalArgumentException - thrown if parameters fail the validation
BatchErrorException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

addAsync

public Observable addAsync(CertificateAddParameter certificate)

Adds a certificate to the specified account.

Parameters:

certificate - The certificate to be added.

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

addAsync

public Observable addAsync(CertificateAddParameter certificate, CertificateAddOptions certificateAddOptions)

Adds a certificate to the specified account.

Parameters:

certificate - The certificate to be added.
certificateAddOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

addAsync

public ServiceFuture addAsync(CertificateAddParameter certificate, CertificateAddOptions certificateAddOptions, final ServiceCallback serviceCallback)

Adds a certificate to the specified account.

Parameters:

certificate - The certificate to be added.
certificateAddOptions - Additional parameters for the operation
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

addAsync

public ServiceFuture addAsync(CertificateAddParameter certificate, final ServiceCallback serviceCallback)

Adds a certificate to the specified account.

Parameters:

certificate - The certificate to be added.
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

addWithServiceResponseAsync

public Observable<>> addWithServiceResponseAsync(CertificateAddParameter certificate)

Adds a certificate to the specified account.

Parameters:

certificate - The certificate to be added.

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

addWithServiceResponseAsync

public Observable<>> addWithServiceResponseAsync(CertificateAddParameter certificate, CertificateAddOptions certificateAddOptions)

Adds a certificate to the specified account.

Parameters:

certificate - The certificate to be added.
certificateAddOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

cancelDeletion

public void cancelDeletion(String thumbprintAlgorithm, String thumbprint)

Cancels a failed deletion of a certificate from the specified account. If you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate.

Parameters:

thumbprintAlgorithm - The algorithm used to derive the thumbprint parameter. This must be sha1.
thumbprint - The thumbprint of the certificate being deleted.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
BatchErrorException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

cancelDeletion

public void cancelDeletion(String thumbprintAlgorithm, String thumbprint, CertificateCancelDeletionOptions certificateCancelDeletionOptions)

Cancels a failed deletion of a certificate from the specified account. If you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate.

Parameters:

thumbprintAlgorithm - The algorithm used to derive the thumbprint parameter. This must be sha1.
thumbprint - The thumbprint of the certificate being deleted.
certificateCancelDeletionOptions - Additional parameters for the operation

Throws:

IllegalArgumentException - thrown if parameters fail the validation
BatchErrorException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

cancelDeletionAsync

public Observable cancelDeletionAsync(String thumbprintAlgorithm, String thumbprint)

Cancels a failed deletion of a certificate from the specified account. If you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate.

Parameters:

thumbprintAlgorithm - The algorithm used to derive the thumbprint parameter. This must be sha1.
thumbprint - The thumbprint of the certificate being deleted.

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

cancelDeletionAsync

public Observable cancelDeletionAsync(String thumbprintAlgorithm, String thumbprint, CertificateCancelDeletionOptions certificateCancelDeletionOptions)

Cancels a failed deletion of a certificate from the specified account. If you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate.

Parameters:

thumbprintAlgorithm - The algorithm used to derive the thumbprint parameter. This must be sha1.
thumbprint - The thumbprint of the certificate being deleted.
certificateCancelDeletionOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

cancelDeletionAsync

public ServiceFuture cancelDeletionAsync(String thumbprintAlgorithm, String thumbprint, CertificateCancelDeletionOptions certificateCancelDeletionOptions, final ServiceCallback serviceCallback)

Cancels a failed deletion of a certificate from the specified account. If you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate.

Parameters:

thumbprintAlgorithm - The algorithm used to derive the thumbprint parameter. This must be sha1.
thumbprint - The thumbprint of the certificate being deleted.
certificateCancelDeletionOptions - Additional parameters for the operation
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

cancelDeletionAsync

public ServiceFuture cancelDeletionAsync(String thumbprintAlgorithm, String thumbprint, final ServiceCallback serviceCallback)

Cancels a failed deletion of a certificate from the specified account. If you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate.

Parameters:

thumbprintAlgorithm - The algorithm used to derive the thumbprint parameter. This must be sha1.
thumbprint - The thumbprint of the certificate being deleted.
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

cancelDeletionWithServiceResponseAsync

public Observable<>> cancelDeletionWithServiceResponseAsync(String thumbprintAlgorithm, String thumbprint)

Cancels a failed deletion of a certificate from the specified account. If you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate.

Parameters:

thumbprintAlgorithm - The algorithm used to derive the thumbprint parameter. This must be sha1.
thumbprint - The thumbprint of the certificate being deleted.

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

cancelDeletionWithServiceResponseAsync

public Observable<>> cancelDeletionWithServiceResponseAsync(String thumbprintAlgorithm, String thumbprint, CertificateCancelDeletionOptions certificateCancelDeletionOptions)

Cancels a failed deletion of a certificate from the specified account. If you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate.

Parameters:

thumbprintAlgorithm - The algorithm used to derive the thumbprint parameter. This must be sha1.
thumbprint - The thumbprint of the certificate being deleted.
certificateCancelDeletionOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

delete

public void delete(String thumbprintAlgorithm, String thumbprint)

Deletes a certificate from the specified account. You cannot delete a certificate if a resource (pool or compute node) is using it. Before you can delete a certificate, you must therefore make sure that the certificate is not associated with any existing pools, the certificate is not installed on any compute nodes (even if you remove a certificate from a pool, it is not removed from existing compute nodes in that pool until they restart), and no running tasks depend on the certificate. If you try to delete a certificate that is in use, the deletion fails. The certificate status changes to deleteFailed. You can use Cancel Delete Certificate to set the status back to active if you decide that you want to continue using the certificate.

Parameters:

thumbprintAlgorithm - The algorithm used to derive the thumbprint parameter. This must be sha1.
thumbprint - The thumbprint of the certificate to be deleted.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
BatchErrorException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

delete

public void delete(String thumbprintAlgorithm, String thumbprint, CertificateDeleteOptions certificateDeleteOptions)

Deletes a certificate from the specified account. You cannot delete a certificate if a resource (pool or compute node) is using it. Before you can delete a certificate, you must therefore make sure that the certificate is not associated with any existing pools, the certificate is not installed on any compute nodes (even if you remove a certificate from a pool, it is not removed from existing compute nodes in that pool until they restart), and no running tasks depend on the certificate. If you try to delete a certificate that is in use, the deletion fails. The certificate status changes to deleteFailed. You can use Cancel Delete Certificate to set the status back to active if you decide that you want to continue using the certificate.

Parameters:

thumbprintAlgorithm - The algorithm used to derive the thumbprint parameter. This must be sha1.
thumbprint - The thumbprint of the certificate to be deleted.
certificateDeleteOptions - Additional parameters for the operation

Throws:

IllegalArgumentException - thrown if parameters fail the validation
BatchErrorException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

deleteAsync

public Observable deleteAsync(String thumbprintAlgorithm, String thumbprint)

Deletes a certificate from the specified account. You cannot delete a certificate if a resource (pool or compute node) is using it. Before you can delete a certificate, you must therefore make sure that the certificate is not associated with any existing pools, the certificate is not installed on any compute nodes (even if you remove a certificate from a pool, it is not removed from existing compute nodes in that pool until they restart), and no running tasks depend on the certificate. If you try to delete a certificate that is in use, the deletion fails. The certificate status changes to deleteFailed. You can use Cancel Delete Certificate to set the status back to active if you decide that you want to continue using the certificate.

Parameters:

thumbprintAlgorithm - The algorithm used to derive the thumbprint parameter. This must be sha1.
thumbprint - The thumbprint of the certificate to be deleted.

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteAsync

public Observable deleteAsync(String thumbprintAlgorithm, String thumbprint, CertificateDeleteOptions certificateDeleteOptions)

Deletes a certificate from the specified account. You cannot delete a certificate if a resource (pool or compute node) is using it. Before you can delete a certificate, you must therefore make sure that the certificate is not associated with any existing pools, the certificate is not installed on any compute nodes (even if you remove a certificate from a pool, it is not removed from existing compute nodes in that pool until they restart), and no running tasks depend on the certificate. If you try to delete a certificate that is in use, the deletion fails. The certificate status changes to deleteFailed. You can use Cancel Delete Certificate to set the status back to active if you decide that you want to continue using the certificate.

Parameters:

thumbprintAlgorithm - The algorithm used to derive the thumbprint parameter. This must be sha1.
thumbprint - The thumbprint of the certificate to be deleted.
certificateDeleteOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteAsync

public ServiceFuture deleteAsync(String thumbprintAlgorithm, String thumbprint, CertificateDeleteOptions certificateDeleteOptions, final ServiceCallback serviceCallback)

Deletes a certificate from the specified account. You cannot delete a certificate if a resource (pool or compute node) is using it. Before you can delete a certificate, you must therefore make sure that the certificate is not associated with any existing pools, the certificate is not installed on any compute nodes (even if you remove a certificate from a pool, it is not removed from existing compute nodes in that pool until they restart), and no running tasks depend on the certificate. If you try to delete a certificate that is in use, the deletion fails. The certificate status changes to deleteFailed. You can use Cancel Delete Certificate to set the status back to active if you decide that you want to continue using the certificate.

Parameters:

thumbprintAlgorithm - The algorithm used to derive the thumbprint parameter. This must be sha1.
thumbprint - The thumbprint of the certificate to be deleted.
certificateDeleteOptions - Additional parameters for the operation
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteAsync

public ServiceFuture deleteAsync(String thumbprintAlgorithm, String thumbprint, final ServiceCallback serviceCallback)

Deletes a certificate from the specified account. You cannot delete a certificate if a resource (pool or compute node) is using it. Before you can delete a certificate, you must therefore make sure that the certificate is not associated with any existing pools, the certificate is not installed on any compute nodes (even if you remove a certificate from a pool, it is not removed from existing compute nodes in that pool until they restart), and no running tasks depend on the certificate. If you try to delete a certificate that is in use, the deletion fails. The certificate status changes to deleteFailed. You can use Cancel Delete Certificate to set the status back to active if you decide that you want to continue using the certificate.

Parameters:

thumbprintAlgorithm - The algorithm used to derive the thumbprint parameter. This must be sha1.
thumbprint - The thumbprint of the certificate to be deleted.
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteWithServiceResponseAsync

public Observable<>> deleteWithServiceResponseAsync(String thumbprintAlgorithm, String thumbprint)

Deletes a certificate from the specified account. You cannot delete a certificate if a resource (pool or compute node) is using it. Before you can delete a certificate, you must therefore make sure that the certificate is not associated with any existing pools, the certificate is not installed on any compute nodes (even if you remove a certificate from a pool, it is not removed from existing compute nodes in that pool until they restart), and no running tasks depend on the certificate. If you try to delete a certificate that is in use, the deletion fails. The certificate status changes to deleteFailed. You can use Cancel Delete Certificate to set the status back to active if you decide that you want to continue using the certificate.

Parameters:

thumbprintAlgorithm - The algorithm used to derive the thumbprint parameter. This must be sha1.
thumbprint - The thumbprint of the certificate to be deleted.

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteWithServiceResponseAsync

public Observable<>> deleteWithServiceResponseAsync(String thumbprintAlgorithm, String thumbprint, CertificateDeleteOptions certificateDeleteOptions)

Deletes a certificate from the specified account. You cannot delete a certificate if a resource (pool or compute node) is using it. Before you can delete a certificate, you must therefore make sure that the certificate is not associated with any existing pools, the certificate is not installed on any compute nodes (even if you remove a certificate from a pool, it is not removed from existing compute nodes in that pool until they restart), and no running tasks depend on the certificate. If you try to delete a certificate that is in use, the deletion fails. The certificate status changes to deleteFailed. You can use Cancel Delete Certificate to set the status back to active if you decide that you want to continue using the certificate.

Parameters:

thumbprintAlgorithm - The algorithm used to derive the thumbprint parameter. This must be sha1.
thumbprint - The thumbprint of the certificate to be deleted.
certificateDeleteOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

get

public Certificate get(String thumbprintAlgorithm, String thumbprint)

Gets information about the specified certificate.

Parameters:

thumbprintAlgorithm - The algorithm used to derive the thumbprint parameter. This must be sha1.
thumbprint - The thumbprint of the certificate to get.

Returns:

the Certificate object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
BatchErrorException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

get

public Certificate get(String thumbprintAlgorithm, String thumbprint, CertificateGetOptions certificateGetOptions)

Gets information about the specified certificate.

Parameters:

thumbprintAlgorithm - The algorithm used to derive the thumbprint parameter. This must be sha1.
thumbprint - The thumbprint of the certificate to get.
certificateGetOptions - Additional parameters for the operation

Returns:

the Certificate object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
BatchErrorException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getAsync

public Observable getAsync(String thumbprintAlgorithm, String thumbprint)

Gets information about the specified certificate.

Parameters:

thumbprintAlgorithm - The algorithm used to derive the thumbprint parameter. This must be sha1.
thumbprint - The thumbprint of the certificate to get.

Returns:

the observable to the Certificate object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getAsync

public Observable getAsync(String thumbprintAlgorithm, String thumbprint, CertificateGetOptions certificateGetOptions)

Gets information about the specified certificate.

Parameters:

thumbprintAlgorithm - The algorithm used to derive the thumbprint parameter. This must be sha1.
thumbprint - The thumbprint of the certificate to get.
certificateGetOptions - Additional parameters for the operation

Returns:

the observable to the Certificate object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getAsync

public ServiceFuture getAsync(String thumbprintAlgorithm, String thumbprint, CertificateGetOptions certificateGetOptions, final ServiceCallback serviceCallback)

Gets information about the specified certificate.

Parameters:

thumbprintAlgorithm - The algorithm used to derive the thumbprint parameter. This must be sha1.
thumbprint - The thumbprint of the certificate to get.
certificateGetOptions - Additional parameters for the operation
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getAsync

public ServiceFuture getAsync(String thumbprintAlgorithm, String thumbprint, final ServiceCallback serviceCallback)

Gets information about the specified certificate.

Parameters:

thumbprintAlgorithm - The algorithm used to derive the thumbprint parameter. This must be sha1.
thumbprint - The thumbprint of the certificate to get.
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getWithServiceResponseAsync

public Observable<>> getWithServiceResponseAsync(String thumbprintAlgorithm, String thumbprint)

Gets information about the specified certificate.

Parameters:

thumbprintAlgorithm - The algorithm used to derive the thumbprint parameter. This must be sha1.
thumbprint - The thumbprint of the certificate to get.

Returns:

the observable to the Certificate object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getWithServiceResponseAsync

public Observable<>> getWithServiceResponseAsync(String thumbprintAlgorithm, String thumbprint, CertificateGetOptions certificateGetOptions)

Gets information about the specified certificate.

Parameters:

thumbprintAlgorithm - The algorithm used to derive the thumbprint parameter. This must be sha1.
thumbprint - The thumbprint of the certificate to get.
certificateGetOptions - Additional parameters for the operation

Returns:

the observable to the Certificate object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

list

public PagedList list()

Lists all of the certificates that have been added to the specified account.

Returns:

the PagedList<Certificate> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
BatchErrorException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

list

public PagedList list(final CertificateListOptions certificateListOptions)

Lists all of the certificates that have been added to the specified account.

Parameters:

certificateListOptions - Additional parameters for the operation

Returns:

the PagedList<Certificate> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
BatchErrorException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listAsync

public Observable<>> listAsync()

Lists all of the certificates that have been added to the specified account.

Returns:

the observable to the PagedList<Certificate> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listAsync

public Observable<>> listAsync(final CertificateListOptions certificateListOptions)

Lists all of the certificates that have been added to the specified account.

Parameters:

certificateListOptions - Additional parameters for the operation

Returns:

the observable to the PagedList<Certificate> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listAsync

public ServiceFuture<>> listAsync(final CertificateListOptions certificateListOptions, final ListOperationCallback serviceCallback)

Lists all of the certificates that have been added to the specified account.

Parameters:

certificateListOptions - Additional parameters for the operation
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listAsync

public ServiceFuture<>> listAsync(final ListOperationCallback serviceCallback)

Lists all of the certificates that have been added to the specified account.

Parameters:

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listNext

public PagedList listNext(final String nextPageLink)

Lists all of the certificates that have been added to the specified account.

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

Returns:

the PagedList<Certificate> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
BatchErrorException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listNext

public PagedList listNext(final String nextPageLink, final CertificateListNextOptions certificateListNextOptions)

Lists all of the certificates that have been added to the specified account.

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.
certificateListNextOptions - Additional parameters for the operation

Returns:

the PagedList<Certificate> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
BatchErrorException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listNextAsync

public Observable<>> listNextAsync(final String nextPageLink)

Lists all of the certificates that have been added to the specified account.

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

Returns:

the observable to the PagedList<Certificate> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listNextAsync

public Observable<>> listNextAsync(final String nextPageLink, final CertificateListNextOptions certificateListNextOptions)

Lists all of the certificates that have been added to the specified account.

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.
certificateListNextOptions - Additional parameters for the operation

Returns:

the observable to the PagedList<Certificate> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listNextAsync

public ServiceFuture<>> listNextAsync(final String nextPageLink, final CertificateListNextOptions certificateListNextOptions, final ServiceFuture<>> serviceFuture, final ListOperationCallback serviceCallback)

Lists all of the certificates that have been added to the specified account.

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.
certificateListNextOptions - Additional parameters for the operation
serviceFuture - the ServiceFuture object tracking the Retrofit calls
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listNextAsync

public ServiceFuture<>> listNextAsync(final String nextPageLink, final ServiceFuture<>> serviceFuture, final ListOperationCallback serviceCallback)

Lists all of the certificates that have been added to the specified account.

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.
serviceFuture - the ServiceFuture object tracking the Retrofit calls
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listNextWithServiceResponseAsync

public Observable<><>, CertificateListHeaders>> listNextWithServiceResponseAsync(final String nextPageLink)

Lists all of the certificates that have been added to the specified account.

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

Returns:

the observable to the PagedList<Certificate> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listNextWithServiceResponseAsync

public Observable<><>, CertificateListHeaders>> listNextWithServiceResponseAsync(final String nextPageLink, final CertificateListNextOptions certificateListNextOptions)

Lists all of the certificates that have been added to the specified account.

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.
certificateListNextOptions - Additional parameters for the operation

Returns:

the observable to the PagedList<Certificate> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listWithServiceResponseAsync

public Observable<><>, CertificateListHeaders>> listWithServiceResponseAsync()

Lists all of the certificates that have been added to the specified account.

Returns:

the observable to the PagedList<Certificate> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listWithServiceResponseAsync

public Observable<><>, CertificateListHeaders>> listWithServiceResponseAsync(final CertificateListOptions certificateListOptions)

Lists all of the certificates that have been added to the specified account.

Parameters:

certificateListOptions - Additional parameters for the operation

Returns:

the observable to the PagedList<Certificate> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

Applies to