Stop-HistoricalSearch

モジュール:: Exchange PowerShell

このコマンドレットは、クラウドベースのサービスでのみ使用できます。

ステータス値が NotStarted である既存の履歴検索を停止するには、Stop-HistoricalSearch コマンドレットを使用します。

以下の構文セクションのパラメーターセットの詳細については、「Exchangeのコマンドレット構文」を参照してください。

構文

Default (既定)

Stop-HistoricalSearch
    -JobId <Guid>
    [<CommonParameters>]

説明

履歴検索では、90 日未満のメッセージに対して、コンマ区切り値 (CSV) ファイルでメッセージトレースとレポートの詳細が提供されます。

Start-HistoricalSearch コマンドレットを使用して履歴検索を開始すると、検索はキューに入れられますが、実際には実行されていません。検索がキューに入れられていて、ステータス値が NotStarted である場合、Stop-HistoricalSearch コマンドレットを使用して検索を停止することができます。検索が実際に実行されており、ステータス値が InProgress である場合は、検索を停止することはできません。履歴検索を停止すると、ステータス値は Cancelled になります。

このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。この記事ではコマンドレットのすべてのパラメーターを一覧表示しますが、割り当てられたアクセス許可にパラメーターが含まれていない場合は、一部のパラメーターにアクセスできない可能性があります。コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。

例

例 1

Stop-HistoricalSearch -JobId f9c66f83-b5c8-4a0c-91f4-a38376f74182

次の例では、JobId 値が f9c66f83-b5c8-4a0c-91f4-a38376f74182 である履歴検索を停止します。

パラメーター

-JobId

適用対象: Exchange Online、Exchange Online Protection

JobId パラメーターは、停止する履歴検索の識別 GUID 値を指定します。

パラメーターのプロパティ

型:	Guid
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	True
パイプラインからの値:	True
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

CommonParameters

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。詳細については、「about_CommonParameters」を参照してください。

入力

Input types

このコマンドレットに使用できる入力の種類を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。コマンドレットで入力の種類のフィールドが空白の場合、そのコマンドレットには入力データを指定できません。

出力

Output types

このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。