Sdílet prostřednictvím

Remove-AzKeyVault

  • Reference
Modul:
Az.KeyVault

Odstraní trezor klíčů.

Syntaxe

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

Description

Rutina Remove-AzKeyVault odstraní zadaný trezor klíčů. Odstraní také všechny klíče a tajné kódy obsažené v této instanci. Všimněte si, že i když je pro tuto rutinu zadání skupiny prostředků volitelné, měli byste zajistit lepší výkon.

Příklady

Příklad 1: Odebrání trezoru klíčů

Remove-AzKeyVault -VaultName "Contoso03Vault" -PassThru

True

Tento příkaz odebere trezor klíčů s názvem Contoso03Vault z vašeho aktuálního předplatného.

Příklad 2: Odebrání trezoru klíčů ze zadané skupiny prostředků

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

True

Tento příkaz odebere trezor klíčů Contoso03Vault z pojmenované skupiny prostředků. Pokud nezadáte název skupiny prostředků, rutina vyhledá pojmenovaný trezor klíčů, který se má odstranit ve vašem aktuálním předplatném.

Parametry

-AsJob

Spuštění rutiny na pozadí

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Confirm

Před spuštěním rutiny zobrazí výzvu k potvrzení.

Typ:SwitchParameter
Aliasy:cf
Position:Named
Default value:False
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-DefaultProfile

Přihlašovací údaje, účet, tenant a předplatné používané ke komunikaci s Azure

Typ:IAzureContextContainer
Aliasy:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Force

Označuje, že rutina nezobrazí výzvu k potvrzení. Ve výchozím nastavení vás tato rutina vyzve k potvrzení, že chcete trezor klíčů odstranit.

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-InputObject

Objekt služby Key Vault, který se má odstranit.

Typ:PSKeyVault
Position:0
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-InRemovedState

Odeberte dříve odstraněný trezor trvale.

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Location

Umístění odstraněného trezoru.

Typ:String
Position:2
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-PassThru

Tato rutina ve výchozím nastavení nevrací objekt. Pokud je tento přepínač zadán, vrátí hodnotu true, pokud je úspěšný.

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-ResourceGroupName

Určuje název skupiny prostředků.

Typ:String
Position:1
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-ResourceId

ID prostředku služby KeyVault

Typ:String
Position:0
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-SubscriptionId

ID předplatného. Ve výchozím nastavení se rutiny spouští v předplatném, které je nastavené v aktuálním kontextu. Pokud uživatel určí jiné předplatné, spustí se aktuální rutina v předplatném určeném uživatelem. Přepsání předplatných se projeví jenom během životního cyklu aktuální rutiny. Nezmění předplatné v kontextu a nemá vliv na následné rutiny.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-VaultName

Určuje název trezoru klíčů, který se má odebrat.

Typ:String
Aliasy:Name
Position:0
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-WhatIf

Zobrazuje, co by se stalo při spuštění rutiny. Rutina se nespustí. Ukazuje, co se stane, když se rutina spustí. Rutina není spuštěna.

Typ:SwitchParameter
Aliasy:wi
Position:Named
Default value:False
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

Vstupy

PSKeyVault

String

Výstupy

Boolean