Remove-AzureKeyVaultKey
Usuwa klucz w magazynie kluczy.
Ważne
Ponieważ moduły Az programu PowerShell mają teraz wszystkie możliwości modułów programu PowerShell azureRM i nie tylko, wycofamy moduły programu AzureRM PowerShell w dniu 29 lutego 2024 r.
Aby uniknąć przerw w działaniu usługi, zaktualizuj skrypty , które używają modułów azureRM PowerShell do korzystania z modułów az programu PowerShell do 29 lutego 2024 r. Aby automatycznie zaktualizować skrypty, postępuj zgodnie z przewodnikiem Szybki start.
Składnia
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>]
Opis
Polecenie cmdlet Remove-AzureKeyVaultKey usuwa klucz w magazynie kluczy. Jeśli klucz został przypadkowo usunięty, można go odzyskać przy użyciu Undo-AzureKeyVaultKeyRemoval przez użytkownika z specjalnymi uprawnieniami odzyskiwania. To polecenie cmdlet ma wartość wysoką dla właściwości ConfirmImpact .
Przykłady
Przykład 1. Usuwanie klucza z magazynu kluczy
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 :
To polecenie usuwa klucz o nazwie ITSoftware z magazynu kluczy o nazwie Contoso.
Przykład 2. Usuwanie klucza bez potwierdzenia użytkownika
PS C:\> Remove-AzureKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -Force
To polecenie usuwa klucz o nazwie ITSoftware z magazynu kluczy o nazwie Contoso. Polecenie określa parametr Force , a zatem polecenie cmdlet nie wyświetla monitu o potwierdzenie.
Przykład 3. Trwałe przeczyszczenie usuniętego klucza z magazynu kluczy
PS C:\> Remove-AzureKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -InRemovedState
To polecenie powoduje trwałe usunięcie klucza o nazwie ITSoftware z magazynu kluczy o nazwie Contoso. Wykonanie tego polecenia cmdlet wymaga uprawnienia "przeczyszczanie", które musi być wcześniej i jawnie przyznane użytkownikowi dla tego magazynu kluczy.
Przykład 4. Usuwanie kluczy przy użyciu operatora potoku
PS C:\> Get-AzureKeyVaultKey -VaultName 'Contoso' | Where-Object {$_.Attributes.Enabled -eq $False} | Remove-AzureKeyVaultKey
To polecenie pobiera wszystkie klucze w magazynie kluczy o nazwie Contoso i przekazuje je do polecenia cmdlet Where-Object przy użyciu operatora potoku. To polecenie cmdlet przekazuje klucze, które mają wartość $False dla atrybutu Enabled do bieżącego polecenia cmdlet. To polecenie cmdlet usuwa te klucze.
Parametry
-Confirm
Monituje o potwierdzenie przed uruchomieniem polecenia cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DefaultProfile
Poświadczenia, konto, dzierżawa i subskrypcja używane do komunikacji z platformą Azure
Type: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Force
Wymusza uruchomienie polecenia bez monitowania o potwierdzenie użytkownika.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
KeyBundle, obiekt
Type: | PSKeyVaultKeyIdentityItem |
Position: | 0 |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-InRemovedState
Usuń wcześniej usunięty klucz trwale.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
Określa nazwę klucza do usunięcia. To polecenie cmdlet tworzy w pełni kwalifikowaną nazwę domeny (FQDN) klucza na podstawie nazwy, która określa ten parametr, nazwę magazynu kluczy i bieżące środowisko.
Type: | String |
Aliases: | KeyName |
Position: | 1 |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PassThru
Wskazuje, że to polecenie cmdlet zwraca obiekt Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKey . Domyślnie to polecenie cmdlet nie generuje żadnego wyniku.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-VaultName
Określa nazwę magazynu kluczy, z którego ma być usunięty klucz. To polecenie cmdlet tworzy nazwę FQDN magazynu kluczy na podstawie nazwy, która określa ten parametr i bieżące środowisko.
Type: | String |
Position: | 0 |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Pokazuje, co się stanie po uruchomieniu polecenia cmdlet. Polecenie cmdlet nie jest uruchamiane. Pokazuje, co się stanie, jeśli polecenie cmdlet zostanie uruchomione. Polecenie cmdlet nie zostało uruchomione.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Dane wejściowe
Parametry: InputObject (ByValue)