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

Remove-AzKeyVaultSecret

参考

模块:: Az.KeyVault

删除密钥保管库中的机密。

语法

Remove-AzKeyVaultSecret
      [-VaultName] <String>
      [-Name] <String>
      [-Force]
      [-PassThru]
      [-InRemovedState]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzKeyVaultSecret
      [-Id] <String>
      [-Force]
      [-PassThru]
      [-InRemovedState]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzKeyVaultSecret
      [-InputObject] <PSKeyVaultSecretIdentityItem>
      [-Force]
      [-PassThru]
      [-InRemovedState]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

说明

Remove-AzKeyVaultSecret cmdlet 删除密钥保管库中的机密。如果意外删除了机密，则可以使用具有特殊“恢复”权限的用户 Undo-AzKeyVaultSecretRemoval 恢复机密。此 cmdlet 的 ConfirmImpact 属性的值很高。

示例

示例 1：从密钥保管库中删除机密

Remove-AzKeyVaultSecret -VaultName 'Contoso' -Name 'FinanceSecret' -PassThru

Vault Name           : Contoso
Name                 : FinanceSecret
Version              : f622abc7b1394092812f1eb0f85dc91c
Id                   : https://contoso.vault.azure.net:443/secrets/financesecret/f622abc7b1394092812f1eb0f85dc91c
Deleted Date         : 5/25/2018 4:45:34 PM
Scheduled Purge Date : 8/23/2018 4:45:34 PM
Enabled              : True
Expires              :
Not Before           :
Created              : 4/19/2018 5:56:02 PM
Updated              : 4/26/2018 7:48:40 PM
Content Type         :
Tags                 :

此命令从名为 Contoso 的密钥保管库中删除名为 FinanceSecret 的机密。

示例 2：在不确认用户的情况下从密钥保管库中删除机密

Remove-AzKeyVaultSecret -VaultName 'Contoso' -Name 'FinanceSecret' -PassThru -Force

Vault Name           : Contoso
Name                 : FinanceSecret
Version              : f622abc7b1394092812f1eb0f85dc91c
Id                   : https://contoso.vault.azure.net:443/secrets/financesecret/f622abc7b1394092812f1eb0f85dc91c
Deleted Date         : 5/25/2018 4:45:34 PM
Scheduled Purge Date : 8/23/2018 4:45:34 PM
Enabled              : True
Expires              :
Not Before           :
Created              : 4/19/2018 5:56:02 PM
Updated              : 4/26/2018 7:48:40 PM
Content Type         :
Tags                 :

此命令从名为 Contoso 的密钥保管库中删除名为 FinanceSecret 的机密。该命令指定 Force 和 Confirm 参数，因此 cmdlet 不会提示你进行确认。

示例 3：从密钥保管库中删除机密（使用 uri）

Remove-AzKeyVaultSecret -Id 'https://contoso.vault.azure.net:443/secrets/financesecret' -PassThru

Vault Name           : Contoso
Name                 : FinanceSecret
Version              : f622abc7b1394092812f1eb0f85dc91c
Id                   : https://contoso.vault.azure.net:443/secrets/financesecret/f622abc7b1394092812f1eb0f85dc91c
Deleted Date         : 5/25/2018 4:45:34 PM
Scheduled Purge Date : 8/23/2018 4:45:34 PM
Enabled              : True
Expires              :
Not Before           :
Created              : 4/19/2018 5:56:02 PM
Updated              : 4/26/2018 7:48:40 PM
Content Type         :
Tags                 :

此命令从名为“Contoso”的密钥保管库中删除名为“FinanceSecret”的机密。

示例 4：通过模块 Microsoft.PowerShell.SecretManagement 中的命令 Remove-Secret 删除 Azure Key Vault 中的机密

# Install module Microsoft.PowerShell.SecretManagement
Install-Module Microsoft.PowerShell.SecretManagement -Repository PSGallery -AllowPrerelease
# Register vault for Secret Management
Register-SecretVault -Name AzKeyVault -ModuleName Az.KeyVault -VaultParameters @{ AZKVaultName = 'test-kv'; SubscriptionId = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' }
# Set secret for vault AzKeyVault
$secure = ConvertTo-SecureString -String "****" -AsPlainText -Force
Set-Secret -Vault AzKeyVault -Name secureSecret -SecureStringSecret $secure 
Remove-Secret -Vault AzKeyVault -Name secureSecret

None

此示例通过模块 Microsoft.PowerShell.SecretManagement中的命令 Remove-Secret 删除 Azure Key Vault 中名为 secureSecret 的机密 test-kv。

示例 4：永久清除密钥保管库中删除的机密

Remove-AzKeyVaultSecret -VaultName 'Contoso' -Name 'FinanceSecret' -InRemovedState

此命令从名为 Contoso 的密钥保管库中删除名为 FinanceSecret 的机密。执行此 cmdlet 需要“清除”权限，该权限以前必须已显式授予此密钥保管库的用户。

参数

-Confirm

在运行 cmdlet 之前，提示你进行确认。

类型:	SwitchParameter
别名:	cf
Position:	Named
默认值:	False
必需:	False
接受管道输入:	False
接受通配符:	False

-DefaultProfile

用于与 azure 通信的凭据、帐户、租户和订阅

类型:	IAzureContextContainer
别名:	AzContext, AzureRmContext, AzureCredential
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Force

强制命令运行而不要求用户确认。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Id

KeyVault 机密的 URI。请确保它遵循以下格式：https://<vault-name>.vault.azure.net/secrets/<secret-name>/<version>

类型:	String
别名:	SecretId
Position:	0
默认值:	None
必需:	True
接受管道输入:	False
接受通配符:	False

-InputObject

Key Vault 机密对象

类型:	PSKeyVaultSecretIdentityItem
Position:	0
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-InRemovedState

如果存在，请永久删除以前删除的机密。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Name

指定机密的名称。此 cmdlet 基于此参数指定的名称、密钥保管库的名称和当前环境构造机密的完全限定域名（FQDN）。

类型:	String
别名:	SecretName
Position:	1
默认值:	None
必需:	True
接受管道输入:	False
接受通配符:	False

-PassThru

指示此 cmdlet 返回 Microsoft.Azure.Commands.KeyVault.Models.Secret 对象。默认情况下，此 cmdlet 不生成任何输出。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-VaultName

指定机密所属的密钥保管库的名称。此 cmdlet 基于此参数指定的名称和当前环境构造密钥保管库的 FQDN。

类型:	String
Position:	0
默认值:	None
必需:	True
接受管道输入:	False
接受通配符:	False

-WhatIf

显示 cmdlet 运行时会发生什么情况。 cmdlet 未运行。显示 cmdlet 运行时会发生什么情况。 cmdlet 未运行。

类型:	SwitchParameter
别名:	wi
Position:	Named
默认值:	False
必需:	False
接受管道输入:	False
接受通配符:	False

输入

PSKeyVaultSecretIdentityItem

输出

PSDeletedKeyVaultSecret

通过