Set-FederationTrust

Módulo:: Exchange PowerShell

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.

Sintaxe

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

É 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 artigo 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 atualiza a configuração se o locatário estiver hospedado no ambiente GCC High ou DoD do Governo dos EUA do Microsoft 365.

Antes de configurar uma relação de 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 Exchange.

Parâmetros

-ApplicationUri

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

Propriedades do parâmetro

Tipo:	String
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

ApplicationUri

Cargo:	Named
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-Confirm

A opção Confirm especifica se a solicitação de confirmação deve ser mostrada ou ocultada. A forma como essa opção afeta o cmdlet depende se o cmdlet requer confirmação antes de continuar.

Cmdlets destrutivos (por exemplo, Remover- cmdlets) têm uma pausa interna que força você a confirmar o comando antes de continuar. Para estes cmdlets, você pode pular o pedido de confirmação usando esta sintaxe exata: -Confirm:$false.
A maioria dos outros cmdlets (por exemplo, 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 reconhecer o comando antes de continuar.

Propriedades do parâmetro

Tipo:	SwitchParameter
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False
Aliases:	cf

Conjuntos de parâmetros

(All)

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

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

Propriedades do parâmetro

Tipo:	Fqdn
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

(All)

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-Identity

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

Observação: para organizações do Exchange Online, use o valor "Autenticação do Microsoft Entra".

Propriedades do parâmetro

Tipo:	FederationTrustIdParameter
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

(All)

Cargo:	1
Obrigatório:	True
Valor do pipeline:	True
Valor do pipeline pelo nome da propriedade:	True
Valor dos argumentos restantes:	False

-MetadataUrl

O parâmetro MetadataUrl especifica a URL em que WS-FederationMetadata é publicado pelo Microsoft Federation Gateway.

Propriedades do parâmetro

Tipo:	Uri
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

Identity

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-Name

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

Propriedades do parâmetro

Tipo:	String
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

(All)

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-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 Exchange. Use o cmdlet Test-FederationCertificate para verificar o status de implantação do certificado.

Propriedades do parâmetro

Tipo:	SwitchParameter
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

PublishFederationCertificate

Cargo:	Named
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

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

Propriedades do parâmetro

Tipo:	SwitchParameter
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

Identity

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-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 Exchange na organização, você poderá usar a opção PublishFederationCertificate para configurar a relação de confiança para usar esse certificado.

Propriedades do parâmetro

Tipo:	String
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

Identity

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-WhatIf

A opção WhatIf mostra o que o comando faz sem fazer nenhuma alteração. Não é preciso especificar um valor com essa opção.

Propriedades do parâmetro

Tipo:	SwitchParameter
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False
Aliases:	wi

Conjuntos de parâmetros

(All)

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

CommonParameters

Este cmdlet dá suporte aos parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, confira about_CommonParameters.

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.

Comentários

Esta página foi útil?