Set-FederationTrust

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

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

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

語法

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>]

Description

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

您必須已獲指派權限,才能執行此指令程式。 雖然本文列出 Cmdlet 的所有參數,但如果指派給您的權限中未包含某些參數,您可能無法存取這些參數。 若要尋找在組織中執行任何 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

適用項目:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

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

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

ApplicationUri
Position:Named
必要:True
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Confirm

適用項目:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

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

  • 破壞性的 Cmdlet (如 Remove-* cmdlets) 有內建暫停,它會先強迫您確認命令才會繼續作業。 對於這些 Cmdlet,您可以使用以下確切語法來略過確認提示:-Confirm:$false。
  • 其他大部分的 Cmdlet (如 New-* 和 Set-* cmdlets) 則沒有內建暫停。 針對這些 Cmdlet,指定不帶值的 Confirm 參數會造成暫停,強制您在繼續之前先確認命令。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False
別名:CF

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-DomainController

適用項目:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

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

參數屬性

類型:Fqdn
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Identity

適用項目:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

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

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

參數屬性

類型:FederationTrustIdParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:1
必要:True
來自管線的值:True
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-MetadataUrl

適用項目:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

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

參數屬性

類型:Uri
預設值:None
支援萬用字元:False
不要顯示:False

參數集

Identity
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Name

適用項目:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

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

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-PublishFederationCertificate

適用項目:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

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

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

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

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

PublishFederationCertificate
Position:Named
必要:True
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-RefreshMetadata

適用項目:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

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

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

Identity
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Thumbprint

適用項目:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

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

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

Identity
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-WhatIf

適用項目:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

WhatIf 參數會顯示命令在不進行任何變更的情況下執行的動作。 您不需要使用此參數指定值。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False
別名:WI

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

CommonParameters

此 Cmdlet 支援常見參數: -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊,請參閱 about_CommonParameters。

輸入

Input types

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

輸出

Output types

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