Freigeben über

Remove-AzKeyVaultKey

  • Referenz
Modul:
Az.KeyVault

Löscht einen Schlüssel in einem Schlüsseltresor.

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

Beschreibung

Das Cmdlet Remove-AzKeyVaultKey löscht einen Schlüssel in einem Schlüsseltresor. Wenn der Schlüssel versehentlich gelöscht wurde, kann der Schlüssel mithilfe von "Undo-AzKeyVaultKeyRemoval" von einem Benutzer mit speziellen "Wiederherstellen"-Berechtigungen wiederhergestellt werden. Dieses Cmdlet hat einen Wert mit hohem Wert für die ConfirmImpact-Eigenschaft .

Beispiele

Beispiel 1: Entfernen eines Schlüssels aus einem Schlüsseltresor

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                 :

Mit diesem Befehl wird der Schlüssel "ITSoftware" aus dem Schlüsseltresor "Contoso" entfernt.

Beispiel 2: Entfernen eines Schlüssels ohne Benutzerbestätigung

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

Mit diesem Befehl wird der Schlüssel "ITSoftware" aus dem Schlüsseltresor "Contoso" entfernt. Der Befehl gibt den Parameter Force an, und daher werden Sie vom Cmdlet nicht zur Bestätigung aufgefordert.

Beispiel 3: Löschen eines gelöschten Schlüssels aus dem Schlüsseltresor dauerhaft

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

Mit diesem Befehl wird der Schlüssel "ITSoftware" dauerhaft aus dem Schlüsseltresor "Contoso" entfernt. Zum Ausführen dieses Cmdlets ist die Berechtigung "Löschen" erforderlich, die dem Benutzer zuvor und explizit für diesen Schlüsseltresor erteilt worden sein muss.

Beispiel 4: Entfernen von Schlüsseln mithilfe des Pipelineoperators

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

Dieser Befehl ruft alle Schlüssel im Schlüsseltresor namens Contoso ab und übergibt sie mithilfe des Pipelineoperators an das Cmdlet Where-Object . Dieses Cmdlet übergibt die Schlüssel mit dem Wert $False für das Attribut "Enabled " an das aktuelle Cmdlet. Mit diesem Cmdlet werden diese Schlüssel entfernt.

Parameter

-Confirm

Hiermit werden Sie vor der Ausführung des Cmdlets zur Bestätigung aufgefordert.

Typ:SwitchParameter
Aliase:cf
Position:Named
Standardwert:False
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-DefaultProfile

Anmeldeinformationen, Konto, Mandant und Abonnement für die Kommunikation mit Azure

Typ:IAzureContextContainer
Aliase:AzContext, AzureRmContext, AzureCredential
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Force

Erzwingt die Ausführung des Befehls ohne Aufforderung zur Bestätigung durch den Benutzer.

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-HsmName

HSM-Name. Cmdlet erstellt den FQDN eines verwalteten HSM basierend auf dem Namen und der aktuell ausgewählten Umgebung.

Typ:String
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-InputObject

KeyBundle-Objekt

Typ:PSKeyVaultKeyIdentityItem
Position:0
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-InRemovedState

Entfernen Sie den zuvor gelöschten Schlüssel dauerhaft.

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Name

Gibt den Namen des zu entfernenden Schlüssels an. Dieses Cmdlet erstellt den vollqualifizierten Domänennamen (FQDN) eines Schlüssels basierend auf dem Namen, den dieser Parameter angibt, den Namen des Schlüsseltresors und die aktuelle Umgebung.

Typ:String
Aliase:KeyName
Position:1
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-PassThru

Gibt an, dass dieses Cmdlet ein Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKey -Objekt zurückgibt. Standardmäßig wird von diesem Cmdlet keine Ausgabe generiert.

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-VaultName

Gibt den Namen des Schlüsseltresors an, aus dem der Schlüssel entfernt werden soll. Dieses Cmdlet erstellt den FQDN eines Schlüsseltresors basierend auf dem Namen, den dieser Parameter angibt, und Die aktuelle Umgebung.

Typ:String
Position:0
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-WhatIf

Zeigt, was geschieht, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt. Zeigt, was passiert, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Typ:SwitchParameter
Aliase:wi
Position:Named
Standardwert:False
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

Eingaben

PSKeyVaultKeyIdentityItem

Ausgaben

PSDeletedKeyVaultKey