Get-TransportRule
このコマンドレットは、オンプレミスの Exchange およびクラウド ベースのサービスで使用できます。 一部のパラメーターと設定は、1 つの環境または他の環境に限定される場合があります。
組織内のトランスポート ルール (メール フロー ルール) を表示するには、Get-TransportRule コマンドレットを使用します。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
Default (既定)
Get-TransportRule
[[-Identity] <RuleIdParameter>]
[-DomainController <Fqdn>]
[-State <RuleState>]
[-DlpPolicy <String>]
[-ExcludeConditionActionDetails <Boolean>]
[-Filter <String>]
[-ResultSize <Unlimited>]
[<CommonParameters>]
説明
メールボックス サーバーでは、このコマンドレットは、Active Directory に格納されている Exchange organization内のすべてのルールを返します。 エッジ トランスポート サーバーでは、このコマンドレットはローカル サーバーで構成されている規則のみを返します。
このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 この記事ではコマンドレットのすべてのパラメーターを一覧表示しますが、割り当てられたアクセス許可にパラメーターが含まれていない場合は、一部のパラメーターにアクセスできない可能性があります。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。
例
例 1
Get-TransportRule
この例では、組織内のすべてのルールの要約リストを返します。
例 2
Get-TransportRule "Ethical Wall - Sales and Brokerage Departments" | Format-List
この例では、"Ethical Wall - Sales and Brokerage Departments" という名前のルールの詳細情報を返します。
パイプラインの詳細については、「 パイプラインについて」を参照してください。 コマンドの出力を操作する方法の詳細については、「コマンド出力の 操作」を参照してください。
例 3
Get-TransportRule -DlpPolicy "PII (U.S.)"
オンプレミス Exchange では、この例では、ORGANIZATIONで PII (米国) という名前の DLP ポリシーを適用するルールの概要リストを返します。
例 4
Get-TransportRule | Where {$_.DlpPolicy -ne $null}
オンプレミスの Exchange では、この例では、organizationで DLP ポリシーを適用するすべてのルールの概要一覧を返します。
パラメーター
-DlpPolicy
適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Online
注: このパラメーターは、オンプレミスの Exchange でのみ機能します。
DlpPolicy パラメーターは、指定されたデータ損失防止 (DLP) ポリシーの名前で結果をフィルター処理します。 値にスペースが含まれている場合は、値を二重引用符 (") で囲んでください。
組織の DLP ポリシーでは、秘匿性の高い情報を誤って開示してしまうことを防止できます。 各 DLP ポリシーは、一連のトランスポート ルールを使用して適用されます。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DomainController
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
DomainController パラメーターは、このコマンドレットで Active Directory からのデータの読み取りまたは Active Directory へのデータの書き込みに使用されるドメイン コントローラーを指定します。 ドメイン コントローラーは、完全修飾ドメイン名 (FQDN) で識別します。 たとえば、dc01.contoso.com です。
DomainController パラメーターは、エッジ トランスポート サーバーではサポートされません。 エッジ トランスポート サーバーは、Active Directory ライトウェイト ディレクトリ サービス (AD LDS) のローカル インスタンスを使用してデータの読み書きを行います。
パラメーターのプロパティ
| 型: | Fqdn |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ExcludeConditionActionDetails
適用対象: Exchange Online、Exchange Online Protection
このパラメーターは、クラウドベースのサービスでのみ使用できます。
ExcludeConditionActionDetails パラメーターは、結果から特定の詳細を非表示にするかどうかを指定します。 有効な値は次のとおりです。
- $true: Description プロパティ、Conditions プロパティ、Actions プロパティ、および構成済みの条件、例外、およびアクション プロパティの値は空白です。
- $false: プロパティまたはプロパティ値は非表示です。 この値が既定値です。
パラメーターのプロパティ
| 型: | Boolean |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Filter
適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Online、Exchange Online Protection
Filter パラメーターは、OPATH を使用して結果をフィルター処理します。 このパラメーターは、トランスポート ルールの条件、例外、アクション、関連値を含む Description プロパティを検索します。
このパラメーターには、構文 "Description -like 'Text*'" を使用します。 たとえば、「 "Description -like '192.168.1.1*'" 」のように入力します。
Exchange の OPATH フィルターの詳細については、「 その他の OPATH 構文情報」を参照してください。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Identity
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Online、Exchange Online Protection
Identity パラメーターは、表示するルールを指定します。 ルールを一意に識別する任意の値を使用できます。 次に例を示します。
- 名前
- 識別名 (DN)
- GUID
パラメーターのプロパティ
| 型: | RuleIdParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 1 |
| 必須: | False |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-ResultSize
適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Online、Exchange Online Protection
ResultSize パラメーターは、返される結果の最大数を指定します。 クエリに一致するすべてのリクエストを返す場合は、このパラメーターの値に unlimited を使用します。 既定値は 1,000 です。
パラメーターのプロパティ
| 型: | Unlimited |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-State
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Online、Exchange Online Protection
State パラメーターは、有効または無効になっているルールによって結果をフィルター処理します。 有効な値は次のとおりです。
- Enabled:有効になっているルールのみが結果で返されます。
- Disabled:無効になっているルールのみが結果で返されます。
このパラメーターを使用しない場合は、有効と無効の両方のルールがすべて返されます。
パラメーターのプロパティ
| 型: | RuleState |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(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
このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。