CertificateOperations class
Class representing a CertificateOperations.
Constructors
| Certificate |
Create a CertificateOperations. |
Methods
| add(Certificate |
|
| add(Certificate |
|
| add(Certificate |
|
| cancel |
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. |
| cancel |
|
| cancel |
|
| delete |
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 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. |
| delete |
|
| delete |
|
| get(string, string, Certificate |
Gets information about the specified Certificate. |
| get(string, string, Certificate |
|
| get(string, string, Service |
|
| list(Certificate |
|
| list(Certificate |
|
| list(Service |
|
| list |
|
| list |
|
| list |
Constructor Details
CertificateOperations(BatchServiceClientContext)
Create a CertificateOperations.
new CertificateOperations(client: BatchServiceClientContext)Parameters
- client
- BatchServiceClientContext
Reference to the service client.
Method Details
add(CertificateAddParameter, CertificateAddOptionalParams)
function add(certificate: CertificateAddParameter, options?: CertificateAddOptionalParams): Promise<CertificateAddResponse>Parameters
- certificate
- CertificateAddParameter
The Certificate to be added.
- options
- CertificateAddOptionalParams
The optional parameters
Returns
Promise<CertificateAddResponse>
Promise<Models.CertificateAddResponse>
add(CertificateAddParameter, CertificateAddOptionalParams, ServiceCallback<void>)
function add(certificate: CertificateAddParameter, options: CertificateAddOptionalParams, callback: ServiceCallback<void>)Parameters
- certificate
- CertificateAddParameter
The Certificate to be added.
- options
- CertificateAddOptionalParams
The optional parameters
- callback
-
ServiceCallback<void>
The callback
add(CertificateAddParameter, ServiceCallback<void>)
function add(certificate: CertificateAddParameter, callback: ServiceCallback<void>)Parameters
- certificate
- CertificateAddParameter
The Certificate to be added.
- callback
-
ServiceCallback<void>
The callback
cancelDeletion(string, string, CertificateCancelDeletionOptionalParams)
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.
function cancelDeletion(thumbprintAlgorithm: string, thumbprint: string, options?: CertificateCancelDeletionOptionalParams): Promise<CertificateCancelDeletionResponse>Parameters
- thumbprintAlgorithm
-
string
The algorithm used to derive the thumbprint parameter. This must be sha1.
- thumbprint
-
string
The thumbprint of the Certificate being deleted.
The optional parameters
Returns
Promise<CertificateCancelDeletionResponse>
Promise<Models.CertificateCancelDeletionResponse>
cancelDeletion(string, string, CertificateCancelDeletionOptionalParams, ServiceCallback<void>)
function cancelDeletion(thumbprintAlgorithm: string, thumbprint: string, options: CertificateCancelDeletionOptionalParams, callback: ServiceCallback<void>)Parameters
- thumbprintAlgorithm
-
string
The algorithm used to derive the thumbprint parameter. This must be sha1.
- thumbprint
-
string
The thumbprint of the Certificate being deleted.
The optional parameters
- callback
-
ServiceCallback<void>
The callback
cancelDeletion(string, string, ServiceCallback<void>)
function cancelDeletion(thumbprintAlgorithm: string, thumbprint: string, callback: ServiceCallback<void>)Parameters
- thumbprintAlgorithm
-
string
The algorithm used to derive the thumbprint parameter. This must be sha1.
- thumbprint
-
string
The thumbprint of the Certificate being deleted.
- callback
-
ServiceCallback<void>
The callback
deleteMethod(string, string, CertificateDeleteMethodOptionalParams)
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 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.
function deleteMethod(thumbprintAlgorithm: string, thumbprint: string, options?: CertificateDeleteMethodOptionalParams): Promise<CertificateDeleteResponse>Parameters
- thumbprintAlgorithm
-
string
The algorithm used to derive the thumbprint parameter. This must be sha1.
- thumbprint
-
string
The thumbprint of the Certificate to be deleted.
The optional parameters
Returns
Promise<CertificateDeleteResponse>
Promise<Models.CertificateDeleteResponse>
deleteMethod(string, string, CertificateDeleteMethodOptionalParams, ServiceCallback<void>)
function deleteMethod(thumbprintAlgorithm: string, thumbprint: string, options: CertificateDeleteMethodOptionalParams, callback: ServiceCallback<void>)Parameters
- thumbprintAlgorithm
-
string
The algorithm used to derive the thumbprint parameter. This must be sha1.
- thumbprint
-
string
The thumbprint of the Certificate to be deleted.
The optional parameters
- callback
-
ServiceCallback<void>
The callback
deleteMethod(string, string, ServiceCallback<void>)
function deleteMethod(thumbprintAlgorithm: string, thumbprint: string, callback: ServiceCallback<void>)Parameters
- thumbprintAlgorithm
-
string
The algorithm used to derive the thumbprint parameter. This must be sha1.
- thumbprint
-
string
The thumbprint of the Certificate to be deleted.
- callback
-
ServiceCallback<void>
The callback
get(string, string, CertificateGetOptionalParams)
Gets information about the specified Certificate.
function get(thumbprintAlgorithm: string, thumbprint: string, options?: CertificateGetOptionalParams): Promise<CertificateGetResponse>Parameters
- thumbprintAlgorithm
-
string
The algorithm used to derive the thumbprint parameter. This must be sha1.
- thumbprint
-
string
The thumbprint of the Certificate to get.
- options
- CertificateGetOptionalParams
The optional parameters
Returns
Promise<CertificateGetResponse>
Promise<Models.CertificateGetResponse>
get(string, string, CertificateGetOptionalParams, ServiceCallback<Certificate>)
function get(thumbprintAlgorithm: string, thumbprint: string, options: CertificateGetOptionalParams, callback: ServiceCallback<Certificate>)Parameters
- thumbprintAlgorithm
-
string
The algorithm used to derive the thumbprint parameter. This must be sha1.
- thumbprint
-
string
The thumbprint of the Certificate to get.
- options
- CertificateGetOptionalParams
The optional parameters
- callback
The callback
get(string, string, ServiceCallback<Certificate>)
function get(thumbprintAlgorithm: string, thumbprint: string, callback: ServiceCallback<Certificate>)Parameters
- thumbprintAlgorithm
-
string
The algorithm used to derive the thumbprint parameter. This must be sha1.
- thumbprint
-
string
The thumbprint of the Certificate to get.
- callback
The callback
list(CertificateListOptionalParams)
function list(options?: CertificateListOptionalParams): Promise<CertificateListResponse>Parameters
- options
- CertificateListOptionalParams
The optional parameters
Returns
Promise<CertificateListResponse>
Promise<Models.CertificateListResponse>
list(CertificateListOptionalParams, ServiceCallback<CertificateListResult>)
function list(options: CertificateListOptionalParams, callback: ServiceCallback<CertificateListResult>)Parameters
- options
- CertificateListOptionalParams
The optional parameters
- callback
The callback
list(ServiceCallback<CertificateListResult>)
function list(callback: ServiceCallback<CertificateListResult>)Parameters
- callback
The callback
listNext(string, CertificateListNextOptionalParams)
function listNext(nextPageLink: string, options?: CertificateListNextOptionalParams): Promise<CertificateListResponse>Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
The optional parameters
Returns
Promise<CertificateListResponse>
Promise<Models.CertificateListResponse>
listNext(string, CertificateListNextOptionalParams, ServiceCallback<CertificateListResult>)
function listNext(nextPageLink: string, options: CertificateListNextOptionalParams, callback: ServiceCallback<CertificateListResult>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
The optional parameters
- callback
The callback
listNext(string, ServiceCallback<CertificateListResult>)
function listNext(nextPageLink: string, callback: ServiceCallback<CertificateListResult>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- callback
The callback