Suspend-Message
このコマンドレットは、オンプレミスの Exchange でのみ使用可能です。
メールボックス サーバーまたはエッジ トランスポート サーバー上のキューに入っている特定のメッセージを配信できないようにするには、Suspend-Message コマンドレットを使用します。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
Suspend-Message
-Filter <String>
[-Server <ServerIdParameter>]
[-Confirm]
[-WhatIf]
[<CommonParameters>]
Suspend-Message
[-Identity] <MessageIdentity>
[-Confirm]
[-WhatIf]
[<CommonParameters>]
説明
既に配信中のメッセージは中断されません。 配信は続行され、メッセージの状態は PendingSuspend になります。 配信が失敗すると、メッセージは再度キューに置かれた後で中断されます。 有害メッセージ キュー内のメッセージを一時停止することはできません。
複数の受信者に送信されるメッセージは、複数のキューに存在する可能性があります。 Identity パラメーターを指定すると、その ID が 1 つのメッセージのみに一致した場合、メッセージが 1 つのキューで中断されます。 ID が複数のメッセージに一致した場合は、エラーが返されます。 1 回の操作で複数のキューにあるメッセージを中断するには、Filter パラメーターを使用する必要があります。
中断されたメッセージを再開する方法については、「Resume-Message」を参照してください。
このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 このトピックにはこのコマンドレットのすべてのパラメーターが一覧表示されていますが、自分に割り当てられているアクセス許可に含まれていない一部のパラメーターにはアクセスできません。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。
例
例 1
Suspend-Message -Server Server1 -Filter "FromAddress -eq 'kweku@contoso.com'"
この例は、以下の条件に該当するすべてのメッセージが配信されないようにします。
- メッセージは送信者 によって送信されます kweku@contoso.com。
- メッセージはサーバー Server1 のキューに入れられます。
パラメーター
-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 フィルターには、メッセージ プロパティ名の後に比較演算子と値 (例: "FromAddress -like '*@contoso.com'"
) が含まれます。 フィルター可能なメッセージ プロパティと比較演算子の詳細については、「 キュー内のメッセージのプロパティ 」および 「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\MessageInteger または Queue\MessageInteger または MessageInteger を使用します (例: Mailbox01\contoso.com\5 または 10)。 メッセージ ID の詳細については、「 メッセージ ID」を参照してください。
Type: | MessageIdentity |
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
このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。