Remove-AzKeyVaultManagedHsm

  • Referenz
Modul:
Az.KeyVault

Löscht/löscht ein verwaltetes HSM.

Syntax

Remove-AzKeyVaultManagedHsm
      [-Name] <String>
      [[-ResourceGroupName] <String>]
      [-Force]
      [-AsJob]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-SubscriptionId <String>]
      [<CommonParameters>]
Remove-AzKeyVaultManagedHsm
      [-Name] <String>
      [-Location] <String>
      [-InRemovedState]
      [-Force]
      [-AsJob]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-SubscriptionId <String>]
      [<CommonParameters>]
Remove-AzKeyVaultManagedHsm
      [-InputObject] <PSManagedHsm>
      [-Force]
      [-AsJob]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-SubscriptionId <String>]
      [<CommonParameters>]
Remove-AzKeyVaultManagedHsm
      [-InputObject] <PSManagedHsm>
      [-InRemovedState]
      [-Force]
      [-AsJob]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-SubscriptionId <String>]
      [<CommonParameters>]
Remove-AzKeyVaultManagedHsm
      [-ResourceId] <String>
      [-Force]
      [-AsJob]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-SubscriptionId <String>]
      [<CommonParameters>]
Remove-AzKeyVaultManagedHsm
      [-ResourceId] <String>
      [-Location] <String>
      [-InRemovedState]
      [-Force]
      [-AsJob]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-SubscriptionId <String>]
      [<CommonParameters>]

Beschreibung

Das Cmdlet Remove-AzKeyVaultManagedHsm löscht das angegebene verwaltete HSM. Außerdem werden alle in dieser Instanz enthaltenen Schlüssel gelöscht. Beachten Sie, dass die Angabe der Ressourcengruppe für dieses Cmdlet optional ist, sollten Sie dies für eine bessere Leistung verwenden.

Beispiele

Beispiel 1: Entfernen eines verwalteten HSM

Remove-AzKeyVaultManagedHsm -HsmName 'myhsm' -Force

True

Mit diesem Befehl wird das verwaltete HSM mit dem Namen "myhsm" aus Ihrem aktuellen Abonnement entfernt.

Beispiel 2: Entfernen eines verwalteten Hsm aus einer angegebenen Ressourcengruppe

Remove-AzKeyVaultManagedHsm -HsmName 'myhsm' -ResourceGroupName "myrg1" -PassThru

True

Mit diesem Befehl wird das verwaltete HSM mit dem Namen "myhsm" aus der Ressourcengruppe "myrg1" entfernt. Wenn Sie den Ressourcengruppennamen nicht angeben, sucht das Cmdlet nach dem benannten verwalteten HSM, um es in Ihrem aktuellen Abonnement zu löschen.

Beispiel 3: Löschen eines gelöschten verwalteten hsm

Remove-AzKeyVaultManagedHsm -Name 'myhsm' -Location "eastus" -Force -PassThru

True

Dieser Befehl löscht das verwaltete HSM mit dem Namen myhsm, der sich am Eastus befindet.

Parameter

-AsJob

Cmdlet im Hintergrund ausführen

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

-Confirm

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

Typ:SwitchParameter
Aliase:cf
Position:Named
Standardwert:None
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

Gibt an, dass das Cmdlet Sie nicht zur Bestätigung auffordert. Dieses Cmdlet fordert Sie standardmäßig auf, zu bestätigen, dass Sie das verwaltete HSM löschen möchten.

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

-InputObject

Verwaltetes HSM-Objekt, das gelöscht werden soll.

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

-InRemovedState

Entfernen Sie den zuvor gelöschten verwalteten HSM-Pool dauerhaft.

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

-Location

Der Speicherort des gelöschten verwalteten HSM-Pools.

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

-Name

Gibt den Namen des zu entfernenden verwalteten HSM an.

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

-PassThru

Dieses Cmdlet gibt standardmäßig kein Objekt zurück. Wenn diese Option angegeben ist, wird "true" zurückgegeben, wenn die Option erfolgreich verläuft.

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

-ResourceGroupName

Gibt den Namen der Ressourcengruppe für das zu entfernende azure managed HSM an.

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

-ResourceId

ManagedHsm-Ressourcen-ID.

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

-SubscriptionId

Die ID des Abonnements. Standardmäßig werden Cmdlets im Abonnement ausgeführt, das im aktuellen Kontext festgelegt ist. Wenn der Benutzer ein anderes Abonnement angibt, wird das aktuelle Cmdlet im vom Benutzer angegebenen Abonnement ausgeführt. Das Überschreiben von Abonnements wird nur während des Lebenszyklus des aktuellen Cmdlets wirksam. Sie ändert das Abonnement nicht im Kontext und wirkt sich nicht auf nachfolgende Cmdlets aus.

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

-WhatIf

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

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

Eingaben

PSManagedHsm

String

Ausgaben

Boolean