KeyVaultClient.PurgeDeletedSecretWithHttpMessagesAsync メソッド

  • リファレンス

定義

名前空間:
Microsoft.Azure.KeyVault
アセンブリ:
Microsoft.Azure.KeyVault.dll
パッケージ:
Microsoft.Azure.KeyVault v3.0.5
ソース:
KeyVaultClient.cs

指定したシークレットを完全に削除します。

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse> PurgeDeletedSecretWithHttpMessagesAsync (string vaultBaseUrl, string secretName, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member PurgeDeletedSecretWithHttpMessagesAsync : string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse>
override this.PurgeDeletedSecretWithHttpMessagesAsync : string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse>
Public Function PurgeDeletedSecretWithHttpMessagesAsync (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)

パラメーター

vaultBaseUrl
String

コンテナー名 (例: https://myvault.vault.azure.net)。

secretName
String

シークレットの名前。

customHeaders
Dictionary<String,List<String>>

要求に追加されるヘッダー。

cancellationToken
CancellationToken

キャンセル トークン。

戻り値

Task<AzureOperationResponse>

実装

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

例外

KeyVaultErrorException

操作が無効な状態コードを返したときにスローされます

ValidationException

必須パラメーターが null の場合にスローされます

ArgumentNullException

必須パラメーターが null の場合にスローされます

注釈

削除されたシークレットの消去操作は、回復の可能性なしにシークレットを完全に削除します。 この操作は、論理的な削除が有効なコンテナーでのみ有効にすることができます。 この操作には、シークレット/消去アクセス許可が必要です。

適用対象