Remove-AzureKeyVaultKey
Tar bort en nyckel 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-AzureKeyVaultKey
[-VaultName] <String>
[-Name] <String>
[-Force]
[-PassThru]
[-InRemovedState]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Remove-AzureKeyVaultKey
[-InputObject] <PSKeyVaultKeyIdentityItem>
[-Force]
[-PassThru]
[-InRemovedState]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Cmdleten Remove-AzureKeyVaultKey tar bort en nyckel i ett nyckelvalv. Om nyckeln har tagits bort av misstag kan nyckeln återställas med Ångra AzureKeyVaultKeyRemoval 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 nyckel från ett nyckelvalv
PS C:\> Remove-AzureKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -PassThru
Vault Name : contoso
Name : key2
Id : https://contoso.vault.azure.net:443/keys/itsoftware/fdad15793ba0437e960497908ef9eb32
Deleted Date : 5/24/2018 11:28:25 PM
Scheduled Purge Date : 8/22/2018 11:28:25 PM
Enabled : False
Expires : 10/11/2018 11:32:49 PM
Not Before : 4/11/2018 11:22:49 PM
Created : 4/12/2018 10:16:38 PM
Updated : 4/12/2018 10:16:38 PM
Purge Disabled : False
Tags :
Det här kommandot tar bort nyckeln med namnet ITSoftware från nyckelvalvet med namnet Contoso.
Exempel 2: Ta bort en nyckel utan användarbekräftelse
PS C:\> Remove-AzureKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -Force
Det här kommandot tar bort nyckeln med namnet ITSoftware från nyckelvalvet med namnet Contoso. Kommandot anger parametern Force och därför uppmanas du inte att bekräfta cmdleten.
Exempel 3: Rensa en borttagen nyckel från nyckelvalvet permanent
PS C:\> Remove-AzureKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -InRemovedState
Det här kommandot tar bort nyckeln med namnet ITSoftware 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.
Exempel 4: Ta bort nycklar med hjälp av pipelineoperatorn
PS C:\> Get-AzureKeyVaultKey -VaultName 'Contoso' | Where-Object {$_.Attributes.Enabled -eq $False} | Remove-AzureKeyVaultKey
Det här kommandot hämtar alla nycklar i nyckelvalvet med namnet Contoso och skickar dem till cmdleten Where-Object med hjälp av pipelineoperatorn. Den cmdleten skickar nycklarna som har värdet $False för attributet Enabled till den aktuella cmdleten. Den cmdleten tar bort dessa nycklar.
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
KeyBundle-objekt
Type: | PSKeyVaultKeyIdentityItem |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-InRemovedState
Ta bort den tidigare borttagna nyckeln permanent.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
Anger namnet på den nyckel som ska tas bort. Den här cmdleten konstruerar det fullständigt kvalificerade domännamnet (FQDN) för en nyckel baserat på namnet som den här parametern anger, namnet på nyckelvalvet och din aktuella miljö.
Type: | String |
Aliases: | KeyName |
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.PSKeyVaultKey-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 nyckeln ska tas bort från. 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)