SecretClient.StartDeleteSecret(String, CancellationToken) メソッド

定義

名前空間:

Azure.Security.KeyVault.Secrets

アセンブリ:

Azure.Security.KeyVault.Secrets.dll

パッケージ:

Azure.Security.KeyVault.Secrets v4.6.0

ソース:

SecretClient.cs

指定したキー コンテナーからシークレットを削除します。

public virtual Azure.Security.KeyVault.Secrets.DeleteSecretOperation StartDeleteSecret (string name, System.Threading.CancellationToken cancellationToken = default);

abstract member StartDeleteSecret : string * System.Threading.CancellationToken -> Azure.Security.KeyVault.Secrets.DeleteSecretOperation
override this.StartDeleteSecret : string * System.Threading.CancellationToken -> Azure.Security.KeyVault.Secrets.DeleteSecretOperation

Public Overridable Function StartDeleteSecret (name As String, Optional cancellationToken As CancellationToken = Nothing) As DeleteSecretOperation

パラメーター

name

String

シークレットの名前。

cancellationToken

CancellationToken

CancellationToken要求の有効期間を制御する 。

戻り値

DeleteSecretOperation

DeleteSecretOperationこの実行時間の長い操作を待機する 。 Key Vaultが論理的な削除が有効になっている場合は、シークレットを回復または消去する必要がある場合にのみ操作が完了するまで待機する必要があります。それ以外の場合は、 でシークレットが自動的にScheduledPurgeDate削除されます。

例外

ArgumentException

name が空の文字列です。

ArgumentNullException

name が null です。

RequestFailedException

サーバーからエラーが返されました。 サーバーから返される詳細については、「」を参照してください Message 。

注釈

削除操作は、Azure Key Vaultに格納されているすべてのシークレットに適用されます。 シークレットの個々のバージョンに削除を適用することはできません。 この操作には、シークレット/削除アクセス許可が必要です。