Start-SPAssignment
新しい割り当てストアを開始します。
構文
Start-SPAssignment
[-AssignmentCollection <SPAssignmentCollection>]
[-Global]
[<CommonParameters>]説明
コマンドレットは Start-SPAssignment 、変数の割り当てで使用されるオブジェクトを適切に破棄します。
一般に、SPWeb オブジェクト、SPSite オブジェクト、または SPSiteAdminsitration オブジェクトの使用時には大量のメモリが必要になります。 そのため、Windows PowerShellスクリプトでこれらのオブジェクトまたはこれらのオブジェクトのリストを使用するには、適切なメモリ管理が必要です。 既定では、すべての Get コマンドはパイプラインの終了直後にこれらのオブジェクトを破棄しますが、SPAssignment を使用すると、オブジェクトのリストを変数に割り当て、オブジェクトが不必要になった時点で破棄できます。 コマンドを繰り返し使用する場合でも、必要な間はオブジェクトを保持できます。
割り当てには、次の 3 つのレベルがあります。
-- 割り当てなし -- オブジェクトは変数に割り当てられず、コマンドの繰り返しごとに破棄されます。
-- 単純な割り当て -- すべてのオブジェクトがグローバル割り当てストアに割り当てられます。 この操作を実行するには、Global パラメーターを使用します。 このレベルを使用した場合、すべてのオブジェクトはグローバル ストアに割り当てられ、Stop-SPAssignment コマンドレットが呼び出されたときに破棄されます。
-- 高度な割り当て -- オブジェクトは、破棄のために名前付きストアに割り当てられます。 オブジェクトを破棄するには、 コマンドレットで Identity パラメーターを Stop-SPAssignment 使用します。
使用される割り当てレベルに関係なく、Windows PowerShell実行領域が閉じられたときに、すべてのオブジェクトが破棄されます。
Windows PowerShell for SharePoint 製品のアクセス許可と最新情報については、「SharePoint Server コマンドレット」のオンライン ドキュメントをご覧ください。
例
------------------ 例 1 -----------------------
Start-SPAssignment -global
$w = Get-SPWeb https://MyWeb
$w | Set-SPWeb -title "Accounting"
Stop-SPAssignment -globalこの例では、単純な割り当てを使用します。
単純な割り当ての使い方は簡単ですが、単純な割り当てを有効にして複数の SPSite オブジェクトや SPWeb オブジェクト間で繰り返し処理を行うコマンドを実行することはお勧めしません。
複数のオブジェクトの繰り返しを試みる前に、必ずを実行 Stop-SPAssignment してください。
------------------ 例 2 -----------------------
$gc = Start-SPAssignment
$web = $gc | Get-SPWeb https://MyWeb
$web | Set-SPWeb -title "Accounting"
Stop-SPAssignment -SemiGlobal $gcこの例では、 SPWeb オブジェクトのタイトルを複数の行に設定し、破棄の頻度を制御しています。 これは高度な例です。 この使用法は開発者向けです。
パラメーター
-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 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-Global
このパラメーターを使用すると、すべてのオブジェクトがスクリプトの有効期間に割り当てられ、コマンドレットが呼び出されたときに Stop-SPAssignment 破棄されます。
このパラメーターを使用しない場合は、このコマンドレットの出力を変数に割り当て、コマンドレットの Identity パラメーターを使用してオブジェクトを破棄する Stop-SPAssignment 必要があります。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |