Share via

Remove-AzKeyVaultSecret

  • Referenz
Modul:
Az.KeyVault

Löscht einen Geheimschlüssel in einem Schlüsseltresor.

Syntax

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>]

Beschreibung

Das Cmdlet Remove-AzKeyVaultSecret löscht einen geheimen Schlüssel in einem Schlüsseltresor. Wenn der geheime Schlüssel versehentlich gelöscht wurde, kann der geheime Schlüssel mithilfe von "Undo-AzKeyVaultSecretRemoval" von einem Benutzer mit speziellen "Wiederherstellen"-Berechtigungen wiederhergestellt werden. Dieses Cmdlet hat einen Wert mit hohem Wert für die ConfirmImpact-Eigenschaft .

Beispiele

Beispiel 1: Entfernen eines Geheimschlüssels aus einem Schlüsseltresor

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                 :

Mit diesem Befehl wird der Geheimschlüssel "FinanceSecret" aus dem Schlüsseltresor "Contoso" entfernt.

Beispiel 2: Entfernen eines Geheimschlüssels aus einem Schlüsseltresor ohne Benutzerbestätigung

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                 :

Mit diesem Befehl wird der Geheimschlüssel "FinanceSecret" aus dem Schlüsseltresor "Contoso" entfernt. Der Befehl gibt die Parameter "Force" und "Confirm " an, und daher werden Sie vom Cmdlet nicht zur Bestätigung aufgefordert.

Beispiel 3: Entfernen eines geheimen Schlüssels in Azure Key Vault mithilfe des Befehls "Remove-Secret" im Modul "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

In diesem Beispiel wird ein geheimer Schlüssel entfernt, der in Azure Key Vault test-kv durch Befehl Remove-Secret im Modul Microsoft.PowerShell.SecretManagementbenannt secureSecret ist.

Beispiel 4: Löschen eines gelöschten geheimen Schlüssels aus dem Schlüsseltresor dauerhaft

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

Mit diesem Befehl wird der geheime Schlüssel "FinanceSecret" aus dem Schlüsseltresor "Contoso" dauerhaft entfernt. Zum Ausführen dieses Cmdlets ist die Berechtigung "Löschen" erforderlich, die dem Benutzer zuvor und explizit für diesen Schlüsseltresor erteilt worden sein muss.

Parameter

-Confirm

Hiermit werden Sie vor der Ausführung des Cmdlets zur Bestätigung aufgefordert.

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

-DefaultProfile

Anmeldeinformationen, Konto, Mandant und Abonnement für die Kommunikation mit Azure

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Erzwingt die Ausführung des Befehls ohne Aufforderung zur Bestätigung durch den Benutzer.

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

-InputObject

Key Vault Secret-Objekt

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

-InRemovedState

Wenn vorhanden, wird der zuvor gelöschte geheime Schlüssel dauerhaft entfernt.

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

-Name

Gibt den Namen eines geheimen Schlüssels an. Dieses Cmdlet erstellt den vollqualifizierten Do Standard namen (FQDN) eines geheimen Schlüssels basierend auf dem Namen, den dieser Parameter angibt, den Namen des Schlüsseltresors und die aktuelle Umgebung.

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

-PassThru

Gibt an, dass dieses Cmdlet ein Microsoft.Azure.Commands.KeyVault.Models.Secret -Objekt zurückgibt. Standardmäßig wird von diesem Cmdlet keine Ausgabe generiert.

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

-VaultName

Gibt den Namen des Schlüsseltresors an, zu dem der geheime Schlüssel gehört. Dieses Cmdlet erstellt den FQDN eines Schlüsseltresors basierend auf dem Namen, den dieser Parameter angibt, und Die aktuelle Umgebung.

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

-WhatIf

Zeigt, was geschieht, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt. Zeigt, was passiert, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

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

Eingaben

PSKeyVaultSecretIdentityItem

Ausgaben

PSDeletedKeyVaultSecret