Remove-AzKeyVaultSecret

  • Odwołanie
Moduł:
Az.KeyVault

Usuwa wpis tajny w magazynie kluczy.

Składnia

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

Opis

Polecenie cmdlet Remove-AzKeyVaultSecret usuwa wpis tajny w magazynie kluczy. Jeśli wpis tajny został przypadkowo usunięty, klucz tajny można odzyskać przy użyciu polecenia Undo-AzKeyVaultSecretRemoval przez użytkownika ze specjalnymi uprawnieniami odzyskiwania. To polecenie cmdlet ma wartość wysoką dla właściwości ConfirmImpact .

Przykłady

Przykład 1. Usuwanie wpisu tajnego z magazynu kluczy

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                 :

To polecenie usuwa wpis tajny o nazwie FinanceSecret z magazynu kluczy o nazwie Contoso.

Przykład 2. Usuwanie wpisu tajnego z magazynu kluczy bez potwierdzenia użytkownika

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                 :

To polecenie usuwa wpis tajny o nazwie FinanceSecret z magazynu kluczy o nazwie Contoso. Polecenie określa parametry Force i Confirm , a zatem polecenie cmdlet nie wyświetla monitu o potwierdzenie.

Przykład 3. Usuwanie wpisu tajnego w usłudze Azure Key Vault za pomocą polecenia Remove-Secret w module 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 "Password" -AsPlainText -Force
Set-Secret -Vault AzKeyVault -Name secureSecret -SecureStringSecret $secure 
Remove-Secret -Vault AzKeyVault -Name secureSecret

None

W tym przykładzie usunięto wpis tajny o nazwie secureSecret w usłudze Azure Key Vault test-kv za pomocą polecenia Remove-Secret w module Microsoft.PowerShell.SecretManagement.

Przykład 4. Przeczyszczenie usuniętego wpisu tajnego z magazynu kluczy trwale

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

To polecenie powoduje trwałe usunięcie wpisu tajnego o nazwie FinanceSecret z magazynu kluczy o nazwie Contoso. Wykonanie tego polecenia cmdlet wymaga uprawnienia "przeczyszczania", które musi być wcześniej i jawnie przyznane użytkownikowi dla tego magazynu kluczy.

Parametry

-Confirm

Monituje o potwierdzenie przed uruchomieniem polecenia cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required: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:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Obiekt wpisu tajnego usługi Key Vault

Type:PSKeyVaultSecretIdentityItem
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-InRemovedState

Jeśli istnieje, usuwa wcześniej usunięty wpis tajny trwale.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Określa nazwę wpisu tajnego. To polecenie cmdlet konstruuje w pełni kwalifikowaną nazwę domeny (FQDN) wpisu tajnego na podstawie nazwy określonej przez ten parametr, nazwy magazynu kluczy i bieżącego środowiska.

Type:String
Aliases:SecretName
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

Wskazuje, że to polecenie cmdlet zwraca obiekt Microsoft.Azure.Commands.KeyVault.Models.Secret . Domyślnie to polecenie cmdlet nie generuje żadnych danych wyjściowych.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VaultName

Określa nazwę magazynu kluczy, do którego należy wpis tajny. To polecenie cmdlet konstruuje nazwę FQDN magazynu kluczy na podstawie nazwy określonej przez ten parametr i bieżącego środowiska.

Type:String
Position:0
Default value:None
Required:True
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Dane wejściowe

PSKeyVaultSecretIdentityItem

Dane wyjściowe

PSDeletedKeyVaultSecret