Suspend-SPEnterpriseSearchServiceApplication

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

システム メンテナンスなどのタスクを実行するために、Search Service アプリケーションを中断し、すべてのクロール処理と検索処理を一時停止します。

構文

Suspend-SPEnterpriseSearchServiceApplication
       [-Identity] <SearchServiceApplicationPipeBind>
       [-AssignmentCollection <SPAssignmentCollection>]
       [-Confirm]
       [-WhatIf]
       [<CommonParameters>]

説明

このコマンドレットでは、SearchServiceApplication オブジェクトを取得し、その状態を Paused for: External Request から Suspend にします。

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

例

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

$ssa = Get-SPEnterpriseSearchServiceApplication -Identity MySSA
$ssa | Suspend-SPEnterpriseSearchServiceApplication

この例では、Search Service アプリケーション MySSA への参照を取得して、それを一時停止し、すべてのクロールとその他の検索コンポーネント (コンテンツ処理コンポーネント、分析処理コンポーネント、インデックス付けコンポーネントなど) を停止します。

パラメーター

-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

-Confirm

コマンドを実行する前に確認メッセージを表示します。 詳細については、次のコマンドを入力します。get-help about_commonparameters

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

-Identity

中断する Search Service アプリケーションを指定します。

この型は、12345678-90ab-cdef-1234-567890bcdefgh という形式の有効な GUID であるか、検索アプリケーションの有効な名前 (SearchApp1 など) であるか、有効な SearchServiceApplication オブジェクトのインスタンスであることが必要です。

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

-WhatIf

コマンドを実行する代わりに、コマンドの実行結果を説明するメッセージを表示します。 詳細については、次のコマンドを入力します。get-help about_commonparameters

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