Suspend-Queue
このコマンドレットは、オンプレミスの Exchange でのみ使用可能です。
メールボックス サーバーまたはエッジ トランスポート サーバー上のキューの処理を停止するには、Suspend-Queue コマンドレットを使用します。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
Filter
Suspend-Queue
-Filter <String>
[-Server <ServerIdParameter>]
[-Confirm]
[-WhatIf]
[<CommonParameters>]
Identity
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
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
Confirm スイッチは、確認プロンプトを表示するか非表示にするかを指定します。 この切り替えがコマンドレットにどのように影響するかは、続行する前にコマンドレットで確認が必要かどうかによって異なります。
- データを破壊するコマンドレット (たとえば、Remove- コマンドレット) には、先に進む前にユーザーにそのコマンドの確認を強制する組み込みの一時停止があります。 これらのコマンドレットでは、正確な構文
-Confirm:$falseを使用して、確認プロンプトを省略できます。 - 他のほとんどのコマンドレット (たとえば、New-* や Set-* コマンドレット) には、組み込みの一時停止はありません。 これらのコマンドレットでは、値を指定せずに [確認] スイッチを指定すると、続行する前にコマンドの確認を強制する一時停止が発生します。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | Cf |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Filter
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
Filter パラメーターは、OPATH フィルター構文を使用して 1 つ以上のキューを指定します。 OPATH フィルターには、キュー プロパティ名の後に比較演算子と値 (たとえば、 "NextHopDomain -eq 'contoso.com'") が含まれます。 フィルター可能なキューのプロパティと比較演算子の詳細については、「Exchange Serverのキュー プロパティ」および「Exchange 管理シェル のキュー内のキューとメッセージを検索する」を参照してください。
および 比較演算子を使用して、複数の条件を指定できます。 整数として表されないプロパティ値は、引用符 (") で囲む必要があります。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Filter
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Identity
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
Identity パラメーターは、キューを指定します。 このパラメーターの有効な入力は、構文 Server\Queue または Queue を使用します (例: Mailbox01\contoso.com または Unreachable)。 キュー ID の詳細については、「 キュー ID」を参照してください。
パラメーターのプロパティ
| 型: | QueueIdentity |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Identity
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-Server
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
Server パラメーターは、このコマンドの実行先となる Exchange サーバーを指定します。 サーバーを一意に識別する任意の値を使用できます。 次に例を示します。
- 名前
- FQDN
- 識別名 (DN)
- Exchange の従来の DN
このパラメーターを使用しない場合、コマンドはローカル サーバー上で実行されます。
Server パラメーターと Filter パラメーターを同じコマンド内で使用することができます。 Server パラメーターと Identity パラメーターを同じコマンド内で使用することはできません。
パラメーターのプロパティ
| 型: | ServerIdParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Filter
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-WhatIf
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
WhatIf スイッチは、変更を加えずにコマンドの動作を示します。 このスイッチで値を指定する必要はありません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | wi |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットは、共通パラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable をサポートします。 詳細については、「about_CommonParameters」を参照してください。
入力
Input types
このコマンドレットに使用できる入力の種類を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 コマンドレットで入力の種類のフィールドが空白の場合、そのコマンドレットには入力データを指定できません。
出力
Output types
このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。