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

Remove-AzureKeyVaultSecret

参考

模块:: AzureRM.KeyVault

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

警告

截至 2024 年 2 月 29 日，AzureRM PowerShell 模块已正式弃用。为了确保持续获得支持和更新，建议用户从 AzureRM 迁移到 Az PowerShell 模块。

尽管 AzureRM 模块仍可能正常运行，但它不再维护或受支持，但会根据用户的自由裁量权和风险继续使用任何继续使用模块。有关过渡到 Az 模块的指导，请参阅我们的迁移资源。

语法

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

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

说明

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

示例

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

PS C:\> Remove-AzureKeyVaultSecret -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：在不确认用户的情况下从密钥保管库中删除机密

PS C:\> Remove-AzureKeyVaultSecret -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：永久清除密钥保管库中删除的机密

PS C:\> Remove-AzureKeyVaultSecret -VaultName 'Contoso' -Name 'FinanceSecret' -InRemovedState

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

参数

-Confirm

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

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

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

Type:	IAzureContextContainer
Aliases:	AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

密钥库机密对象

Type:	PSKeyVaultSecretIdentityItem
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-InRemovedState

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

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

Type:	String
Aliases:	SecretName
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-PassThru

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-VaultName

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

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

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

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

输入

PSKeyVaultSecretIdentityItem

参数：InputObject （ByValue）

输出

PSDeletedKeyVaultSecret