Remove-AzureKeyVaultSecret

Referentie

Module:: AzureRM.KeyVault

Hiermee verwijdert u een geheim in een sleutelkluis.

Waarschuwing

De AzureRM PowerShell-module is vanaf 29 februari 2024 officieel afgeschaft. Gebruikers wordt aangeraden om van AzureRM naar de Az PowerShell-module te migreren om ondersteuning en updates te garanderen.

Hoewel de AzureRM-module nog steeds kan functioneren, wordt deze niet meer onderhouden of ondersteund, waardoor het gebruik naar eigen goeddunken en risico van de gebruiker blijft bestaan. Raadpleeg onze migratiebronnen voor hulp bij de overgang naar de Az-module.

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

De cmdlet Remove-AzureKeyVaultSecret verwijdert een geheim in een sleutelkluis. Als het geheim per ongeluk is verwijderd, kan het geheim worden hersteld met behulp van Undo-AzureKeyVaultSecretRemoval door een gebruiker met speciale 'herstelmachtigingen'. Deze cmdlet heeft een waarde van hoog voor de eigenschap ConfirmImpact .

Voorbeelden

Voorbeeld 1: Een geheim uit een sleutelkluis verwijderen

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                 :

Met deze opdracht wordt het geheim met de naam FinanceSecret verwijderd uit de sleutelkluis met de naam Contoso.'

Voorbeeld 2: Een geheim uit een sleutelkluis verwijderen zonder bevestiging van de gebruiker

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                 :

Met deze opdracht wordt het geheim met de naam FinanceSecret verwijderd uit de sleutelkluis met de naam Contoso. Met de opdracht geeft u de parameters Force en Confirm op, en daarom wordt u niet om bevestiging gevraagd.

Voorbeeld 3: Verwijderd geheim uit de sleutelkluis permanent verwijderen

PS C:\> Remove-AzureKeyVaultSecret -VaultName 'Contoso' -Name 'FinanceSecret' -InRemovedState

Met deze opdracht wordt het geheim met de naam FinanceSecret vooraf opgegeven vanuit de sleutelkluis met de naam Contoso permanent. Voor het uitvoeren van deze cmdlet is de machtiging 'opschonen' vereist, die eerder en expliciet aan de gebruiker voor deze sleutelkluis moet zijn verleend.

Parameters

-Confirm

Hiermee wordt u gevraagd om bevestiging voordat u de cmdlet uitvoert.

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

-DefaultProfile

De referenties, het account, de tenant en het abonnement dat wordt gebruikt voor communicatie met Azure

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

-Force

Hiermee dwingt u de opdracht uit te voeren zonder dat u om bevestiging van de gebruiker wordt gevraagd.

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

-InputObject

Key Vault-geheimobject

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

-InRemovedState

Als dit aanwezig is, verwijdert u het eerder verwijderde geheim definitief.

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

-Name

Hiermee geeft u de naam van een geheim. Met deze cmdlet wordt de FQDN (Fully Qualified Domain Name) van een geheim samengesteld op basis van de naam die met deze parameter wordt opgegeven, de naam van de sleutelkluis en uw huidige omgeving.

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

-PassThru

Geeft aan dat deze cmdlet een Object Microsoft.Azure.Commands.KeyVault.Models.Secret retourneert. Deze cmdlet genereert standaard geen uitvoer.

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

-VaultName

Hiermee geeft u de naam van de sleutelkluis waartoe het geheim behoort. Met deze cmdlet wordt de FQDN van een sleutelkluis samengesteld op basis van de naam die met deze parameter wordt opgegeven en uw huidige omgeving.

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

-WhatIf

Hiermee wordt weergegeven wat er zou gebeuren als u de cmdlet uitvoert. De cmdlet wordt niet uitgevoerd. Toont wat er zou gebeuren als de cmdlet wordt uitgevoerd. De cmdlet wordt niet uitgevoerd.

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

Invoerwaarden

PSKeyVaultSecretIdentityItem

Parameters: InputObject (ByValue)

Uitvoerwaarden

PSDeletedKeyVaultSecret