KeyVaultClient.DeleteSecretWithHttpMessagesAsync Método

Definição

Namespace:

Microsoft.Azure.KeyVault

Assembly:

Microsoft.Azure.KeyVault.dll

Pacote:

Microsoft.Azure.KeyVault v3.0.5

Origem:

KeyVaultClient.cs

Exclui um segredo de um cofre de chaves 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

O nome do cofre, por exemplo https://myvault.vault.azure.net, .

secretName

String

O nome do segredo.

customHeaders

Dictionary<String,List<String>>

Cabeçalhos que serão adicionados à solicitação.

cancellationToken

CancellationToken

O token de cancelamento.

Retornos

Task<AzureOperationResponse<DeletedSecretBundle>>

Implementações

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

Exceções

KeyVaultErrorException

Gerada quando a operação retornou um código de status inválido

SerializationException

Gerada quando não é possível desserializar a resposta

ValidationException

Gerado quando um parâmetro necessário é nulo

ArgumentNullException

Gerado quando um parâmetro necessário é nulo

Comentários

A operação DELETE se aplica a qualquer segredo armazenado em um Cofre de Chaves do Azure. A operação DELETE não pode ser aplicada a uma versão individual de um segredo. Essa operação requer a permissão de segredos/exclusão.