Reset-SecretStore

すべてのシークレット データを削除し、既定のオプションを使用してストアを構成することで、SecretStore をリセットします。

構文

Reset-SecretStore
     [-Scope <SecureStoreScope>]
     [-Authentication <Authenticate>]
     [-Password <SecureString>]
     [-PasswordTimeout <Int32>]
     [-Interaction <Interaction>]
     [-PassThru]
     [-Force]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

説明

このコマンドレットは、含まれる可能性のあるすべてのシークレット データを削除し、構成オプションを既定値にリセットすることで、 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 テストに役立ちますが、重要なシークレットでは使用しないでください。

Type:Authenticate
Accepted values:None, Password
Position:Named
Default value:Password
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

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

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

-Force

コマンドレットがプロンプトを表示せずに SecretStore をリセットする必要があることを示します。 既定では、コマンドレットは SecretStore をリセットした場合の影響について警告し、ユーザーに確認を求めます。

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

-Interaction

SecretStore がユーザーにアクセスするときにプロンプトを表示するかどうかを指定します。 値が の場合、 Promptユーザーは必要に応じて対話型セッションでパスワードの入力を求められます。 値が の None場合、ユーザーはパスワードの入力を求められません。 値が で None 、パスワードが必要な場合、パスワードを必要とするコマンドレットは Microsoft.PowerShell.SecretStore.PasswordRequiredException エラーをスローします。

Type:Interaction
Accepted values:None, Prompt
Position:Named
Default value:Prompt
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

コマンドレットをリセットした後に SecretStore 構成を返す必要があることを示します。 既定では、コマンドレットは出力を返しません。

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

-Password

SecretStore がアクセスに必要とするパスワードを指定します。 認証が としてNone指定されている場合、コマンドレットはエラーを返します。 Authentication が でPassword、このパラメーターが指定されていない場合、コマンドレットはユーザーにパスワードを安全に入力するように求めます。

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

-PasswordTimeout

パスワードで認証した後に SecretStore のロックを解除する期間を指定します。 タイムアウト値に達すると、セッションの現在のパスワード値が無効になります。 タイムアウト後に SecretStore にアクセスするには、もう一度パスワードが必要です。

Type:Int32
Position:Named
Default value:900
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Scope

SecretStore が構成されているコンテキストを指定します。 現在は、CurrentUser のみがサポートされています。

Type:SecureStoreScope
Accepted values:CurrentUser, AllUsers
Position:Named
Default value:CurrentUser
Required:False
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

入力

None

出力

Microsoft.PowerShell.SecretStore.SecureStoreConfig