Remove-AzKeyVaultKey

  • Riferimento
Modulo:
Az.KeyVault

Elimina una chiave in un insieme di credenziali delle chiavi.

Sintassi

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

Descrizione

Il cmdlet Remove-AzKeyVaultKey elimina una chiave in un insieme di credenziali delle chiavi. Se la chiave è stata eliminata accidentalmente, è possibile recuperare la chiave usando Undo-AzKeyVaultKeyRemoval da un utente con autorizzazioni speciali di ripristino. Questo cmdlet ha un valore elevato per la proprietà ConfirmImpact .

Esempio

Esempio 1: Rimuovere una chiave da un insieme di credenziali delle chiavi

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                 :

Questo comando rimuove la chiave denominata ITSoftware dall'insieme di credenziali delle chiavi denominato Contoso.

Esempio 2: Rimuovere una chiave senza conferma dell'utente

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

Questo comando rimuove la chiave denominata ITSoftware dall'insieme di credenziali delle chiavi denominato Contoso. Il comando specifica il parametro Force e, di conseguenza, il cmdlet non richiede la conferma.

Esempio 3: Eliminare definitivamente una chiave eliminata dall'insieme di credenziali delle chiavi

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

Questo comando rimuove definitivamente la chiave denominata ITSoftware dall'insieme di credenziali delle chiavi denominato Contoso. L'esecuzione di questo cmdlet richiede l'autorizzazione "ripulitura", che deve essere stata concessa in precedenza e concessa in modo esplicito all'utente per questo insieme di credenziali delle chiavi.

Esempio 4: Rimuovere le chiavi usando l'operatore pipeline

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

Questo comando ottiene tutte le chiavi nell'insieme di credenziali delle chiavi denominato Contoso e le passa al cmdlet Where-Object usando l'operatore pipeline. Tale cmdlet passa le chiavi con valore $False per l'attributo Enabled al cmdlet corrente. Questo cmdlet rimuove tali chiavi.

Parametri

-Confirm

Richiede conferma prima di eseguire il cmdlet.

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

-DefaultProfile

Credenziali, account, tenant e sottoscrizione usati per la comunicazione con Azure

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

-Force

Forza l'esecuzione del comando senza chiedere conferma all'utente.

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

-HsmName

Nome HSM. Il cmdlet costruisce il nome di dominio completo di un modulo di protezione hardware gestito in base al nome e all'ambiente attualmente selezionato.

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

-InputObject

Oggetto KeyBundle

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

-InRemovedState

Rimuovere definitivamente la chiave eliminata in precedenza.

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

-Name

Specifica il nome della chiave da rimuovere. Questo cmdlet costruisce il nome di dominio completo (FQDN) di una chiave in base al nome specificato da questo parametro, al nome dell'insieme di credenziali delle chiavi e all'ambiente corrente.

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

-PassThru

Indica che questo cmdlet restituisce un oggetto Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKey . Per impostazione predefinita, il cmdlet non genera alcun output.

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

-VaultName

Specifica il nome dell'insieme di credenziali delle chiavi da cui rimuovere la chiave. Questo cmdlet costruisce il nome di dominio completo di un insieme di credenziali delle chiavi in base al nome specificato da questo parametro e all'ambiente corrente.

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

-WhatIf

Mostra gli effetti dell'esecuzione del cmdlet. Il cmdlet non viene eseguito. Mostra cosa accadrebbe se il cmdlet viene eseguito. Il cmdlet non viene eseguito.

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

Input

PSKeyVaultKeyIdentityItem

Output

PSDeletedKeyVaultKey