CertificateOperations interface
Interface representing a CertificateOperations.
Methods
| begin |
Warning: This operation is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead. |
| begin |
Warning: This operation is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead. |
| 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. Warning: This operation is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead. |
| create(string, string, string, Certificate |
Warning: This operation is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead. |
| get(string, string, string, Certificate |
Warning: This operation is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead. |
| list |
Warning: This operation is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead. |
| update(string, string, string, Certificate |
Warning: This operation is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead. |
Method Details
beginDelete(string, string, string, CertificateDeleteOptionalParams)
Warning: This operation is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.
function beginDelete(resourceGroupName: string, accountName: string, certificateName: string, options?: CertificateDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the Batch account.
- accountName
-
string
The name of the Batch account.
- certificateName
-
string
The identifier for the certificate. This must be made up of algorithm and thumbprint separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5.
- options
- CertificateDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, CertificateDeleteOptionalParams)
Warning: This operation is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.
function beginDeleteAndWait(resourceGroupName: string, accountName: string, certificateName: string, options?: CertificateDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the Batch account.
- accountName
-
string
The name of the Batch account.
- certificateName
-
string
The identifier for the certificate. This must be made up of algorithm and thumbprint separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5.
- options
- CertificateDeleteOptionalParams
The options parameters.
Returns
Promise<void>
cancelDeletion(string, 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.
Warning: This operation is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.
function cancelDeletion(resourceGroupName: string, accountName: string, certificateName: string, options?: CertificateCancelDeletionOptionalParams): Promise<CertificateCancelDeletionResponse>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the Batch account.
- accountName
-
string
The name of the Batch account.
- certificateName
-
string
The identifier for the certificate. This must be made up of algorithm and thumbprint separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5.
The options parameters.
Returns
Promise<CertificateCancelDeletionResponse>
create(string, string, string, CertificateCreateOrUpdateParameters, CertificateCreateOptionalParams)
Warning: This operation is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.
function create(resourceGroupName: string, accountName: string, certificateName: string, parameters: CertificateCreateOrUpdateParameters, options?: CertificateCreateOptionalParams): Promise<CertificateCreateResponse>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the Batch account.
- accountName
-
string
The name of the Batch account.
- certificateName
-
string
The identifier for the certificate. This must be made up of algorithm and thumbprint separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5.
- parameters
- CertificateCreateOrUpdateParameters
Additional parameters for certificate creation.
- options
- CertificateCreateOptionalParams
The options parameters.
Returns
Promise<CertificateCreateResponse>
get(string, string, string, CertificateGetOptionalParams)
Warning: This operation is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.
function get(resourceGroupName: string, accountName: string, certificateName: string, options?: CertificateGetOptionalParams): Promise<CertificateGetResponse>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the Batch account.
- accountName
-
string
The name of the Batch account.
- certificateName
-
string
The identifier for the certificate. This must be made up of algorithm and thumbprint separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5.
- options
- CertificateGetOptionalParams
The options parameters.
Returns
Promise<CertificateGetResponse>
listByBatchAccount(string, string, CertificateListByBatchAccountOptionalParams)
Warning: This operation is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.
function listByBatchAccount(resourceGroupName: string, accountName: string, options?: CertificateListByBatchAccountOptionalParams): PagedAsyncIterableIterator<Certificate, Certificate[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the Batch account.
- accountName
-
string
The name of the Batch account.
The options parameters.
Returns
update(string, string, string, CertificateCreateOrUpdateParameters, CertificateUpdateOptionalParams)
Warning: This operation is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.
function update(resourceGroupName: string, accountName: string, certificateName: string, parameters: CertificateCreateOrUpdateParameters, options?: CertificateUpdateOptionalParams): Promise<CertificateUpdateResponse>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the Batch account.
- accountName
-
string
The name of the Batch account.
- certificateName
-
string
The identifier for the certificate. This must be made up of algorithm and thumbprint separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5.
- parameters
- CertificateCreateOrUpdateParameters
Certificate entity to update.
- options
- CertificateUpdateOptionalParams
The options parameters.
Returns
Promise<CertificateUpdateResponse>