KeyVaultClient.DeleteSecretWithHttpMessagesAsync Método

Definición

Espacio de nombres:

Microsoft.Azure.KeyVault

Ensamblado:

Microsoft.Azure.KeyVault.dll

Paquete:

Microsoft.Azure.KeyVault v3.0.5

Source:

KeyVaultClient.cs

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

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.KeyVault.Models.DeletedSecretBundle>> DeleteSecretWithHttpMessagesAsync (string vaultBaseUrl, string secretName, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteSecretWithHttpMessagesAsync : string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.KeyVault.Models.DeletedSecretBundle>>
override this.DeleteSecretWithHttpMessagesAsync : string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.KeyVault.Models.DeletedSecretBundle>>

Public Function DeleteSecretWithHttpMessagesAsync (vaultBaseUrl As String, secretName As String, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of DeletedSecretBundle))

Parámetros

vaultBaseUrl

String

El nombre del almacén, por ejemplo https://myvault.vault.azure.net, .

secretName

String

Nombre del secreto.

customHeaders

Dictionary<String,List<String>>

Encabezados que se agregarán a la solicitud.

cancellationToken

CancellationToken

Token de cancelación.

Devoluciones

Task<AzureOperationResponse<DeletedSecretBundle>>

Implementaciones

DeleteSecretWithHttpMessagesAsync(String, String, Dictionary<String,List<String>>, CancellationToken)

Excepciones

KeyVaultErrorException

Se produce cuando la operación devolvió un código de estado no válido

SerializationException

Se produce cuando no se puede deserializar la respuesta

ValidationException

Se produce cuando un parámetro obligatorio es NULL

ArgumentNullException

Se produce cuando un parámetro obligatorio es NULL

Comentarios

La operación de eliminación DELETE se aplica a cualquier secreto almacenado en Azure Key Vault. DELETE no se puede aplicar a una versión individual de un secreto. Esta operación requiere el permiso secrets/delete.