Set-EntraDomainFederationSettings

Atualiza as configurações de um domínio federado.

Sintaxe

Default (Default)

Set-EntraDomainFederationSettings

    -DomainName <String>
    [-SigningCertificate <String>]
    [-NextSigningCertificate <String>]
    [-LogOffUri <String>]
    [-PassiveLogOnUri <String>]
    [-ActiveLogOnUri <String>]
    [-IssuerUri <String>]
    [-FederationBrandName <String>]
    [-MetadataExchangeUri <String>]
    [-PreferredAuthenticationProtocol <AuthenticationProtocol>]
    [-SigningCertificateUpdateStatus <SigningCertificateUpdateStatus>]
    [-PromptLoginBehavior <PromptLoginBehavior>]
    [<CommonParameters>]

Description

O Set-EntraDomainFederationSettings cmdlet é usado para atualizar as configurações de um domínio de logon único.

Para cenários delegados, o usuário de chamada deve receber pelo menos uma das seguintes funções de Microsoft Entra:

  • Administrador de Nome de Domínio
  • Administrador do Fornecedor de Identidade Externo
  • Administrador de identidade híbrida
  • Administrador de segurança

Exemplos

Exemplo 1: Definir o PromptLoginBehavior

Connect-Entra -Scopes 'Domain.ReadWrite.All'
$domain = 'contoso.com'
$authProtocol = 'WsFed'
$promptLoginBehavior = 'TranslateToFreshPasswordAuth' # Or 'NativeSupport' or 'Disabled', depending on the requirement
Set-EntraDomainFederationSettings -DomainName $domain -PreferredAuthenticationProtocol $authProtocol -PromptLoginBehavior $promptLoginBehavior

Esse comando atualiza o PromptLoginBehavior para TranslateToFreshPasswordAuth, NativeSupportou Disabled. Esses valores possíveis são descritos:

  • TranslateToFreshPasswordAuth- significa o comportamento padrão Microsoft Entra ID de traduzir prompt=login para wauth=https://schemas.microsoft.com/ws/2008/06/identity/authenticationmethod/password e wfresh=0.
  • NativeSupport - significa que o prompt=login parâmetro é enviado como está para o ADFS.
  • Disabled - significa que apenas wfresh=0 é enviado para o ADFS

Use o Get-EntraDomainFederationSettings -DomainName <your_domain_name> | Format-List * para obter os valores para PreferredAuthenticationProtocol e PromptLoginBehavior para o domínio federado.

  • -DomainName o parâmetro especifica o nome de domínio totalmente qualificado a ser recuperado.
  • -PreferredAuthenticationProtocol o parâmetro especifica o protocolo de autenticação preferencial.
  • -PromptLoginBehavior o parâmetro especifica o comportamento de entrada do prompt.

Parâmetros

-ActiveLogOnUri

Uma URL que especifica o ponto de extremidade usado por clientes ativos ao autenticar com domínios configurados para logon único (também conhecido como federação de identidade) em Microsoft Entra ID.

Propriedades do parâmetro

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

Conjuntos de parâmetros

(All)
Cargo:6
Obrigatório:False
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-DomainName

O FQDN (nome de domínio totalmente qualificado) a ser atualizado.

Propriedades do parâmetro

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

Conjuntos de parâmetros

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

-FederationBrandName

O nome do valor da cadeia de caracteres mostrado aos usuários ao entrar no Microsoft Entra ID. Recomendamos que os clientes usem algo que seja familiar para usuários como "Contoso Inc".

Propriedades do parâmetro

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

Conjuntos de parâmetros

(All)
Cargo:8
Obrigatório:False
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-IssuerUri

O identificador exclusivo do domínio na plataforma Microsoft Entra ID Identity derivada do servidor de federação.

Propriedades do parâmetro

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

Conjuntos de parâmetros

(All)
Cargo:7
Obrigatório:False
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-LogOffUri

Os clientes de URL são redirecionados quando saem dos serviços de Microsoft Entra ID.

Propriedades do parâmetro

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

Conjuntos de parâmetros

(All)
Cargo:4
Obrigatório:False
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-MetadataExchangeUri

A URL que especifica o ponto de extremidade de troca de metadados usado para autenticação de aplicativos cliente avançados, como o Lync Online.

Propriedades do parâmetro

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

Conjuntos de parâmetros

(All)
Cargo:9
Obrigatório:False
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-NextSigningCertificate

O próximo certificado de autenticação de token que será usado para assinar tokens quando o certificado de assinatura primário expirar.

Propriedades do parâmetro

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

Conjuntos de parâmetros

(All)
Cargo:3
Obrigatório:False
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-PassiveLogOnUri

A URL para a qual os clientes baseados na Web serão direcionados ao entrar nos serviços de Microsoft Entra ID.

Propriedades do parâmetro

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

Conjuntos de parâmetros

(All)
Cargo:5
Obrigatório:False
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-PreferredAuthenticationProtocol

Especifica o protocolo de autenticação preferencial.

Propriedades do parâmetro

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

Conjuntos de parâmetros

(All)
Cargo:10
Obrigatório:False
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-PromptLoginBehavior

Especifica o comportamento de logon do prompt.

Propriedades do parâmetro

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

Conjuntos de parâmetros

(All)
Cargo:12
Obrigatório:False
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-SigningCertificate

O certificado atual usado para assinar tokens passados para a plataforma Microsoft Entra ID Identity.

Propriedades do parâmetro

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

Conjuntos de parâmetros

(All)
Cargo:2
Obrigatório:False
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-SigningCertificateUpdateStatus

Especifica o status de atualização do certificado de assinatura.

Propriedades do parâmetro

Tipo:System.Object
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:11
Obrigatório:False
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.