Remove-AzKeyVaultSecret

  • 參考
模組:
Az.KeyVault

刪除金鑰保存庫中的秘密。

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

Remove-AzKeyVaultSecret Cmdlet 會刪除密鑰保存庫中的秘密。 如果秘密不小心刪除，則可以使用具有特殊「復原」許可權的用戶復原秘密 Undo-AzKeyVaultSecretRemoval。 此 Cmdlet 的 ConfirmImpact 屬性值很高。

範例

範例 1：從金鑰保存庫移除秘密

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                 :

此命令會從名為 Contoso 的金鑰保存庫中移除名為 FinanceSecret 的秘密。

範例 2：在不確認用戶的情況下，從密鑰保存庫移除秘密

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                 :

此命令會從名為 Contoso 的金鑰保存庫中移除名為 FinanceSecret 的秘密。 命令會 指定 Force 和 Confirm 參數，因此 Cmdlet 不會提示您進行確認。

範例 3：在 Microsoft.PowerShell.SecretManagement 模組中透過 Remove-Secret 命令移除 Azure 金鑰保存庫 中的秘密

# 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

此範例會藉由模組 中的 命令Remove-Secret，移除 Azure 中名為 secureSecret 的秘密 金鑰保存庫test-kv。Microsoft.PowerShell.SecretManagement

範例 4：永久清除金鑰保存庫中已刪除的秘密

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

此命令會從名為 Contoso 的金鑰保存庫移除名為 FinanceSecret 的秘密。 執行此 Cmdlet 需要 「清除」許可權，此許可權之前必須已明確授與此密鑰保存庫的使用者。

參數

-Confirm

執行 Cmdlet 之前先提示您確認。

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

-DefaultProfile

用於與 azure 通訊的認證、帳戶、租用戶和訂用帳戶

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

-Force

強制命令執行，而不要求使用者確認。

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

-InputObject

金鑰保存庫 Secret 物件

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

-InRemovedState

如果存在，請永久移除先前刪除的秘密。

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

-Name

指定秘密的名稱。 此 Cmdlet 會根據此參數指定的名稱、金鑰保存庫的名稱，以及您目前的環境，建構秘密的完整功能變數名稱 （FQDN）。

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

-PassThru

指出此 Cmdlet 會 傳回 Microsoft.Azure.Commands.KeyVault.Models.Secret 物件。 根據預設，此 Cmdlet 不會產生任何輸出。

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

-VaultName

指定秘密所屬金鑰保存庫的名稱。 此 Cmdlet 會根據此參數指定的名稱和您目前的環境，建構密鑰保存庫的 FQDN。

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

-WhatIf

顯示執行 Cmdlet 後會發生的情況。 Cmdlet 未執行。顯示 Cmdlet 執行時會發生什麼事。 未執行 Cmdlet。

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

輸入

PSKeyVaultSecretIdentityItem

輸出

PSDeletedKeyVaultSecret