Remove-Secret

  • リファレンス
モジュール:
Microsoft.PowerShell.SecretManagement

指定した登録済み拡張機能コンテナーからシークレットを削除します。

構文

Remove-Secret
      [-Name] <String>
      [-Vault] <String>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-Secret
      [-InputObject] <SecretInformation>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

登録済みの拡張機能コンテナーから名前でシークレットを削除します。 シークレット名と拡張コンテナー名の両方を指定する必要があります。

例

例 1

Remove-Secret -Name secretTest -Vault CredMan
Get-Secret -Name secretTest -Vault CredMan

Get-Secret: The secret secretTest was not found.

次の使用例は、 secretTest コンテナーからシークレットを CredMan 削除します。 このコマンドは Get-Secret 、シークレットがコンテナーに存在しなくなったことを確認します。

例 2

Get-SecretInfo -Name Secret2 -Vault CredMan | Remove-Secret
Get-Secret -Name Secret2 -Vault CredMan

Get-Secret: The secret Secret2 was not found.

次の使用例は、 Secret2 コンテナーからシークレットを CredMan 削除します。 Get-SecretInfo はシークレットの情報を取得し、パイプラインを介して 結果を に Remove-Secret送信します。 Get-Secret は、シークレットがコンテナーに存在しなくなったことを確認します。

パラメーター

-Confirm

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

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

-InputObject

コンテナー シークレットを記述する SecretInformation オブジェクトを指定します。

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

-Name

削除するシークレットの名前を指定します。 ワイルドカード文字 (*) は使用できません。

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

-Vault

シークレットを削除するコンテナーの名前を指定します。 ワイルドカード文字 (*) は使用できません。

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

-WhatIf

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

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

入力

String

Microsoft.PowerShell.SecretManagement.SecretInformation

出力

None