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
В этом примере настраивается использование доверием федерации 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
В этом примере обновляется конфигурация, если клиент размещен в среде Microsoft 365 U.S. Government, GCC High или DoD.
Прежде чем настраивать отношение доверия федерации для использования следующего сертификата в качестве текущего, необходимо с помощью командлета Test-FederationTrust убедиться, что сертификат доступен на всех серверах Exchange.
Параметры
-ApplicationUri
Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
Параметр ApplicationUri указывает основной домен, используемый для идентификатора федеративной организации.
Свойства параметров
| Тип: | String |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
ApplicationUri
| Position: | Named |
| Обязательно: | True |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Confirm
Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
Переключатель подтверждения указывает, показывать или скрывать запрос подтверждения. То, как этот переключатель влияет на командлет, зависит от того, требует ли командлет подтверждения перед продолжением.
- Деструктивные командлеты (например, командлеты Remove-) имеют встроенную паузу, которая заставляет вас подтвердить команду перед продолжением. Можно пропускать запросы на подтверждение этих командлетов, используя следующий синтаксис:
-Confirm:$false. - Большинство других командлетов (например, командлеты New- и Set-) не имеют встроенной паузы. Для этих командлетов указание параметра Confirm без значения приводит к паузе, которая вынуждает вас подтвердить команду перед продолжением.
Свойства параметров
| Тип: | SwitchParameter |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
| Aliases: | 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 указывает контроллер домена, который используется этим командлетом для чтения или записи данных в Active Directory. Вы определяете контроллер домена по его полному доменному имени (FQDN). Например, dc01.contoso.com.
Свойства параметров
| Тип: | Fqdn |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | 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 |
| DontShow: | 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 указывает URL-адрес публикации WS-FederationMetadata шлюзом Microsoft Federation Gateway.
Свойства параметров
| Тип: | Uri |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | 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 |
| DontShow: | 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 Federation Gateway. С этим параметром не нужно указывать значение.
Этот сертификат используется для шифрования маркеров с помощью шлюза Microsoft Federation Gateway.
Прежде чем выбрать следующий сертификат, который будет использоваться в качестве текущего, убедитесь, что он развернут на всех серверах Exchange. Командлет Test-FederationCertificate позволяет проверять состояние развертывания сертификата.
Свойства параметров
| Тип: | SwitchParameter |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | 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 Federation Gateway. С этим параметром не нужно указывать значение.
Свойства параметров
| Тип: | SwitchParameter |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | 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 Server в организации можно использовать переключатель PublishFederationCertificate, чтобы настроить доверие для использования этого сертификата.
Свойства параметров
| Тип: | String |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | 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 |
| DontShow: | False |
| Aliases: | wi |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
CommonParameters
Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в статье about_CommonParameters.
Входные данные
Input types
Чтобы просмотреть типы входных данных, которые принимает этот командлет, см. Типы входных и выходных данных командлета. Если поле "Типы входных данных" для командлета пусто, командлет не принимает входные данные.
Выходные данные
Output types
Чтобы просмотреть типы возвращаемых данных, также называемые типами вывода, которые принимает этот командлет, см. раздел Типы ввода и вывода командлета. Если поле "Типы выходных данных" пусто, командлет не возвращает данные.