com.microsoft.azure.batch.protocol

Interface Certificates

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.
rx.Observable<Void>	addAsync(CertificateAddParameter certificate) Adds a certificate to the specified account.
rx.Observable<Void>	addAsync(CertificateAddParameter certificate, CertificateAddOptions certificateAddOptions) Adds a certificate to the specified account.
ServiceFuture<Void>	addAsync(CertificateAddParameter certificate, CertificateAddOptions certificateAddOptions, ServiceCallback<Void> serviceCallback) Adds a certificate to the specified account.
ServiceFuture<Void>	addAsync(CertificateAddParameter certificate, ServiceCallback<Void> serviceCallback) Adds a certificate to the specified account.
rx.Observable<ServiceResponseWithHeaders<Void,CertificateAddHeaders>>	addWithServiceResponseAsync(CertificateAddParameter certificate) Adds a certificate to the specified account.
rx.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.
void	cancelDeletion(String thumbprintAlgorithm, String thumbprint, CertificateCancelDeletionOptions certificateCancelDeletionOptions) Cancels a failed deletion of a certificate from the specified account.
rx.Observable<Void>	cancelDeletionAsync(String thumbprintAlgorithm, String thumbprint) Cancels a failed deletion of a certificate from the specified account.
rx.Observable<Void>	cancelDeletionAsync(String thumbprintAlgorithm, String thumbprint, CertificateCancelDeletionOptions certificateCancelDeletionOptions) Cancels a failed deletion of a certificate from the specified account.
ServiceFuture<Void>	cancelDeletionAsync(String thumbprintAlgorithm, String thumbprint, CertificateCancelDeletionOptions certificateCancelDeletionOptions, ServiceCallback<Void> serviceCallback) Cancels a failed deletion of a certificate from the specified account.
ServiceFuture<Void>	cancelDeletionAsync(String thumbprintAlgorithm, String thumbprint, ServiceCallback<Void> serviceCallback) Cancels a failed deletion of a certificate from the specified account.
rx.Observable<ServiceResponseWithHeaders<Void,CertificateCancelDeletionHeaders>>	cancelDeletionWithServiceResponseAsync(String thumbprintAlgorithm, String thumbprint) Cancels a failed deletion of a certificate from the specified account.
rx.Observable<ServiceResponseWithHeaders<Void,CertificateCancelDeletionHeaders>>	cancelDeletionWithServiceResponseAsync(String thumbprintAlgorithm, String thumbprint, CertificateCancelDeletionOptions certificateCancelDeletionOptions) Cancels a failed deletion of a certificate from the specified account.
void	delete(String thumbprintAlgorithm, String thumbprint) Deletes a certificate from the specified account.
void	delete(String thumbprintAlgorithm, String thumbprint, CertificateDeleteOptions certificateDeleteOptions) Deletes a certificate from the specified account.
rx.Observable<Void>	deleteAsync(String thumbprintAlgorithm, String thumbprint) Deletes a certificate from the specified account.
rx.Observable<Void>	deleteAsync(String thumbprintAlgorithm, String thumbprint, CertificateDeleteOptions certificateDeleteOptions) Deletes a certificate from the specified account.
ServiceFuture<Void>	deleteAsync(String thumbprintAlgorithm, String thumbprint, CertificateDeleteOptions certificateDeleteOptions, ServiceCallback<Void> serviceCallback) Deletes a certificate from the specified account.
ServiceFuture<Void>	deleteAsync(String thumbprintAlgorithm, String thumbprint, ServiceCallback<Void> serviceCallback) Deletes a certificate from the specified account.
rx.Observable<ServiceResponseWithHeaders<Void,CertificateDeleteHeaders>>	deleteWithServiceResponseAsync(String thumbprintAlgorithm, String thumbprint) Deletes a certificate from the specified account.
rx.Observable<ServiceResponseWithHeaders<Void,CertificateDeleteHeaders>>	deleteWithServiceResponseAsync(String thumbprintAlgorithm, String thumbprint, CertificateDeleteOptions certificateDeleteOptions) Deletes a certificate from the specified account.
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.
rx.Observable<Certificate>	getAsync(String thumbprintAlgorithm, String thumbprint) Gets information about the specified certificate.
rx.Observable<Certificate>	getAsync(String thumbprintAlgorithm, String thumbprint, CertificateGetOptions certificateGetOptions) Gets information about the specified certificate.
ServiceFuture<Certificate>	getAsync(String thumbprintAlgorithm, String thumbprint, CertificateGetOptions certificateGetOptions, ServiceCallback<Certificate> serviceCallback) Gets information about the specified certificate.
ServiceFuture<Certificate>	getAsync(String thumbprintAlgorithm, String thumbprint, ServiceCallback<Certificate> serviceCallback) Gets information about the specified certificate.
rx.Observable<ServiceResponseWithHeaders<Certificate,CertificateGetHeaders>>	getWithServiceResponseAsync(String thumbprintAlgorithm, String thumbprint) Gets information about the specified certificate.
rx.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(CertificateListOptions certificateListOptions) Lists all of the certificates that have been added to the specified account.
rx.Observable<Page<Certificate>>	listAsync() Lists all of the certificates that have been added to the specified account.
rx.Observable<Page<Certificate>>	listAsync(CertificateListOptions certificateListOptions) Lists all of the certificates that have been added to the specified account.
ServiceFuture<List<Certificate>>	listAsync(CertificateListOptions certificateListOptions, ListOperationCallback<Certificate> serviceCallback) Lists all of the certificates that have been added to the specified account.
ServiceFuture<List<Certificate>>	listAsync(ListOperationCallback<Certificate> serviceCallback) Lists all of the certificates that have been added to the specified account.
PagedList<Certificate>	listNext(String nextPageLink) Lists all of the certificates that have been added to the specified account.
PagedList<Certificate>	listNext(String nextPageLink, CertificateListNextOptions certificateListNextOptions) Lists all of the certificates that have been added to the specified account.
rx.Observable<Page<Certificate>>	listNextAsync(String nextPageLink) Lists all of the certificates that have been added to the specified account.
rx.Observable<Page<Certificate>>	listNextAsync(String nextPageLink, CertificateListNextOptions certificateListNextOptions) Lists all of the certificates that have been added to the specified account.
ServiceFuture<List<Certificate>>	listNextAsync(String nextPageLink, CertificateListNextOptions certificateListNextOptions, ServiceFuture<List<Certificate>> serviceFuture, ListOperationCallback<Certificate> serviceCallback) Lists all of the certificates that have been added to the specified account.
ServiceFuture<List<Certificate>>	listNextAsync(String nextPageLink, ServiceFuture<List<Certificate>> serviceFuture, ListOperationCallback<Certificate> serviceCallback) Lists all of the certificates that have been added to the specified account.
rx.Observable<ServiceResponseWithHeaders<Page<Certificate>,CertificateListHeaders>>	listNextWithServiceResponseAsync(String nextPageLink) Lists all of the certificates that have been added to the specified account.
rx.Observable<ServiceResponseWithHeaders<Page<Certificate>,CertificateListHeaders>>	listNextWithServiceResponseAsync(String nextPageLink, CertificateListNextOptions certificateListNextOptions) Lists all of the certificates that have been added to the specified account.
rx.Observable<ServiceResponseWithHeaders<Page<Certificate>,CertificateListHeaders>>	listWithServiceResponseAsync() Lists all of the certificates that have been added to the specified account.
rx.Observable<ServiceResponseWithHeaders<Page<Certificate>,CertificateListHeaders>>	listWithServiceResponseAsync(CertificateListOptions certificateListOptions) Lists all of the certificates that have been added to the specified account.

Method Detail

add

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

addAsync

ServiceFuture<Void> addAsync(CertificateAddParameter certificate,
                             ServiceCallback<Void> 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

addAsync

rx.Observable<Void> 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

addWithServiceResponseAsync

rx.Observable<ServiceResponseWithHeaders<Void,CertificateAddHeaders>> 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

add

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

ServiceFuture<Void> addAsync(CertificateAddParameter certificate,
                             CertificateAddOptions certificateAddOptions,
                             ServiceCallback<Void> 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

rx.Observable<Void> 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

addWithServiceResponseAsync

rx.Observable<ServiceResponseWithHeaders<Void,CertificateAddHeaders>> 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

list

PagedList<Certificate> 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

listAsync

ServiceFuture<List<Certificate>> listAsync(ListOperationCallback<Certificate> 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

listAsync

rx.Observable<Page<Certificate>> 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

listWithServiceResponseAsync

rx.Observable<ServiceResponseWithHeaders<Page<Certificate>,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

list

PagedList<Certificate> list(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

ServiceFuture<List<Certificate>> listAsync(CertificateListOptions certificateListOptions,
                                           ListOperationCallback<Certificate> 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

rx.Observable<Page<Certificate>> listAsync(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

listWithServiceResponseAsync

rx.Observable<ServiceResponseWithHeaders<Page<Certificate>,CertificateListHeaders>> listWithServiceResponseAsync(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

cancelDeletion

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

cancelDeletionAsync

ServiceFuture<Void> cancelDeletionAsync(String thumbprintAlgorithm,
                                        String thumbprint,
                                        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.

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

cancelDeletionAsync

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

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

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

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

cancelDeletion

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

ServiceFuture<Void> cancelDeletionAsync(String thumbprintAlgorithm,
                                        String thumbprint,
                                        CertificateCancelDeletionOptions certificateCancelDeletionOptions,
                                        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.

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

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

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

cancelDeletionWithServiceResponseAsync

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

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

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

deleteAsync

ServiceFuture<Void> deleteAsync(String thumbprintAlgorithm,
                                String thumbprint,
                                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.

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

deleteAsync

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

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

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

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

delete

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

ServiceFuture<Void> deleteAsync(String thumbprintAlgorithm,
                                String thumbprint,
                                CertificateDeleteOptions certificateDeleteOptions,
                                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.

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

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

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

deleteWithServiceResponseAsync

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

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

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

getAsync

ServiceFuture<Certificate> getAsync(String thumbprintAlgorithm,
                                    String thumbprint,
                                    ServiceCallback<Certificate> 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

getAsync

rx.Observable<Certificate> 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

getWithServiceResponseAsync

rx.Observable<ServiceResponseWithHeaders<Certificate,CertificateGetHeaders>> 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

get

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

ServiceFuture<Certificate> getAsync(String thumbprintAlgorithm,
                                    String thumbprint,
                                    CertificateGetOptions certificateGetOptions,
                                    ServiceCallback<Certificate> 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

rx.Observable<Certificate> 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

getWithServiceResponseAsync

rx.Observable<ServiceResponseWithHeaders<Certificate,CertificateGetHeaders>> 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

listNext

PagedList<Certificate> listNext(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

listNextAsync

ServiceFuture<List<Certificate>> listNextAsync(String nextPageLink,
                                               ServiceFuture<List<Certificate>> serviceFuture,
                                               ListOperationCallback<Certificate> 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

listNextAsync

rx.Observable<Page<Certificate>> listNextAsync(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

rx.Observable<ServiceResponseWithHeaders<Page<Certificate>,CertificateListHeaders>> listNextWithServiceResponseAsync(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

listNext

PagedList<Certificate> listNext(String nextPageLink,
                                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

ServiceFuture<List<Certificate>> listNextAsync(String nextPageLink,
                                               CertificateListNextOptions certificateListNextOptions,
                                               ServiceFuture<List<Certificate>> serviceFuture,
                                               ListOperationCallback<Certificate> 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

rx.Observable<Page<Certificate>> listNextAsync(String nextPageLink,
                                               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

listNextWithServiceResponseAsync

rx.Observable<ServiceResponseWithHeaders<Page<Certificate>,CertificateListHeaders>> listNextWithServiceResponseAsync(String nextPageLink,
                                                                                                                     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