Remove-AzKeyVaultKey

  • Reference
Modul:
Az.KeyVault

Odstraní klíč v trezoru klíčů.

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

Rutina Remove-AzKeyVaultKey odstraní klíč v trezoru klíčů. Pokud byl klíč omylem odstraněn, můžete klíč obnovit pomocí příkazu Undo-AzKeyVaultKeyRemoval uživatelem se speciálními oprávněními k obnovení. Tato rutina má hodnotu vysoké pro ConfirmImpact vlastnost.

Příklady

Příklad 1: Odebrání klíče z trezoru klíčů

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                 :

Tento příkaz odebere klíč s názvem ITSoftware z trezoru klíčů s názvem Contoso.

Příklad 2: Odebrání klíče bez potvrzení uživatele

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

Tento příkaz odebere klíč s názvem ITSoftware z trezoru klíčů s názvem Contoso. Příkaz určuje parametr Force , a proto rutina nezobrazí výzvu k potvrzení.

Příklad 3: Trvalé vymazání odstraněného klíče z trezoru klíčů

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

Tento příkaz odebere klíč s názvem ITSoftware z trezoru klíčů s názvem Contoso trvale. Spuštění této rutiny vyžaduje oprávnění "vyprázdnit", které bylo dříve a explicitně uděleno uživateli pro tento trezor klíčů.

Příklad 4: Odebrání klíčů pomocí operátoru kanálu

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

Tento příkaz získá všechny klíče v trezoru klíčů s názvem Contoso a předá je rutině Where-Object pomocí operátoru kanálu. Tato rutina předává klíče, které mají hodnotu $False pro atribut Enabled do aktuální rutiny. Tato rutina tyto klíče odebere.

Parametry

-Confirm

Před spuštěním rutiny zobrazí výzvu k potvrzení.

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

-DefaultProfile

Přihlašovací údaje, účet, tenant a předplatné používané ke komunikaci s Azure

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

-Force

Vynutí spuštění příkazu bez výzvy k potvrzení uživatele.

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

-HsmName

Název HSM. Rutina vytvoří plně kvalifikovaný název domény spravovaného HSM na základě názvu a aktuálně vybraného prostředí.

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

-InputObject

KeyBundle – objekt

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

-InRemovedState

Trvale odeberte dříve odstraněný klíč.

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

-Name

Určuje název klíče, který se má odebrat. Tato rutina vytvoří plně kvalifikovaný název domény (FQDN) klíče na základě názvu, který tento parametr určuje, název trezoru klíčů a aktuální prostředí.

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

-PassThru

Označuje, že tato rutina vrací objekt Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKey . Ve výchozím nastavení tato rutina negeneruje žádný výstup.

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

-VaultName

Určuje název trezoru klíčů, ze kterého se má klíč odebrat. Tato rutina vytvoří plně kvalifikovaný název domény trezoru klíčů na základě názvu, který tento parametr určuje a vaše aktuální prostředí.

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

-WhatIf

Zobrazuje, co by se stalo při spuštění rutiny. Rutina se nespustí. Ukazuje, co se stane, když se rutina spustí. Rutina není spuštěna.

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

Vstupy

PSKeyVaultKeyIdentityItem

Výstupy

PSDeletedKeyVaultKey