Remove-AzureKeyVaultSecret
Tar bort en hemlighet i ett nyckelvalv.
Varning
AzureRM PowerShell-modulen är officiellt inaktuell från och med den 29 februari 2024. Användare rekommenderas att migrera från AzureRM till Az PowerShell-modulen för att säkerställa fortsatt support och uppdateringar.
Även om AzureRM-modulen fortfarande kan fungera, underhålls den inte längre eller stöds, vilket gör att användaren kan välja och riskera fortsatt användning. Se våra migreringsresurser för vägledning om övergången till Az-modulen.
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
Cmdleten Remove-AzureKeyVaultSecret tar bort en hemlighet i ett nyckelvalv. Om hemligheten togs bort av misstag kan hemligheten återställas med hjälp av Undo-AzureKeyVaultSecretRemoval 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
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 :
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
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 :
Det här kommandot tar bort hemligheten med namnet FinanceSecret från nyckelvalvet med namnet Contoso. Kommandot anger parametrarna Force och Confirm och därför uppmanas du inte att bekräfta cmdleten.
Exempel 3: Rensa borttagen hemlighet från nyckelvalvet permanent
PS C:\> Remove-AzureKeyVaultSecret -VaultName 'Contoso' -Name 'FinanceSecret' -InRemovedState
Det här kommandot föregår 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.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DefaultProfile
Autentiseringsuppgifter, konto, klientorganisation och prenumeration som används för kommunikation med Azure
Type: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Force
Tvingar kommandot att köras utan att be om användarbekräftelse.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Hemligt key vault-objekt
Type: | PSKeyVaultSecretIdentityItem |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-InRemovedState
Om det finns tar du bort den tidigare borttagna hemligheten permanent.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | 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ö.
Type: | String |
Aliases: | SecretName |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | 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.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | 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ö.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Visar vad som skulle hända om cmdleten kördes. Cmdleten körs inte. Visar vad som skulle hända om cmdleten körs. Cmdleten körs inte.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Indata
Parametrar: InputObject (ByValue)