Set-FederationTrust

Этот командлет доступен только в локальной среде Exchange.

Командлет Set-FederationTrust позволяет изменять существующее доверие федерации.

Сведения о наборах параметров в разделе Синтаксис ниже см. В разделе Синтаксис командлета Exchange.

Синтаксис

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

Описание

Командлет 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

В этом примере настраивается использование доверием федерации Microsoft Federation Gateway сертификата с отпечатком AC00F35CBA8359953F4126E0984B5CCAFA2F4F17 в качестве следующего сертификата.

Пример 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

В этом примере обновляется конфигурация, если клиент размещен в среде Майкрософт 365 U.S. Government GCC High или DoD.

Перед настройкой доверия федерации для использования следующего сертификата в качестве текущего сертификата необходимо использовать командлет Test-FederationTrust, чтобы убедиться, что сертификат доступен на всех серверах 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

Переключатель подтверждения указывает, показывать или скрывать запрос подтверждения. Влияние этого параметра на командлет зависит от того, требуется ли командлету подтверждение перед выполнением.

  • Деструктивные командлеты (например, командлеты 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

-DomainController

Параметр DomainController указывает контроллер домена, который используется этим командлетом для чтения или записи данных в 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 указывает URL-адрес публикации WS-FederationMetadata шлюзом Microsoft Federation Gateway.

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 Federation Gateway. Указывать значение для этого параметра необязательно.

Этот сертификат используется для шифрования маркеров с помощью шлюза Microsoft Federation Gateway.

Перед настройкой следующего сертификата для использования в качестве текущего сертификата убедитесь, что сертификат развернут на всех серверах 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 Federation Gateway. Указывать значение для этого параметра необязательно.

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

Сведения о типах возвращаемых данных, которые также называются типами выходных данных, которые принимает этот командлет, см. в разделе Типы входных и выходных данных командлетов. Если поле Тип вывода пусто, командлет не возвращает данные.