KeyClient.StartDeleteKeyAsync(String, CancellationToken) Método

Definición

Espacio de nombres:

Azure.Security.KeyVault.Keys

Ensamblado:

Azure.Security.KeyVault.Keys.dll

Paquete:

Azure.Security.KeyVault.Keys v4.6.0

Source:

KeyClient.cs

Elimina una clave de cualquier tipo del almacenamiento en Azure Key Vault.

public virtual System.Threading.Tasks.Task<Azure.Security.KeyVault.Keys.DeleteKeyOperation> StartDeleteKeyAsync (string name, System.Threading.CancellationToken cancellationToken = default);

abstract member StartDeleteKeyAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Security.KeyVault.Keys.DeleteKeyOperation>
override this.StartDeleteKeyAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Security.KeyVault.Keys.DeleteKeyOperation>

Public Overridable Function StartDeleteKeyAsync (name As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DeleteKeyOperation)

Parámetros

name

String

El nombre de la clave.

cancellationToken

CancellationToken

Control CancellationToken de la duración de la solicitud.

Devoluciones

Task<DeleteKeyOperation>

que DeleteKeyOperation se va a esperar en esta operación de larga duración. Si el Key Vault está habilitado para eliminación temporal, solo tiene que esperar a que se complete la operación si necesita recuperar o purgar la clave; de lo contrario, la clave se elimina automáticamente en ScheduledPurgeDate.

Excepciones

ArgumentException

name es una cadena vacía.

ArgumentNullException

name es null.

RequestFailedException

El servidor devolvió un error. Consulte Message para obtener más información devuelta desde el servidor.

Comentarios

La operación de eliminación de clave no se puede usar para quitar versiones individuales de una clave. Esta operación elimina el material criptográfico asociado a la clave, lo que significa que no se puede utilizar para las operaciones firmar y comprobar, encapsular/desencapsular o cifrar/descifrar. Esta operación requiere el permiso keys/delete.