Set-EntraDomainFederationSettings

Moduł:
Microsoft.Entra.DirectoryManagement Module v1.3

Aktualizuje ustawienia domeny federacyjnej.

Składnia

Default (domyślnie) 

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

Opis

Polecenie Set-EntraDomainFederationSettings cmdlet służy do aktualizowania ustawień domeny logowania jednokrotnego.

W przypadku scenariuszy delegowanych użytkownik wywołujący musi mieć przypisaną co najmniej jedną z następujących ról Microsoft Entra:

  • Administrator nazwy domeny
  • Administrator zewnętrznego dostawcy tożsamości
  • Administrator tożsamości hybrydowej
  • Administrator zabezpieczeń

Przykłady

Przykład 1. Ustawianie elementu 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

To polecenie aktualizuje element PromptLoginBehavior do TranslateToFreshPasswordAuthelementu , NativeSupportlub Disabled. Te możliwe wartości są opisane:

  • TranslateToFreshPasswordAuth— oznacza domyślne zachowanie Microsoft Entra ID tłumaczenia prompt=login na wauth=https://schemas.microsoft.com/ws/2008/06/identity/authenticationmethod/password i wfresh=0.
  • NativeSupport — oznacza, że prompt=login parametr jest wysyłany jako do usług AD FS.
  • Disabled - oznacza, że tylko wfresh=0 jest wysyłany do usług ADFS

Użyj elementu , Get-EntraDomainFederationSettings -DomainName <your_domain_name> | Format-List * aby uzyskać wartości dla PreferredAuthenticationProtocol domeny federacyjnej i PromptLoginBehavior .

  • -DomainName parametr określa w pełni kwalifikowaną nazwę domeny do pobrania.
  • -PreferredAuthenticationProtocol parametr określa preferowany protokół uwierzytelniania.
  • -PromptLoginBehavior parametr określa zachowanie logowania monitu.

Parametry

-ActiveLogOnUri

Adres URL określający punkt końcowy używany przez aktywnych klientów podczas uwierzytelniania z domenami skonfigurowanymi na potrzeby logowania jednokrotnego (nazywanego również federacją tożsamości) w Microsoft Entra ID.

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:6
Obowiązkowe:False
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

-DomainName

W pełni kwalifikowana nazwa domeny (FQDN) do aktualizacji.

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:1
Obowiązkowe:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

-FederationBrandName

Nazwa wartości ciągu wyświetlana użytkownikom podczas logowania się do Microsoft Entra ID. Zalecamy, aby klienci używali czegoś, co jest znane użytkownikom, takim jak "Contoso Inc".

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:8
Obowiązkowe:False
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

-IssuerUri

Unikatowy identyfikator domeny na platformie Microsoft Entra ID Identity pochodzącej z serwera federacyjnego.

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:7
Obowiązkowe:False
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

-LogOffUri

Klienci adresów URL są przekierowywani do momentu wylogowania się z usług Microsoft Entra ID.

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:4
Obowiązkowe:False
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

-MetadataExchangeUri

Adres URL określający punkt końcowy wymiany metadanych używany do uwierzytelniania z zaawansowanych aplikacji klienckich, takich jak Lync Online.

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:9
Obowiązkowe:False
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

-NextSigningCertificate

Następny certyfikat podpisywania tokenu, który będzie używany do podpisywania tokenów po wygaśnięciu podstawowego certyfikatu podpisywania.

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:3
Obowiązkowe:False
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

-PassiveLogOnUri

Adres URL, do którego będą kierowani klienci internetowi podczas logowania się do usług Microsoft Entra ID.

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:5
Obowiązkowe:False
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

-PreferredAuthenticationProtocol

Określa preferowany protokół uwierzytelniania.

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:10
Obowiązkowe:False
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

-PromptLoginBehavior

Określa zachowanie logowania monitu.

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:12
Obowiązkowe:False
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

-SigningCertificate

Bieżący certyfikat używany do podpisywania tokenów przekazanych do platformy Microsoft Entra ID Identity.

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:2
Obowiązkowe:False
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

-SigningCertificateUpdateStatus

Określa stan aktualizacji certyfikatu podpisywania.

Właściwości parametru

Typ:System.Object
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:11
Obowiązkowe:False
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

CommonParameters

To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.