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

This example sets the title of the SPWeb object in multiple lines and controls the rate of disposal. This is an advanced example. Only developers are advised to use it.

パラメーター

-AssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

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

-Global

このパラメーターを使用すると、すべてのオブジェクトがスクリプトの有効期間に割り当てられ、コマンドレットが呼び出されたときに Stop-SPAssignment 破棄されます。

このパラメーターを使用しない場合は、このコマンドレットの出力を変数に割り当て、コマンドレットの Identity パラメーターを使用してオブジェクトを破棄する Stop-SPAssignment 必要があります。

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