Remove-AzKeyVaultKey

  • Referentie
Module:
Az.KeyVault

Hiermee verwijdert u een sleutel in een sleutelkluis.

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

De cmdlet Remove-AzKeyVaultKey verwijdert een sleutel in een sleutelkluis. Als de sleutel per ongeluk is verwijderd, kan de sleutel worden hersteld met behulp van Undo-AzKeyVaultKeyRemoval door een gebruiker met speciale 'herstelmachtigingen'. Deze cmdlet heeft een waarde van hoog voor de eigenschap ConfirmImpact .

Voorbeelden

Voorbeeld 1: Een sleutel uit een sleutelkluis verwijderen

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                 :

Met deze opdracht wordt de sleutel met de naam ITSoftware verwijderd uit de sleutelkluis met de naam Contoso.

Voorbeeld 2: Een sleutel verwijderen zonder bevestiging van de gebruiker

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

Met deze opdracht wordt de sleutel met de naam ITSoftware verwijderd uit de sleutelkluis met de naam Contoso. Met de opdracht geeft u de parameter Force op en daarom wordt u niet om bevestiging gevraagd.

Voorbeeld 3: Een verwijderde sleutel uit de sleutelkluis permanent leegmaken

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

Met deze opdracht wordt de sleutel met de naam ITSoftware definitief verwijderd uit de sleutelkluis met de naam Contoso. Voor het uitvoeren van deze cmdlet is de machtiging 'opschonen' vereist, die eerder en expliciet aan de gebruiker voor deze sleutelkluis moet zijn verleend.

Voorbeeld 4: Sleutels verwijderen met behulp van de pijplijnoperator

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

Met deze opdracht worden alle sleutels opgehaald in de sleutelkluis met de naam Contoso en doorgegeven aan de cmdlet Where-Object met behulp van de pijplijnoperator. Deze cmdlet geeft de sleutels met een waarde van $False voor het kenmerk Ingeschakeld door aan de huidige cmdlet. Met deze cmdlet worden deze sleutels verwijderd.

Parameters

-Confirm

Hiermee wordt u gevraagd om bevestiging voordat u de cmdlet uitvoert.

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

-DefaultProfile

De referenties, het account, de tenant en het abonnement dat wordt gebruikt voor communicatie met Azure

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

-Force

Hiermee dwingt u de opdracht uit te voeren zonder dat u om bevestiging van de gebruiker wordt gevraagd.

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

-HsmName

HSM-naam. Cmdlet bouwt de FQDN van een beheerde HSM op basis van de naam en momenteel geselecteerde omgeving.

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

-InputObject

KeyBundle-object

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

-InRemovedState

Verwijder de eerder verwijderde sleutel definitief.

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

-Name

Hiermee geeft u de naam van de sleutel die moet worden verwijderd. Met deze cmdlet wordt de FQDN (Fully Qualified Domain Name) van een sleutel samengesteld op basis van de naam die met deze parameter wordt opgegeven, de naam van de sleutelkluis en uw huidige omgeving.

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

-PassThru

Geeft aan dat deze cmdlet een Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKey-object retourneert. Deze cmdlet genereert standaard geen uitvoer.

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

-VaultName

Hiermee geeft u de naam van de sleutelkluis waaruit u de sleutel wilt verwijderen. Met deze cmdlet wordt de FQDN van een sleutelkluis samengesteld op basis van de naam die met deze parameter wordt opgegeven en uw huidige omgeving.

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

-WhatIf

Hiermee wordt weergegeven wat er zou gebeuren als u de cmdlet uitvoert. De cmdlet wordt niet uitgevoerd. Toont wat er zou gebeuren als de cmdlet wordt uitgevoerd. De cmdlet wordt niet uitgevoerd.

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

Invoerwaarden

PSKeyVaultKeyIdentityItem

Uitvoerwaarden

PSDeletedKeyVaultKey