Stop-HistoricalSearch

  • リファレンス
モジュール:
ExchangePowerShell
適用対象:
Exchange Online, Exchange Online Protection

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

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

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

構文

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

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

Type:Guid
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Online, Exchange Online Protection

入力

Input types

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

出力

Output types

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