Compartir a través de


KeyClient.StartDeleteKey(String, CancellationToken) Método

Definición

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

public virtual Azure.Security.KeyVault.Keys.DeleteKeyOperation StartDeleteKey (string name, System.Threading.CancellationToken cancellationToken = default);
abstract member StartDeleteKey : string * System.Threading.CancellationToken -> Azure.Security.KeyVault.Keys.DeleteKeyOperation
override this.StartDeleteKey : string * System.Threading.CancellationToken -> Azure.Security.KeyVault.Keys.DeleteKeyOperation
Public Overridable Function StartDeleteKey (name As String, Optional cancellationToken As CancellationToken = Nothing) As DeleteKeyOperation

Parámetros

name
String

El nombre de la clave.

cancellationToken
CancellationToken

Control CancellationToken de la duración de la solicitud.

Devoluciones

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

name es una cadena vacía.

name es null.

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.

Se aplica a