Freigeben über


Remove-AzKeyVault

Löscht einen Schlüsseltresor.

Syntax

ByAvailableVault (Standard)

Remove-AzKeyVault
    [-VaultName] <String>
    [[-ResourceGroupName] <String>]
    [[-Location] <String>]
    [-Force]
    [-AsJob]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-SubscriptionId <String>]
    [<CommonParameters>]

ByDeletedVault

Remove-AzKeyVault
    [-VaultName] <String>
    [-Location] <String>
    [-InRemovedState]
    [-Force]
    [-AsJob]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-SubscriptionId <String>]
    [<CommonParameters>]

InputObjectByAvailableVault

Remove-AzKeyVault
    [-InputObject] <PSKeyVault>
    [-Force]
    [-AsJob]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-SubscriptionId <String>]
    [<CommonParameters>]

InputObjectByDeletedVault

Remove-AzKeyVault
    [-InputObject] <PSKeyVault>
    [-InRemovedState]
    [-Force]
    [-AsJob]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-SubscriptionId <String>]
    [<CommonParameters>]

ResourceIdByAvailableVault

Remove-AzKeyVault
    [-ResourceId] <String>
    [[-Location] <String>]
    [-Force]
    [-AsJob]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-SubscriptionId <String>]
    [<CommonParameters>]

ResourceIdByDeletedVault

Remove-AzKeyVault
    [-ResourceId] <String>
    [-Location] <String>
    [-InRemovedState]
    [-Force]
    [-AsJob]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-SubscriptionId <String>]
    [<CommonParameters>]

Beschreibung

Das Cmdlet Remove-AzKeyVault löscht den angegebenen Schlüsseltresor. Außerdem werden alle schlüssel und geheimen Schlüssel gelöscht, die in dieser Instanz enthalten sind. 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 Schlüsseltresors

Remove-AzKeyVault -VaultName "Contoso03Vault" -PassThru
True

Mit diesem Befehl wird der Schlüsseltresor "Contoso03Vault" aus Ihrem aktuellen Abonnement entfernt.

Beispiel 2: Entfernen eines Schlüsseltresors aus einer angegebenen Ressourcengruppe

Remove-AzKeyVault -Name "Contoso03Vault" -ResourceGroupName "Group14" -PassThru
True

Mit diesem Befehl wird der Schlüsseltresor "Contoso03Vault" aus der benannten Ressourcengruppe entfernt. Wenn Sie den Ressourcengruppennamen nicht angeben, sucht das Cmdlet nach dem benannten Schlüsseltresor, um ihn in Ihrem aktuellen Abonnement zu löschen.

Parameter

-AsJob

Cmdlet im Hintergrund ausführen

Parametereigenschaften

Typ:SwitchParameter
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Confirm

Fordert Sie zur Bestätigung auf, bevor Sie das Cmdlet ausführen.

Parametereigenschaften

Typ:SwitchParameter
Standardwert:False
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:vgl

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-DefaultProfile

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

Parametereigenschaften

Typ:IAzureContextContainer
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:AzContext, AzureRmContext, AzureCredential

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten: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 den Schlüsseltresor löschen möchten.

Parametereigenschaften

Typ:SwitchParameter
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-InputObject

Key Vault-Objekt, das gelöscht werden soll.

Parametereigenschaften

Typ:PSKeyVault
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

InputObjectByAvailableVault
Position:0
Obligatorisch:True
Wert aus Pipeline:True
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False
InputObjectByDeletedVault
Position:0
Obligatorisch:True
Wert aus Pipeline:True
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-InRemovedState

Entfernen Sie den zuvor gelöschten Tresor dauerhaft.

Parametereigenschaften

Typ:SwitchParameter
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

ByDeletedVault
Position:Named
Obligatorisch:True
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False
InputObjectByDeletedVault
Position:Named
Obligatorisch:True
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False
ResourceIdByDeletedVault
Position:Named
Obligatorisch:True
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Location

Der Speicherort des gelöschten Tresors.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

ByAvailableVault
Position:2
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False
ResourceIdByAvailableVault
Position:2
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten: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.

Parametereigenschaften

Typ:SwitchParameter
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-ResourceGroupName

Gibt den Namen einer Ressourcengruppe an.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

ByAvailableVault
Position:1
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-ResourceId

KeyVault-Ressourcen-ID.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

ResourceIdByAvailableVault
Position:0
Obligatorisch:True
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False
ResourceIdByDeletedVault
Position:0
Obligatorisch:True
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten: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.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

-VaultName

Gibt den Namen des zu entfernenden Schlüsseltresors an.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:Name

Parametersätze

ByAvailableVault
Position:0
Obligatorisch:True
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False
ByDeletedVault
Position:0
Obligatorisch:True
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-WhatIf

Zeigt, was passiert, 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.

Parametereigenschaften

Typ:SwitchParameter
Standardwert:False
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:Wi

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

CommonParameters

Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.

Eingaben

PSKeyVault

String

Ausgaben

Boolean