CertificateOperationsExtensions.DeleteAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.Batch.Protocol

Assembly:: Microsoft.Azure.Batch.dll

Package:: Microsoft.Azure.Batch v16.3.1

Source:: CertificateOperationsExtensions.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Caution

This operation is deprecated. Please do not use it any longer.

Deletes a Certificate from the specified Account.

[System.Obsolete("This operation is deprecated. Please do not use it any longer.")]
public static System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.CertificateDeleteHeaders> DeleteAsync (this Microsoft.Azure.Batch.Protocol.ICertificateOperations operations, string thumbprintAlgorithm, string thumbprint, Microsoft.Azure.Batch.Protocol.Models.CertificateDeleteOptions certificateDeleteOptions = default, System.Threading.CancellationToken cancellationToken = default);

[<System.Obsolete("This operation is deprecated. Please do not use it any longer.")>]
static member DeleteAsync : Microsoft.Azure.Batch.Protocol.ICertificateOperations * string * string * Microsoft.Azure.Batch.Protocol.Models.CertificateDeleteOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.CertificateDeleteHeaders>

<Extension()>
Public Function DeleteAsync (operations As ICertificateOperations, thumbprintAlgorithm As String, thumbprint As String, Optional certificateDeleteOptions As CertificateDeleteOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of CertificateDeleteHeaders)

Parameters

operations: ICertificateOperations

The operations group for this extension method.

thumbprintAlgorithm: String

The algorithm used to derive the thumbprint parameter. This must be sha1.

thumbprint: String

The thumbprint of the Certificate to be deleted.

certificateDeleteOptions: CertificateDeleteOptions

Additional parameters for the operation

cancellationToken: CancellationToken

The cancellation token.

Returns

Task<CertificateDeleteHeaders>

Attributes: ObsoleteAttribute

Remarks

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.

Warning: This operation is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.

Applies to

Share via