Remove-AzKeyVaultSecret

  • Referencia
Modul:
Az.KeyVault

Titkos kulcs törlése egy kulcstartóban.

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

Description

A Remove-AzKeyVaultSecret parancsmag egy titkos kulcsot töröl egy kulcstartóban. Ha a titkos kulcs véletlenül törölve lett, a titkos kulcs helyreállítható a Visszavonás-AzKeyVaultSecretRemoval paranccsal egy speciális "helyreállító" engedélyekkel rendelkező felhasználó által. Ennek a parancsmagnak a ConfirmImpact tulajdonság értéke magas.

Példák

1. példa: Titkos kulcs eltávolítása egy kulcstartóból

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                 :

Ez a parancs eltávolítja a FinanceSecret nevű titkos kulcsot a Contoso nevű kulcstartóból."

2. példa: Titkos kulcs eltávolítása egy kulcstartóból felhasználói megerősítés nélkül

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                 :

Ez a parancs eltávolítja a FinanceSecret nevű titkos kulcsot a Contoso nevű kulcstartóból. A parancs megadja az Erő és megerősítés paramétereket, ezért a parancsmag nem kéri a megerősítést.

3. példa: Titkos kód eltávolítása az Azure Key Vaultban a Microsoft.PowerShell.SecretManagement modul Remove-Secret parancsával

# 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

Ez a példa eltávolít egy, az Azure Key Vaultban test-kv elnevezett secureSecret titkos kulcsot a modul Microsoft.PowerShell.SecretManagementparancsai Remove-Secret alapján.

4. példa: Törölt titkos kód végleges törlése a kulcstartóból

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

Ez a parancs véglegesen eltávolítja a FinanceSecret nevű titkos kulcsot a Contoso nevű kulcstartóból. A parancsmag végrehajtásához "törlési" engedély szükséges, amelyet korábban és explicit módon meg kellett adni a felhasználónak ehhez a kulcstartóhoz.

Paraméterek

-Confirm

Jóváhagyást kér a parancsmag futtatása előtt.

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

-DefaultProfile

Az Azure-ral való kommunikációhoz használt hitelesítő adatok, fiók, bérlő és előfizetés

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

-Force

Kényszeríti a parancs futtatását anélkül, hogy felhasználói megerősítést kérne.

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

-InputObject

Key Vault titkos objektum

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

-InRemovedState

Ha jelen van, véglegesen eltávolítja a korábban törölt titkos kódot.

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

-Name

Egy titkos kód nevét adja meg. Ez a parancsmag egy titkos kód teljes tartománynevét (FQDN) hozza létre a paraméter által megadott név, a kulcstartó neve és az aktuális környezet alapján.

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

-PassThru

Azt jelzi, hogy ez a parancsmag egy Microsoft.Azure.Commands.KeyVault.Models.Secret objektumot ad vissza. Ez a parancsmag alapértelmezés szerint nem hoz létre kimenetet.

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

-VaultName

Annak a kulcstartónak a nevét adja meg, amelyhez a titkos kulcs tartozik. Ez a parancsmag egy kulcstartó teljes tartománynevét hozza létre a paraméter által megadott név és az aktuális környezet alapján.

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

-WhatIf

Bemutatja, mi történne a parancsmag futtatásakor. A parancsmag nem fut. Megjeleníti, mi történne, ha a parancsmag futna. A parancsmag nem fut.

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

Bevitelek

PSKeyVaultSecretIdentityItem

Kimenetek

PSDeletedKeyVaultSecret