Set-FederationTrust

內部部署 Exchange 才有提供此 Cmdlet。

使用 Set-FederationTrust 指令程式,可修改現有的同盟信任。

如需下方<語法>一節中參數集的詳細資訊,請參閱 Exchange Cmdlet 語法

Syntax

Set-FederationTrust
   [-Identity] <FederationTrustIdParameter>
   -ApplicationUri <String>
   [-Confirm]
   [-DomainController <Fqdn>]
   [-Name <String>]
   [-WhatIf]
   [-PublishFederationCertificate]
   [<CommonParameters>]
Set-FederationTrust
   [-Identity] <FederationTrustIdParameter>
   [-PublishFederationCertificate]
   [-Confirm]
   [-DomainController <Fqdn>]
   [-Name <String>]
   [-WhatIf]
   [<CommonParameters>]
Set-FederationTrust
   [-Identity] <FederationTrustIdParameter>
   [-Confirm]
   [-DomainController <Fqdn>]
   [-MetadataUrl <Uri>]
   [-Name <String>]
   [-RefreshMetadata]
   [-Thumbprint <String>]
   [-WhatIf]
   [<CommonParameters>]

Description

您可以使用 Set-FederationTrust 指令程式管理用於同盟信任的憑證。 您也可使用 Set-FederationTrust 指令程式用於從 Microsoft 同盟閘道 (Microsoft Federation Gateway) 重新整理中繼資料文件,以及下載其憑證。

您必須已獲指派權限,才能執行此指令程式。 雖然本主題已列出這個指令程式的所有參數,不過,如果某些參數並未包含在指派給您的權限中,您可能就無法存取這些參數。 若要尋找在組織中執行任何 Cmdlet 或參數所需的權限,請參閱 Find the permissions required to run any Exchange cmdlet

範例

範例 1

Set-FederationTrust -Identity "Azure AD Authentication" -Thumbprint AC00F35CBA8359953F4126E0984B5CCAFA2F4F17

本範例設定同盟信任 Microsoft 同盟閘道 (Microsoft Federation Gateway) 使用憑證指紋為 AC00F35CBA8359953F4126E0984B5CCAFA2F4F17 的憑證作為下一個憑證。

範例 2

Set-FederationTrust -Identity "Azure AD Authentication" -PublishFederationCertificate

本範例設定同盟信任 Microsoft 同盟閘道 (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 Cmdlet 來確認所有 Exchange 伺服器上都有可用的憑證。

參數

-ApplicationUri

ApplicationUri 參數會指定同盟組織識別碼使用的主要網域。

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

-Confirm

Confirm 參數會指定要顯示或隱藏確認提示。 這個參數對 Cmdlet 的影響取決於 Cmdlet 是否需要確認才能繼續作業。

  • 例如,具破壞性的 Cmdlet (例如 Remove-* Cmdlet) 內建暫停,可強制您在繼續之前確認命令。 對於這些 Cmdlet,您可以使用以下確切語法來略過確認提示:-Confirm:$false
  • 其他大部分的 Cmdlet (例如,New-* 和 Set-* Cmdlet) 沒有內建暫停。 在使用這些 Cmdlet 時,指定不含任何值的 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

-DomainController

DomainController 參數會指定此 Cmdlet 用來向 Active Directory 讀取或寫入資料的網域控制站。 您可以透過網域控制站的完整網域名稱 (FQDN) 來識別網域控制站。 例如,dc01.contoso.com。

Type:Fqdn
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

-Identity

Identity 參數會指定要修改的同盟信任名稱。

注意:針對Exchange Online組織,請使用 「Azure AD 驗證」 值。

Type:FederationTrustIdParameter
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

-MetadataUrl

MetadataUrl 參數會指定 Microsoft 同盟閘道 (Microsoft Federation Gateway) 發佈 WS-FederationMetadata 的 URL。

Type:Uri
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

-Name

Name 參數會指定同盟信任的名稱。

Type:String
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

-PublishFederationCertificate

PublishFederationCertificate 參數會將下一個憑證指定為目前用於同盟信任的憑證,並將其推送至 Microsoft 同盟閘道。 您不需要使用此參數指定值。

此憑證將用於加密與 Microsoft 同盟閘道之間的 Token。

將下一個憑證設定為目前憑證之前,請確定憑證已部署在所有 Exchange 伺服器上。 使用 Test-FederationCertificate 指令程式檢查憑證的部署狀態。

Type:SwitchParameter
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

-RefreshMetadata

RefreshMetadata 參數會指定再次從 Microsoft 同盟閘道擷取中繼資料文件和憑證。 您不需要使用此參數指定值。

Type:SwitchParameter
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

-Thumbprint

Thumbprint 參數會指定將 X.509 憑證的憑證指紋設為同盟信任的下一個憑證。 在組織中的所有 Exchange 伺服器上部署憑證之後,您可以使用 PublishFederationCertificate 參數來設定信任以使用此憑證。

Type:String
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

-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

若要查看此指令程式可接受的傳回類型 (也就是所謂的輸出類型),請參閱指令程式輸入和輸出類型。 如果 [輸出類型] 欄位是空的,表示指令程式不會傳回資料。