Set-FederationTrust

Este cmdlet está disponível somente no Exchange local.

Use o cmdlet Set-FederationTrust para modificar uma relação de confiança de federação existente.

Para saber mais sobre os conjuntos de parâmetros na seção Sintaxe, abaixo, consulte Exchange cmdlet syntax.

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

É possível usar o cmdlet Set-FederationTrust para gerenciar os certificados usados para a relação de confiança de federação. Você também pode usar o cmdlet Set-FederationTrust para atualizar o documento de metadados no Microsoft Federation Gateway e baixar seu certificado.

Para executar esse cmdlet, você precisa ter permissões. Embora este tópico liste todos os parâmetros do cmdlet, talvez você não tenha acesso a alguns parâmetros se eles não estiverem incluídos nas permissões atribuídas a você. Para localizar as permissões necessárias para executar qualquer cmdlet ou parâmetro em sua organização, confira Find the permissions required to run any Exchange cmdlet.

Exemplos

Exemplo 1

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

Este exemplo configura a relação de confiança de federação do Microsoft Federation Gateway para usar o certificado com a impressão digital AC00F35CBA8359953F4126E0984B5CCAFA2F4F17 como o próximo certificado.

Exemplo 2

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

Este exemplo configura a relação de confiança de federação do Microsoft Federation Gateway para usar o próximo certificado como o certificado atual.

Exemplo 3

Set-FederationTrust -Identity "Azure AD Authentication" -MetadataUrl https://nexus.microsoftonline-p.com/federationmetadata/2006-12/federationmetadata.xml

Este exemplo atualizará a configuração se o locatário estiver hospedado em Microsoft ambiente de GCC Alto ou DoD do Governo dos EUA 365.

Antes de configurar uma confiança de federação para usar o próximo certificado como o certificado atual, você precisa usar o cmdlet Test-FederationTrust para verificar se o certificado está disponível em todos os servidores do Exchange.

Parâmetros

-ApplicationUri

O parâmetro ApplicationUri especifica o domínio primário usado para o identificador da organização de federação.

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

A opção Confirm especifica se a solicitação de confirmação deve ser mostrada ou ocultada. Como essa opção afeta o cmdlet dependerá do fato de o cmdlet exigir ou não confirmação antes de continuar.

  • Cmdlets destrutivos (por exemplo, cmdlets Remove-*) têm uma pausa interna que força você a reconhecer o comando antes de prosseguir. Para estes cmdlets, você pode pular o pedido de confirmação usando esta sintaxe exata: -Confirm:$false.
  • A maioria dos outros cmdlets (por exemplo, cmdlets New-* e Set-*) não tem uma pausa interna. Para esses cmdlets, especificar a opção Confirm sem um valor introduz uma pausa que força você a confirmar o comando antes de continuar.
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

O parâmetro DomainController especifica o controlador de domínio que é usado por esse cmdlet para ler dados ou gravar dados no Active Directory. Você identifica o controlador de domínio por seu FQDN (nome de domínio totalmente qualificado). Por exemplo, 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

O parâmetro Identity especifica o nome da relação de confiança de federação modificado.

Observação: para organizações Exchange Online, use o valor "autenticação 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

O parâmetro MetadataUrl especifica a URL em que WS-FederationMetadata é publicado pelo 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

O parâmetro Name especifica um nome para a relação de confiança de federação.

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

A opção PublishFederationCertificate especifica o próximo certificado como o certificado atual da relação de confiança de federação e o publica no Microsoft Federation Gateway. Não é preciso especificar um valor com essa opção.

O certificado é usado para criptografar tokens com o Microsoft Federation Gateway.

Antes de definir o próximo certificado a ser usado como o certificado atual, verifique se o certificado está implantado em todos os servidores do Exchange. Use o cmdlet Test-FederationCertificate para verificar o status de implantação do certificado.

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

A opção RefreshMetadata especifica que o documento de metadados e o certificado são recuperados novamente no Microsoft Federation Gateway. Não é preciso especificar um valor com essa opção.

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

O parâmetro Thumbprint especifica a impressão digital do certificado X.509 a ser configurado como o próximo certificado da relação de confiança de federação. Depois que o certificado for implantado em todos os servidores do Exchange na organização, você poderá usar a opção PublishFederationCertificate para configurar a confiança para usar esse certificado.

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

A opção WhatIf simula as ações do comando. Você pode usar essa opção para exibir as alterações que ocorreriam sem realmente aplicar essas alterações. Não é preciso especificar um valor com essa opção.

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

Entradas

Input types

Para ver os tipos de entrada que este cmdlet aceita, confira Tipos de entrada e saída de cmdlet. Se o campo Tipo de Entrada de um cmdlet estiver em branco, isso significa que o cmdlet não aceita dados de entrada.

Saídas

Output types

Para ver os tipos de retorno, também conhecidos como tipos de saída, que este cmdlet aceita, consulte Tipos de entrada e saída de cmdlet. Se o campo Tipo de Saída estiver em branco, o cmdlet não retorna dados.