Reset-SecretStore
すべてのシークレット データを削除し、既定のオプションを使用してストアを構成することで、SecretStore をリセットします。
構文
Default (既定)
Reset-SecretStore
[-Scope <SecureStoreScope>]
[-Authentication <Authenticate>]
[-Password <SecureString>]
[-PasswordTimeout <Int32>]
[-Interaction <Interaction>]
[-PassThru]
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Important
PowerShellチームは、Secretモジュールは機能が完結しており、今後積極的に開発されることはないと決定しました。 これらのモジュールは引き続きサポートされ、セキュリティや重大なバグ修正が行われます。 コードリポジトリはアーカイブされています。
最新に公開されたバージョンは以下の通りです:
このプロジェクトが設計されて以来、秘密の性質は根本的に変わりました。 パスキー、シングルサインオン、Microsoft Entra ID、生体認証、ハードウェアセキュリティキーなどのフェデレーテッド認証システムなどのパスワードレス認証方法が将来的に登場します。
このコマンドレットは、含まれる可能性があるすべてのシークレット データを削除し、構成オプションを既定値にリセットすることで、SecretStore を完全にリセットします。 これは、必要なパスワードを紛失した場合、またはデータファイルが破損して SecretStore が機能しなくなり、シークレットデータにアクセスできなくなった場合にのみ使用することを目的としています。
既定の構成オプションは、個々のコマンド構成オプション パラメーターを指定することでオーバーライドできます。
例
例 1
PS C:\> Reset-SecretStore -PassThru
WARNING: !!This operation will completely remove all SecretStore module secrets and reset
configuration settings to default values!!
Reset SecretStore
Are you sure you want to erase all secrets in SecretStore and reset configuration
settings to default?
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "N"): Y
Creating a new Microsoft.PowerShell.SecretStore vault. A password is required by
the current store configuration.
Enter password:
********
Enter password again for verification:
********
Scope Authentication PasswordTimeout Interaction
----- -------------- --------------- -----------
CurrentUser Password 900 Prompt
次の使用例は、現在のユーザーの SecretStore をリセットします。 このコマンドレットは、このアクションの結果について警告し、続行する前にユーザーに確認を求めます。 確認後、コマンドレットはすべてのシークレットを削除し、すべての構成設定を既定値に設定します。
パラメーター
-Authentication
SecretStoreへのアクセスを認証する方法を指定します。 値は Password または None である必要があります。
Noneとして指定した場合、コマンドレットはパスワードなしで SecretStore へのアクセスを有効にします。 既定の認証は Passwordです。
注意事項
認証 を None に設定すると、Passwordよりも安全性が低くなります。
Noneの指定は、シナリオのテストには役立つ場合がありますが、重要なシークレットには使用しないでください。
パラメーターのプロパティ
| 型: | Microsoft.PowerShell.SecretStore.Authenticate |
| 規定値: | Password |
| 指定可能な値: | None, Password |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | cf |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Force
コマンドレットがプロンプトを表示せずに、SecretStore をリセットする必要があることを示します。 既定では、このコマンドレットは、SecretStore をリセットした場合の影響について警告し、ユーザーに確認を求めます。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Interaction
SecretStore がアクセス時にユーザーにプロンプトを表示するかどうかを指定します。 値が Prompt場合、ユーザーは必要に応じて対話型セッションでパスワードの入力を求められます。 値が None の場合、ユーザーにパスワードの入力は求められません。 値が None で、パスワードが必要な場合、パスワードを必要とするコマンドレットは、Microsoft.PowerShell.SecretStore.PasswordRequiredException エラーをスローします。
パラメーターのプロパティ
| 型: | Microsoft.PowerShell.SecretStore.Interaction |
| 規定値: | Prompt |
| 指定可能な値: | None, Prompt |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-PassThru
コマンドレットをリセットした後、SecretStore 構成を返す必要があることを示します。 既定では、コマンドレットは出力を返しません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Password
SecretStore がアクセスに必要とするパスワードを指定します。
認証 が Noneとして指定されている場合、コマンドレットはエラーを返します。
認証がPasswordで、このパラメーターが指定されていない場合、コマンドレットはユーザーにパスワードを安全に入力するように求めます。
パラメーターのプロパティ
| 型: | SecureString |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-PasswordTimeout
パスワードで認証した後、SecretStore のロックが解除されたままの期間を指定します。 タイムアウト値に達すると、セッションの現在のパスワード値が無効になります。 タイムアウト後に SecretStore にアクセスするには、もう一度パスワードが必要です。
パラメーターのプロパティ
| 型: | Int32 |
| 規定値: | 900 |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Scope
SecretStore が構成されているコンテキストを指定します。 現在、CurrentUser のみがサポートされています。
パラメーターのプロパティ
| 型: | Microsoft.PowerShell.SecretStore.SecureStoreScope |
| 規定値: | CurrentUser |
| 指定可能な値: | CurrentUser, AllUsers |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | 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を参照してください。
