Remove-AzureKeyVaultKey

Referenz

Modul:: AzureRM.KeyVault

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

Warnung

Das AzureRM PowerShell-Modul ist seit dem 29. Februar 2024 offiziell veraltet. Benutzern wird empfohlen, von AzureRM zum Az PowerShell-Modul zu migrieren, um weiterhin Support und Updates zu erhalten.

Obwohl das AzureRM-Modul weiterhin funktioniert, wird es nicht mehr Standard tained oder unterstützt, wobei eine fortgesetzte Verwendung nach Ermessen und Risiko des Benutzers erfolgt. Weitere Informationen zum Übergang zum Az-Modul finden Sie in unseren Migrationsressourcen.

Syntax

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

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

Beschreibung

Das Cmdlet Remove-AzureKeyVaultKey löscht einen Schlüssel in einem Schlüsseltresor. Wenn der Schlüssel versehentlich gelöscht wurde, kann der Schlüssel mithilfe von Undo-AzureKeyVaultKeyRemoval 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

PS C:\> Remove-AzureKeyVaultKey -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

PS C:\> Remove-AzureKeyVaultKey -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

PS C:\> Remove-AzureKeyVaultKey -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

PS C:\> Get-AzureKeyVaultKey -VaultName 'Contoso' | Where-Object {$_.Attributes.Enabled -eq $False} | Remove-AzureKeyVaultKey

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.

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

-DefaultProfile

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

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

-Force

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
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

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

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

-Name

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

Type:	String
Aliases:	KeyName
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	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.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	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.

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	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.

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

Eingaben

PSKeyVaultKeyIdentityItem

Parameter: InputObject (ByValue)

Ausgaben

PSDeletedKeyVaultKey