Suspend-Queue

リファレンス

モジュール:: ExchangePowerShell

適用対象:: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

このコマンドレットは、オンプレミスの Exchange でのみ使用可能です。

メールボックスサーバーまたはエッジトランスポートサーバー上のキューの処理を停止するには、Suspend-Queue コマンドレットを使用します。

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

構文

Suspend-Queue
       -Filter <String>
       [-Server <ServerIdParameter>]
       [-Confirm]
       [-WhatIf]
       [<CommonParameters>]

Suspend-Queue
       [-Identity] <QueueIdentity>
       [-Confirm]
       [-WhatIf]
       [<CommonParameters>]

説明

Suspend-Queue コマンドレットは、"アクティブ" または "再試行" の状態にあるキューの処理を停止します。処理中のメッセージは配信されますが、それ以外のメッセージがキューから出ていくことはありません。 Identity パラメーターを使用すると、その ID が 1 つのキューに一致した場合のみ、キューが中断されます。 ID が複数のキューに一致した場合は、エラーが返されます。 1 回の操作で 1 つのキューを中断するには、Filter パラメーターを使用する必要があります。

中断されたキューを再開する方法については、「Resume-Queue」を参照してください。

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

例

例 1

Suspend-Queue -Filter "NextHopDomain -eq "contoso.com" -and Status -eq 'Retry'"

この例では、ドメイン contoso.com への配信用メッセージを保持しており、現在の状態が Retry であるすべてのキューで処理を中断します。

例 2

Suspend-Queue -Server Server1.contoso.com -Filter "MessageCount -gt 100"

この例では、キューにあるメッセージが 100 より多いサーバー Server1.contoso.com 上のすべてのキューで処理を中断します。

パラメーター

-Confirm

Confirm スイッチは、確認プロンプトを表示するか非表示にするかを指定します。このスイッチがコマンドレットにどのような影響を与えるかは、先に進む前にコマンドレットで確認が必要となるかどうかで決まります。

破壊的なコマンドレット (Remove-* コマンドレットなど) には、続行する前にコマンドの確認を強制する組み込みの一時停止があります。これらのコマンドレットでは、正確な構文-Confirm:$falseを使用して、確認プロンプトを省略できます。
他のほとんどのコマンドレット (New-* コマンドレットや Set-* コマンドレットなど) には、一時停止が組み込まれています。これらのコマンドレットの場合、値なしで Confirm スイッチを指定すると、先に進む前に、一時停止してコマンドを確認する必要があります。

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-Filter

Filter パラメーターは、OPATH フィルター構文を使用して 1 つ以上のキューを指定します。 OPATH フィルターには、キュープロパティ名の後に比較演算子と値 (例: "NextHopDomain -eq 'contoso.com'") が含まれます。フィルター可能なキューのプロパティと比較演算子の詳細については、「Exchange Serverのキュープロパティ」および「Exchange Management Shell のキュー内のキューとメッセージを検索する」を参照してください。

および比較演算子を使用して、複数の条件を指定できます。整数として表されないプロパティ値は、引用符 (") で囲む必要があります。

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-Identity

Identity パラメーターは、キューを指定します。このパラメーターの有効な入力は、構文 Server\Queue または Queue を使用します (例: Mailbox01\contoso.com または Unreachable)。キュー ID の詳細については、「キュー ID」を参照してください。

Type:	QueueIdentity
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-Server

Server パラメーターは、このコマンドの実行先となる Exchange サーバーを指定します。サーバーを一意に識別する任意の値を使用できます。次に例を示します。

名前
FQDN
識別名 (DN)
Exchange の従来の DN

このパラメーターを使用しない場合、コマンドはローカルサーバー上で実行されます。

Server パラメーターと Filter パラメーターを同じコマンド内で使用することができます。 Server パラメーターと Identity パラメーターを同じコマンド内で使用することはできません。

Type:	ServerIdParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-WhatIf

WhatIf スイッチは、コマンドの操作をシミュレートします。このスイッチを使用すると、実際にその変更内容を適用せずに、発生する変更を確認できます。このスイッチで値を指定する必要はありません。

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

入力

Input types

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

出力

Output types

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

Share via