Dela via

Remove-AzKeyVaultSecret

  • Referens
Modul:
Az.KeyVault

Tar bort en hemlighet i ett nyckelvalv.

Syntax

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

Cmdleten Remove-AzKeyVaultSecret tar bort en hemlighet i ett nyckelvalv. Om hemligheten har tagits bort av misstag kan hemligheten återställas med hjälp av Undo-AzKeyVaultSecretRemoval av en användare med särskilda "återställningsbehörigheter". Den här cmdleten har värdet hög för egenskapen ConfirmImpact.

Exempel

Exempel 1: Ta bort en hemlighet från ett nyckelvalv

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                 :

Det här kommandot tar bort hemligheten med namnet FinanceSecret från nyckelvalvet med namnet Contoso."

Exempel 2: Ta bort en hemlighet från ett nyckelvalv utan användarbekräftelse

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                 :

Det här kommandot tar bort hemligheten med namnet FinanceSecret från nyckelvalvet med namnet Contoso. Kommandot anger Force och Confirm parameters (Bekräfta parametrar). Därför uppmanas du inte att bekräfta cmdleten.

Exempel 3: Ta bort en hemlighet från ett nyckelvalv (med hjälp av 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                 :

Det här kommandot tar bort hemligheten med namnet "FinanceSecret" från nyckelvalvet med namnet "Contoso".

Exempel 4: Ta bort en hemlighet i Azure Key Vault med kommando Remove-Secret i modulen 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

Det här exemplet tar bort en hemlighet med namnet secureSecret i Azure Key Vault test-kv med kommandot Remove-Secret i modulen Microsoft.PowerShell.SecretManagement.

Exempel 4: Rensa borttagen hemlighet från nyckelvalvet permanent

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

Det här kommandot tar bort hemligheten med namnet FinanceSecret från nyckelvalvet med namnet Contoso permanent. För att köra den här cmdleten krävs behörigheten "rensa", som måste ha beviljats tidigare och uttryckligen till användaren för det här nyckelvalvet.

Parametrar

-Confirm

Uppmanar dig att bekräfta innan du kör cmdleten.

Typ:SwitchParameter
Alias:cf
Position:Named
Standardvärde:False
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-DefaultProfile

Autentiseringsuppgifter, konto, klientorganisation och prenumeration som används för kommunikation med Azure

Typ:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-Force

Tvingar kommandot att köras utan att be om användarbekräftelse.

Typ:SwitchParameter
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-Id

URI:n för KeyVault-hemligheten. Kontrollera att det följer formatet: https://<vault-name>.vault.azure.net/secrets/<secret-name>/<version>

Typ:String
Alias:SecretId
Position:0
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-InputObject

Hemligt key vault-objekt

Typ:PSKeyVaultSecretIdentityItem
Position:0
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-InRemovedState

Om det finns tar du bort den tidigare borttagna hemligheten permanent.

Typ:SwitchParameter
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-Name

Anger namnet på en hemlighet. Den här cmdleten konstruerar det fullständigt kvalificerade domännamnet (FQDN) för en hemlighet baserat på det namn som den här parametern anger, namnet på nyckelvalvet och din aktuella miljö.

Typ:String
Alias:SecretName
Position:1
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-PassThru

Anger att den här cmdleten returnerar ett Microsoft.Azure.Commands.KeyVault.Models.Secret-objekt. Som standard genererar den här cmdleten inga utdata.

Typ:SwitchParameter
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-VaultName

Anger namnet på nyckelvalvet som hemligheten tillhör. Den här cmdleten konstruerar FQDN för ett nyckelvalv baserat på namnet som den här parametern anger och din aktuella miljö.

Typ:String
Position:0
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-WhatIf

Visar vad som skulle hända om cmdleten körs. Cmdleten körs inte. Visar vad som skulle hända om cmdleten körs. Cmdleten körs inte.

Typ:SwitchParameter
Alias:wi
Position:Named
Standardvärde:False
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

Indata

PSKeyVaultSecretIdentityItem

Utdata

PSDeletedKeyVaultSecret