Remove-AzureKeyVaultSecret

リファレンス

モジュール:: AzureRM.KeyVault

キーコンテナー内のシークレットを削除します。

警告

AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。

AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。

構文

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

説明

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

例

例 1: キーコンテナーからシークレットを削除する

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                 :

このコマンドは、Contoso という名前のキーコンテナーから FinanceSecret という名前のシークレットを削除します。

例 2: ユーザーの確認なしでキーコンテナーからシークレットを削除する

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                 :

このコマンドは、Contoso という名前のキーコンテナーから FinanceSecret という名前のシークレットを削除します。このコマンドは Force パラメーターと Confirm パラメーターを指定するため、コマンドレットは確認を求めるメッセージを表示しません。

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

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

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

パラメーター

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

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

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション

Type:	IAzureContextContainer
Aliases:	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

Key Vault シークレットオブジェクト

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

シークレットの名前を指定します。このコマンドレットは、このパラメーターが指定する名前、キーコンテナーの名前、および現在の環境に基づいて、シークレットの完全修飾 doメイン名 (FQDN) を構築します。

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

-PassThru

このコマンドレットによって Microsoft.Azure.Commands.KeyVault.Models.Secret オブジェクトが返されることを示します。既定では、このコマンドレットによる出力はありません。

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

-VaultName

シークレットが属するキーコンテナーの名前を指定します。このコマンドレットは、このパラメーターが指定する名前と現在の環境に基づいて、キーコンテナーの FQDN を構築します。

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

-WhatIf

コマンドレットの実行時に発生する内容を示します。コマンドレットは実行されません。コマンドレットを実行した場合の動作を示します。このコマンドレットは実行されません。

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

入力

PSKeyVaultSecretIdentityItem

Parameters: InputObject (ByValue)

出力

PSDeletedKeyVaultSecret