Remove-AzKeyVaultKey

  • 參考
模組:
Az.KeyVault

刪除金鑰保存庫中的金鑰。

Syntax

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>]

Description

Remove-AzKeyVaultKey Cmdlet 會刪除密鑰保存庫中的密鑰。 如果意外刪除密鑰，則具有特殊「復原」許可權的使用者可以使用 Undo-AzKeyVaultKeyRemoval 來復原密鑰。 此 Cmdlet 的 ConfirmImpact 屬性值很高。

範例

範例 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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

用於與 azure 通訊的認證、帳戶、租用戶和訂用帳戶

Type:IAzureContextContainer
Aliases:AzContext, 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

-HsmName

HSM 名稱。 Cmdlet 會根據名稱和目前選取的環境，建構受控 HSM 的 FQDN。

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

-InputObject

KeyBundle 物件

Type:PSKeyVaultKeyIdentityItem
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:KeyName
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

指出此 Cmdlet 會 傳回 Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKey 物件。 根據預設，此 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

輸入

PSKeyVaultKeyIdentityItem

輸出

PSDeletedKeyVaultKey