Remove-AzureKeyVaultSecret

Reference

Modul:: AzureRM.KeyVault

Odstraní tajný klíč v trezoru klíčů.

Upozorňující

Modul AzureRM PowerShell byl od 29. února 2024 oficiálně zastaralý. Uživatelům se doporučuje migrovat z AzureRM do modulu Az PowerShell, aby se zajistila nepřetržitá podpora a aktualizace.

I když může modul AzureRM stále fungovat, už se neudržuje ani nepodporuje, přičemž jakékoli další použití se bude umisťovat podle vlastního uvážení a rizika uživatele. Pokyny k přechodu na modul Az najdete v našich zdrojích informací o migraci.

Syntax

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

Remove-AzureKeyVaultSecret
      [-InputObject] <PSKeyVaultSecretIdentityItem>
      [-Force]
      [-PassThru]
      [-InRemovedState]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Rutina Remove-AzureKeyVaultSecret odstraní tajný kód v trezoru klíčů. Pokud byl tajný klíč omylem odstraněn, můžete ho obnovit pomocí příkazu Undo-AzureKeyVaultSecretRemoval uživatelem se speciálními oprávněními k obnovení. Tato rutina má hodnotu vysoké pro ConfirmImpact vlastnost.

Příklady

Příklad 1: Odebrání tajného klíče z trezoru klíčů

PS C:\> Remove-AzureKeyVaultSecret -VaultName 'Contoso' -Name 'FinanceSecret' -PassThru

Vault Name           : Contoso
Name                 : FinanceSecret
Version              : f622abc7b1394092812f1eb0f85dc91c
Id                   : https://contoso.vault.azure.net:443/secrets/financesecret/f622abc7b1394092812f1eb0f85dc91c
Deleted Date         : 5/25/2018 4:45:34 PM
Scheduled Purge Date : 8/23/2018 4:45:34 PM
Enabled              : True
Expires              :
Not Before           :
Created              : 4/19/2018 5:56:02 PM
Updated              : 4/26/2018 7:48:40 PM
Content Type         :
Tags                 :

Tento příkaz odebere tajný kód s názvem FinanceSecret z trezoru klíčů s názvem Contoso.

Příklad 2: Odebrání tajného klíče z trezoru klíčů bez potvrzení uživatele

PS C:\> Remove-AzureKeyVaultSecret -VaultName 'Contoso' -Name 'FinanceSecret' -PassThru -Force

Vault Name           : Contoso
Name                 : FinanceSecret
Version              : f622abc7b1394092812f1eb0f85dc91c
Id                   : https://contoso.vault.azure.net:443/secrets/financesecret/f622abc7b1394092812f1eb0f85dc91c
Deleted Date         : 5/25/2018 4:45:34 PM
Scheduled Purge Date : 8/23/2018 4:45:34 PM
Enabled              : True
Expires              :
Not Before           :
Created              : 4/19/2018 5:56:02 PM
Updated              : 4/26/2018 7:48:40 PM
Content Type         :
Tags                 :

Tento příkaz odebere tajný kód s názvem FinanceSecret z trezoru klíčů s názvem Contoso. Příkaz určuje parametry Force a Confirm , a proto rutina nezobrazí výzvu k potvrzení.

Příklad 3: Trvalé vymazání odstraněného tajného klíče z trezoru klíčů

PS C:\> Remove-AzureKeyVaultSecret -VaultName 'Contoso' -Name 'FinanceSecret' -InRemovedState

Tento příkaz předmosí tajný kód s názvem FinanceSecret z trezoru klíčů s názvem Contoso trvale. Spuštění této rutiny vyžaduje oprávnění "vyprázdnit", které bylo dříve a explicitně uděleno uživateli pro tento trezor klíčů.

Parametry

-Confirm

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

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

-DefaultProfile

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

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

-Force

Vynutí spuštění příkazu bez výzvy k potvrzení uživatele.

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

-InputObject

Tajný objekt služby Key Vault

Type:	PSKeyVaultSecretIdentityItem
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-InRemovedState

Pokud je k dispozici, odebere dříve odstraněný tajný kód trvale.

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

-Name

Určuje název tajného kódu. Tato rutina vytvoří plně kvalifikovaný název domény (FQDN) tajného kódu na základě názvu, který tento parametr určuje, název trezoru klíčů a aktuální prostředí.

Type:	String
Aliases:	SecretName
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-PassThru

Označuje, že tato rutina vrací objekt Microsoft.Azure.Commands.KeyVault.Models.Secret . Ve výchozím nastavení tato rutina negeneruje žádný výstup.

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

-VaultName

Určuje název trezoru klíčů, do kterého tajný klíč patří. Tato rutina vytvoří plně kvalifikovaný název domény trezoru klíčů na základě názvu, který tento parametr určuje a vaše aktuální prostředí.

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

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

Vstupy

PSKeyVaultSecretIdentityItem

Parametry: InputObject (ByValue)

Výstupy

PSDeletedKeyVaultSecret