你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

SecretClient.StartDeleteSecret(String, CancellationToken) 方法

定义

命名空间:

Azure.Security.KeyVault.Secrets

程序集:

Azure.Security.KeyVault.Secrets.dll

包:

Azure.Security.KeyVault.Secrets v4.6.0

Source:

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 此长时间运行的操作的 。 如果密钥保管库已启用软删除，则只需在需要恢复或清除机密时等待操作完成;否则，会在 上ScheduledPurgeDate自动删除机密。

例外

ArgumentException

name 是一个空字符串。

ArgumentNullException

name 为 null。

RequestFailedException

服务器返回错误。 有关从服务器返回的详细信息，请参阅 Message 。

注解

删除操作适用于存储在 Azure 密钥保管库 中的任何机密。 删除不能应用于机密的单个版本。 此操作需要机密/删除权限。