SecretClient.StartDeleteSecretAsync(String, CancellationToken) Método

Definición

Espacio de nombres:

Azure.Security.KeyVault.Secrets

Ensamblado:

Azure.Security.KeyVault.Secrets.dll

Paquete:

Azure.Security.KeyVault.Secrets v4.6.0

Source:

SecretClient.cs

Elimina un secreto de un almacén de claves especificado.

public virtual System.Threading.Tasks.Task<Azure.Security.KeyVault.Secrets.DeleteSecretOperation> StartDeleteSecretAsync (string name, System.Threading.CancellationToken cancellationToken = default);

abstract member StartDeleteSecretAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Security.KeyVault.Secrets.DeleteSecretOperation>
override this.StartDeleteSecretAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Security.KeyVault.Secrets.DeleteSecretOperation>

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

Parámetros

name

String

Nombre del secreto.

cancellationToken

CancellationToken

Control CancellationToken de la duración de la solicitud.

Devoluciones

Task<DeleteSecretOperation>

que DeleteSecretOperation se va a esperar en esta operación de larga duración. Si el Key Vault está habilitado para la eliminación temporal, solo tiene que esperar a que se complete la operación si necesita recuperar o purgar el secreto; de lo contrario, el secreto 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 se aplica a cualquier secreto almacenado en Azure Key Vault. La eliminación no se puede aplicar a una versión individual de un secreto. Esta operación requiere el permiso secrets/delete.