Update-SPSecureStoreMasterKey

  • リファレンス
モジュール:
sharepoint-server
適用対象:
SharePoint Server Subscription Edition

Secure Store Service アプリケーションのマスター キーを変更します。

構文

Update-SPSecureStoreMasterKey
      -Passphrase <String>
      -ServiceApplicationProxy <SPServiceApplicationProxyPipeBind>
      [-AssignmentCollection <SPAssignmentCollection>]
      [<CommonParameters>]

説明

コマンドレットは Update-SPSecureStoreApplicationServerKey 、Secure Store Service アプリケーションのマスター キーを変更します。

マスター キーの更新は次の場合に必要となります。

--サービス アプリケーションの新しいインスタンスが作成され、Secure Store サービス アプリケーションのデータベースが新規または空になります。

--マスター キーまたはパスフレーズが侵害されました。

--セキュリティ ガイドラインでは、パスフレーズまたはキーを交換する必要があります。

Windows PowerShell for SharePoint 製品のアクセス許可と最新情報については、「SharePoint Server コマンドレット」のオンライン ドキュメントをご覧ください。

例

------------------ 例 ------------------

$newPassPhrase = "abcDEF123!"
$proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'Secure Store Service Application Proxy'}
Update-SPSecureStoreMasterKey -ServiceApplicationProxy $proxy -Passphrase $newPassPhrase

この例では、指定したサービス アプリケーションの新しいマスター キーを作成します。

パラメーター

-AssignmentCollection

適切な破棄を行うためにオブジェクトを管理します。 SPWeb や SPSite などのオブジェクトの使用によって大量のメモリが使用される場合があるので、Windows PowerShell スクリプトでこれらのオブジェクトを使用するには適切なメモリ管理が必要です。 メモリの解放が必要になった場合は、SPAssignment オブジェクトを使用して、変数へのオブジェクトの割り当てとオブジェクトの破棄を行うことができます。 割り当てコレクションまたは Global パラメーターが使用されていない場合、SPWeb、SPSite、または SPSiteAdministration オブジェクトが使用されていると、オブジェクトは自動的に破棄されます。

Global パラメーターが使用されている場合は、オブジェクトはすべてグローバル ストアに格納されます。 Stop-SPAssignment コマンドを使用してオブジェクトの使用または破棄を直接行わないと、メモリ不足のシナリオになる場合があります。

Type:SPAssignmentCollection
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-Passphrase

Secure Store データベースに使用されるパスフレーズを指定します。 入力したパスフレーズは保存されません。 パスフレーズはメモして安全な場所に保管しておいてください。 新しい Secure Store Service サーバーを追加するには、パスフレーズが必要となります。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-ServiceApplicationProxy

更新するマスター キーを含む Secure Store Service アプリケーションのプロキシを指定します。

Type:SPServiceApplicationProxyPipeBind
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition