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

Remove-AzKeyVaultKey

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

注意

这是我们文档的早期版本。 有关最新信息 ,请参阅最新版本

语法

Remove-AzKeyVaultKey
      [-VaultName] <String>
      [-Name] <String>
      [-Force]
      [-PassThru]
      [-InRemovedState]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzKeyVaultKey
      -HsmName <String>
      [-Name] <String>
      [-Force]
      [-PassThru]
      [-InRemovedState]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzKeyVaultKey
      [-InputObject] <PSKeyVaultKeyIdentityItem>
      [-Force]
      [-PassThru]
      [-InRemovedState]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

说明

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

示例

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

Remove-AzKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -PassThru

Vault Name           : contoso
Name                 : key2
Id                   : https://contoso.vault.azure.net:443/keys/itsoftware/fdad15793ba0437e960497908ef9eb32
Deleted Date         : 5/24/2018 11:28:25 PM
Scheduled Purge Date : 8/22/2018 11:28:25 PM
Enabled              : False
Expires              : 10/11/2018 11:32:49 PM
Not Before           : 4/11/2018 11:22:49 PM
Created              : 4/12/2018 10:16:38 PM
Updated              : 4/12/2018 10:16:38 PM
Purge Disabled       : False
Tags                 :

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

示例 2:在不确认用户的情况下删除密钥

Remove-AzKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -Force

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

示例 3:从密钥保管库中永久清除已删除的密钥

Remove-AzKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -InRemovedState

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

示例 4:使用管道运算符删除密钥

Get-AzKeyVaultKey -VaultName 'Contoso' | Where-Object {$_.Attributes.Enabled -eq $False} | Remove-AzKeyVaultKey

此命令获取名为 Contoso 的密钥保管库中的所有密钥,并使用管道运算符将它们传递给 Where-Object cmdlet。 该 cmdlet 会将 为 Enabled 属性的值$False的键传递给当前 cmdlet。 该 cmdlet 会删除这些密钥。

参数

-Confirm

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

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

-DefaultProfile

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

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

-Force

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

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

-HsmName

HSM 名称。 Cmdlet 基于名称和当前选定的环境构造托管 HSM 的 FQDN。

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

-InputObject

KeyBundle 对象

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

-InRemovedState

永久删除以前删除的密钥。

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

-Name

指定要删除的键名。 此 cmdlet 基于此参数指定的名称、密钥保管库名称和当前环境,构造密钥的完全限定域名 (FQDN) 。

Type:String
Aliases:KeyName
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

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

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

-VaultName

指定要从中删除密钥的密钥保管库的名称。 此 cmdlet 基于此参数指定的名称和当前环境构造密钥保管库的 FQDN。

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

-WhatIf

显示在此 cmdlet 运行的情况下将会发生什么。 cmdlet 未运行。显示 cmdlet 运行时会发生什么情况。 此 cmdlet 未运行。

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

输入

PSKeyVaultKeyIdentityItem

输出

PSDeletedKeyVaultKey