Sdílet prostřednictvím

Remove-AzKeyVaultSecret

  • Reference
Modul:
Az.KeyVault

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

Syntaxe

Remove-AzKeyVaultSecret
      [-VaultName] <String>
      [-Name] <String>
      [-Force]
      [-PassThru]
      [-InRemovedState]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzKeyVaultSecret
      [-Id] <String>
      [-Force]
      [-PassThru]
      [-InRemovedState]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzKeyVaultSecret
      [-InputObject] <PSKeyVaultSecretIdentityItem>
      [-Force]
      [-PassThru]
      [-InRemovedState]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

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

Příklady

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

Remove-AzKeyVaultSecret -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

Remove-AzKeyVaultSecret -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 Vynucení a Potvrdit parametry, a proto rutina nezobrazí výzvu k potvrzení.

Příklad 3: Odebrání tajného klíče z trezoru klíčů (pomocí identifikátoru URI)

Remove-AzKeyVaultSecret -Id 'https://contoso.vault.azure.net:443/secrets/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 4: Odebrání tajného kódu ve službě Azure Key Vault příkazem Remove-Secret v modulu Microsoft.PowerShell.SecretManagement

# Install module Microsoft.PowerShell.SecretManagement
Install-Module Microsoft.PowerShell.SecretManagement -Repository PSGallery -AllowPrerelease
# Register vault for Secret Management
Register-SecretVault -Name AzKeyVault -ModuleName Az.KeyVault -VaultParameters @{ AZKVaultName = 'test-kv'; SubscriptionId = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' }
# Set secret for vault AzKeyVault
$secure = ConvertTo-SecureString -String "****" -AsPlainText -Force
Set-Secret -Vault AzKeyVault -Name secureSecret -SecureStringSecret $secure 
Remove-Secret -Vault AzKeyVault -Name secureSecret

None

Tento příklad odebere tajný kód pojmenovaný secureSecret ve službě Azure Key Vault test-kv příkazem Remove-Secret v modulu Microsoft.PowerShell.SecretManagement.

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

Remove-AzKeyVaultSecret -VaultName 'Contoso' -Name 'FinanceSecret' -InRemovedState

Tento příkaz odebere 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 vás vyzve 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

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

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

-Id

Identifikátor URI tajného klíče služby KeyVault. Ujistěte se, že se řídí formátem: https://<vault-name>.vault.azure.net/secrets/<secret-name>/<version>

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

-InputObject

Tajný objekt služby Key Vault

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

-InRemovedState

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

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky: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í.

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

-PassThru

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

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky: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í.

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

-WhatIf

Ukazuje, co se stane, když se rutina spustí. Rutina se nespustí. Ukazuje, co se stane, když se rutina spustí. Rutina se nespustí.

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

PSKeyVaultSecretIdentityItem

Výstupy

PSDeletedKeyVaultSecret