Remove-Secret
指定した登録済みの拡張機能コンテナーからシークレットを削除します。
構文
NameParameterSet (既定)
Remove-Secret
[-Name] <String>
[-Vault] <String>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
InfoParameterSet
Remove-Secret
[-InputObject] <SecretInformation>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Important
PowerShellチームは、Secretモジュールは機能が完結しており、今後積極的に開発されることはないと決定しました。 これらのモジュールは引き続きサポートされ、セキュリティや重大なバグ修正が行われます。 コードリポジトリはアーカイブされています。
最新に公開されたバージョンは以下の通りです:
このプロジェクトが設計されて以来、秘密の性質は根本的に変わりました。 パスキー、シングルサインオン、Microsoft Entra ID、生体認証、ハードウェアセキュリティキーなどのフェデレーテッド認証システムなどのパスワードレス認証方法が将来的に登場します。
登録された拡張金庫から名前で秘密を削除します。 秘密の名前と拡張金庫名の両方を提供する必要があります。
例
例 1
Remove-Secret -Name secretTest -Vault CredMan
Get-Secret -Name secretTest -Vault CredMan
Get-Secret: The secret secretTest wasn't 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 wasn't found.
この例はSecret2の金庫からCredMan秘密を取り除きます。
Get-SecretInfo シークレットの情報を取得し、その結果をパイプライン経由で Remove-Secretに送信します。
Get-Secret 秘密がもはや金庫に存在しないことを確認します。
パラメーター
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | cf |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-InputObject
SecretInformationオブジェクトを指定し、Vault Secretを記述します。
パラメーターのプロパティ
| 型: | Microsoft.PowerShell.SecretManagement.SecretInformation |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
InfoParameterSet
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Name
除去すべき秘密の名前を指定します。 ワイルドカードキャラクター(*)は許可されていません。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
NameParameterSet
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Vault
秘密を取り除くための金庫の名前を指定します。 ワイルドカードキャラクター(*)は許可されていません。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
NameParameterSet
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
