Set-SecretStoreConfiguration
SecretStoreを構成します。
構文
ParameterSet (既定)
Set-SecretStoreConfiguration
[-Scope <SecureStoreScope>]
[-Authentication <Authenticate>]
[-PasswordTimeout <Int32>]
[-Interaction <Interaction>]
[-Password <SecureString>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
DefaultParameterSet
Set-SecretStoreConfiguration
[-Default]
[-Password <SecureString>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Important
PowerShellチームは、Secretモジュールは機能が完結しており、今後積極的に開発されることはないと決定しました。 これらのモジュールは引き続きサポートされ、セキュリティや重大なバグ修正が行われます。 コードリポジトリはアーカイブされています。
最新に公開されたバージョンは以下の通りです:
このプロジェクトが設計されて以来、秘密の性質は根本的に変わりました。 パスキー、シングルサインオン、Microsoft Entra ID、生体認証、ハードウェアセキュリティキーなどのフェデレーテッド認証システムなどのパスワードレス認証方法が将来的に登場します。
このコマンドレットは、現在のユーザーの SecretStore を構成します。
例
例 1
PS C:\> Set-SecretStoreConfiguration -Default
Confirm
Are you sure you want to perform this action?
Performing the operation "Changes local store configuration" on target "SecretStore module local store".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
Scope Authentication PasswordTimeout Interaction
----- -------------- --------------- -----------
CurrentUser Password 900 Prompt
次の使用例は、SecretStore を既定の構成に復元します。
パラメーター
-Authentication
SecretStoreへのアクセスを認証する方法を指定します。 値は Password または None である必要があります。
Noneとして指定した場合、コマンドレットはパスワードなしで SecretStore へのアクセスを有効にします。 既定の認証は Passwordです。
注意事項
認証 を None に設定すると、Passwordよりも安全性が低くなります。
Noneの指定は、シナリオのテストには役立つ場合がありますが、重要なシークレットには使用しないでください。
パラメーターのプロパティ
| 型: | Microsoft.PowerShell.SecretStore.Authenticate |
| 規定値: | Password |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | cf |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Default
SecretStore を既定の構成に設定する必要があることを示します。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
DefaultParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Interaction
SecretStore がアクセス時にユーザーにプロンプトを表示するかどうかを指定します。 値が Prompt場合、ユーザーは必要に応じて対話型セッションでパスワードの入力を求められます。 値が None の場合、ユーザーにパスワードの入力は求められません。 値が None で、パスワードが必要な場合、パスワードを必要とするコマンドレットは、Microsoft.PowerShell.SecretStore.PasswordRequiredException エラーをスローします。
パラメーターのプロパティ
| 型: | Microsoft.PowerShell.SecretStore.Interaction |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-PassThru
コマンドレットを更新した後、SecretStore 構成を返す必要があることを示します。 既定では、コマンドレットは出力を返しません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Password
SecretStoreにアクセスするために必要なパスワードを指定します。 このパラメーターを使用して既存のパスワードを変更することはできません。 既存のパスワードを変更するには、Set-SecretStorePasswordを使用します。
このパラメーターを Authenticate パラメーターと共に使用して認証の構成を None から Passwordに変更する場合、このパラメーターの値は、SecretStoreの新しいパスワードとして設定されます。
このパラメーターを Authenticate パラメーターと共に使用して認証の構成を Password から Noneに変更する場合、このパラメーターの値は、SecretStoreの現在のパスワードである必要があります。 これは、構成の変更を承認するために使用されます。
パラメーターのプロパティ
| 型: | SecureString |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-PasswordTimeout
パスワードで認証した後、SecretStore のロックが解除されたままの秒数を指定します。 タイムアウトが経過すると、セッションの現在のパスワード値が無効になります。 タイムアウト後に SecretStore にアクセスするには、もう一度パスワードが必要です。
パラメーターのプロパティ
| 型: | Int32 |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Scope
SecretStore が構成されているコンテキストを指定します。 現在、CurrentUser のみがサポートされています。
パラメーターのプロパティ
| 型: | Microsoft.PowerShell.SecretStore.SecureStoreScope |
| 規定値: | None |
| 指定可能な値: | CurrentUser, AllUsers |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ParameterSet
| 配置: | 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を参照してください。
