Remove-AzKeyVaultSecret

構文

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

説明

Remove-AzKeyVaultSecret コマンドレットは、キー コンテナー内のシークレットを削除します。 シークレットが誤って削除された場合は、特別な '回復' アクセス許可を持つユーザーが Undo-AzKeyVaultSecretRemoval を使用してシークレットを回復できます。 このコマンドレットは、 ConfirmImpact プロパティの値が high です。

例

例 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 パラメーターを指定するため、コマンドレットは確認を求めるメッセージを表示しません。

例 3: モジュール Microsoft.PowerShell.SecretManagement の Remove-Secret コマンドを使用して Azure Key Vault 内のシークレットを削除する

# 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 "****" -AsPlainText -Force
Set-Secret -Vault AzKeyVault -Name secureSecret -SecureStringSecret $secure 
Remove-Secret -Vault AzKeyVault -Name secureSecret

None

この例では、モジュール Microsoft.PowerShell.SecretManagementのコマンド Remove-Secretによって、Azure Key Vault test-kvの secureSecret という名前のシークレットを削除します。

例 4: 削除されたシークレットをキー コンテナーから完全に消去する

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

このコマンドは、Contoso という名前のキー コンテナーから FinanceSecret という名前のシークレットを完全に削除します。 このコマンドレットを実行するには、"消去" アクセス許可が必要です。このアクセス許可は、以前にこのキー コンテナーのユーザーに明示的に付与されている必要があります。

パラメーター

-Confirm

-DefaultProfile

-Force

-InputObject

-InRemovedState

-Name

-PassThru

-VaultName

-WhatIf

入力

PSKeyVaultSecretIdentityItem

出力

PSDeletedKeyVaultSecret

関連リンク

• Get-AzKeyVaultSecret
• Set-AzKeyVaultSecret
• Undo-AzKeyVaultSecretRemoval