Delen via

Remove-AzKeyVaultKey

Module:
Az.KeyVault Module

Hiermee verwijdert u een sleutel in een sleutelkluis.

Syntax

ByVaultName (Standaard) 

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

HsmByVaultName 

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

ByInputObject 

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

Description

Met de Remove-AzKeyVaultKey cmdlet wordt een sleutel in een sleutelkluis verwijderd. 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

Voordat u de cmdlet uitvoert, vraagt het systeem om bevestiging.

Parametereigenschappen

Type:SwitchParameter
Default value:False
Ondersteunt jokertekens:False
DontShow:False
Aliassen:Cf

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-DefaultProfile

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

Parametereigenschappen

Type:IAzureContextContainer
Default value:None
Ondersteunt jokertekens:False
DontShow:False
Aliassen:AzContext, AzureRmContext, AzureCredential

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Force

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

Parametereigenschappen

Type:SwitchParameter
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-HsmName

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

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

HsmByVaultName
Position:Named
Verplicht:True
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-InputObject

KeyBundle-object

Parametereigenschappen

Type:PSKeyVaultKeyIdentityItem
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

ByInputObject
Position:0
Verplicht:True
Waarde uit pijplijn:True
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-InRemovedState

Verwijder de eerder verwijderde sleutel definitief.

Parametereigenschappen

Type:SwitchParameter
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten: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.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False
Aliassen:Sleutelnaam

Parametersets

ByVaultName
Position:1
Verplicht:True
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False
HsmByVaultName
Position:1
Verplicht:True
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-PassThru

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

Parametereigenschappen

Type:SwitchParameter
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten: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.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

ByVaultName
Position:0
Verplicht:True
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-WhatIf

Toont wat er zou gebeuren wanneer de cmdlet wordt uitgevoerd. De cmdlet wordt niet uitgevoerd. Toont wat er zou gebeuren als de cmdlet wordt uitgevoerd. De cmdlet wordt niet uitgevoerd.

Parametereigenschappen

Type:SwitchParameter
Default value:False
Ondersteunt jokertekens:False
DontShow:False
Aliassen:Wi

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

CommonParameters

Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.

Invoerwaarden

PSKeyVaultKeyIdentityItem

Uitvoerwaarden

PSDeletedKeyVaultKey