Set-FederationTrust
このコマンドレットは、オンプレミスの Exchange でのみ使用可能です。
Set-FederationTrust コマンドレットを使用して、既存のフェデレーション信頼を変更します。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
ApplicationUri
Set-FederationTrust
[-Identity] <FederationTrustIdParameter>
-ApplicationUri <String>
[-Confirm]
[-DomainController <Fqdn>]
[-Name <String>]
[-WhatIf]
[-PublishFederationCertificate]
[<CommonParameters>]
PublishFederationCertificate
Set-FederationTrust
[-Identity] <FederationTrustIdParameter>
[-PublishFederationCertificate]
[-Confirm]
[-DomainController <Fqdn>]
[-Name <String>]
[-WhatIf]
[<CommonParameters>]
Identity
Set-FederationTrust
[-Identity] <FederationTrustIdParameter>
[-Confirm]
[-DomainController <Fqdn>]
[-MetadataUrl <Uri>]
[-Name <String>]
[-RefreshMetadata]
[-Thumbprint <String>]
[-WhatIf]
[<CommonParameters>]
説明
Set-FederationTrust コマンドレットを使用してフェデレーション信頼に使用される証明書を管理できます。 また、Set-FederationTrust コマンドレットを使用して、Microsoft Federation Gateway からメタデータ ドキュメントをリフレッシュし、その証明書をダウンロードすることもできます。
このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 この記事ではコマンドレットのすべてのパラメーターを一覧表示しますが、割り当てられたアクセス許可にパラメーターが含まれていない場合は、一部のパラメーターにアクセスできない可能性があります。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。
例
例 1
Set-FederationTrust -Identity "Azure AD Authentication" -Thumbprint AC00F35CBA8359953F4126E0984B5CCAFA2F4F17
この例では、次の証明書として拇印 AC00F35CBA8359953F4126E0984B5CCAFA2F4F17 を持つ証明書を使用するようフェデレーション信頼 Microsoft Federation Gateway を構成します。
例 2
Set-FederationTrust -Identity "Azure AD Authentication" -PublishFederationCertificate
この例では、次の証明書を現在の証明書として使用するようフェデレーション信頼 Microsoft Federation Gateway を構成します。
例 3
Set-FederationTrust -Identity "Azure AD Authentication" -MetadataUrl https://nexus.microsoftonline-p.com/federationmetadata/2006-12/federationmetadata.xml
次の使用例は、テナントが Microsoft 365 米国政府機関 GCC High または DoD 環境でホストされている場合に構成を更新します。
現在の証明書として次の証明書を使用するようにフェデレーション信頼を構成する前に、Test-FederationTrust コマンドレットを使用して、証明書がすべての Exchange サーバーで使用可能であることを確認する必要があります。
パラメーター
-ApplicationUri
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
ApplicationUri パラメーターは、フェデレーション組織 ID に使用するプライマリ ドメインを指定します。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ApplicationUri
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Confirm
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
Confirm スイッチは、確認プロンプトを表示するか非表示にするかを指定します。 このスイッチがコマンドレットにどのような影響を与えるかは、先に進む前にコマンドレットで確認が必要となるかどうかで決まります。
- データを破壊するコマンドレット (たとえば、Remove- コマンドレット) には、先に進む前にユーザーにそのコマンドの確認を強制する組み込みの一時停止があります。 これらのコマンドレットでは、正確な構文
-Confirm:$falseを使用して、確認プロンプトを省略できます。 - 他のほとんどのコマンドレット (たとえば、New-* や Set-* コマンドレット) には、組み込みの一時停止はありません。 これらのコマンドレットの場合、値なしで Confirm スイッチを指定すると、先に進む前に、一時停止してコマンドを確認する必要があります。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | cf |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DomainController
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
DomainController パラメーターは、このコマンドレットで Active Directory からのデータの読み取りまたは Active Directory へのデータの書き込みに使用されるドメイン コントローラーを指定します。 ドメイン コントローラーは、完全修飾ドメイン名 (FQDN) で識別します。 たとえば、dc01.contoso.com です。
パラメーターのプロパティ
| 型: | Fqdn |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Identity
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
Identity パラメーターは、変更するフェデレーション信頼の名前を指定します。
注: Exchange Online組織の場合は、"Microsoft Entra 認証" という値を使用します。
パラメーターのプロパティ
| 型: | FederationTrustIdParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-MetadataUrl
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
MetadataUrl パラメーターには、Microsoft Federation Gateway によって WS-FederationMetadata が公開されている URL を指定します。
パラメーターのプロパティ
| 型: | Uri |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Identity
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Name
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
Name パラメーターは、フェデレーション信頼の名前を指定します。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-PublishFederationCertificate
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
PublishFederationCertificate スイッチは、次の証明書をフェデレーション信頼の現在の証明書として指定し、それを Microsoft Federation Gateway に公開します。 このスイッチで値を指定する必要はありません。
証明書は、Microsoft Federation Gateway でトークンを暗号化するために使用されます。
現在の証明書として使用する次の証明書を設定する前に、証明書がすべての Exchange サーバーに展開されていることを確認します。 証明書の展開状態を確認するには、Test-FederationCertificate コマンドレットを使用します。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
PublishFederationCertificate
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-RefreshMetadata
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
RefreshMetadata スイッチは、メタデータ ドキュメントと証明書をもう一度 Microsoft Federation Gateway から取得することを指定します。 このスイッチで値を指定する必要はありません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Identity
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Thumbprint
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
Thumbprint パラメーターは、フェデレーション信頼の次の証明書として構成する X.509 証明書の拇印を指定します。 証明書がorganization内のすべての Exchange サーバーに展開されたら、PublishFederationCertificate スイッチを使用して、この証明書を使用するように信頼を構成できます。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Identity
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
WhatIf スイッチは、コマンドの操作をシミュレートします。 このスイッチを使用すると、実際にその変更内容を適用せずに、発生する変更を確認できます。 このスイッチで値を指定する必要はありません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(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
このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。