Set-EntraDomainFederationSettings
構文
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>]
説明
Set-EntraDomainFederationSettings コマンドレットは、シングル サインオン ドメインの設定を更新するために使用されます。
委任されたシナリオでは、呼び出し元のユーザーに、次のMicrosoft Entraロールの少なくとも 1 つを割り当てる必要があります。
- ドメイン名管理者
- 外部 ID プロバイダー管理者
- ハイブリッド ID の管理者
- セキュリティ管理者
例
例 1: 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
このコマンドは、PromptLoginBehavior、TranslateToFreshPasswordAuth、またはNativeSupportにDisabledを更新します。 次の使用可能な値について説明します。
-
TranslateToFreshPasswordAuth- prompt=loginをwauth=https://schemas.microsoft.com/ws/2008/06/identity/authenticationmethod/passwordおよびwfresh=0に変換する既定のMicrosoft Entra ID動作を意味します。
-
NativeSupport - prompt=login パラメーターをそのまま ADFS に送信することを意味します。
-
Disabled - wfresh=0 のみが ADFS に送信されることを意味します
Get-EntraDomainFederationSettings -DomainName <your_domain_name> | Format-List *を使用して、フェデレーション ドメインのPreferredAuthenticationProtocolとPromptLoginBehaviorの値を取得します。
-
-DomainName パラメーターは、取得する完全修飾ドメイン名を指定します。
-
-PreferredAuthenticationProtocol パラメーターは、優先する認証プロトコルを指定します。
-
-PromptLoginBehavior パラメーターは、プロンプトのサインイン動作を指定します。
パラメーター
-ActiveLogOnUri
Microsoft Entra IDでのシングル サインオン (ID フェデレーションとも呼ばれます) 用に設定されたドメインを使用して認証するときにアクティブなクライアントが使用するエンドポイントを指定する URL。
パラメーターのプロパティ
| 型: | System.String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 6 |
| 必須: | False |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-DomainName
更新する完全修飾ドメイン名 (FQDN)。
パラメーターのプロパティ
| 型: | System.String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-FederationBrandName
Microsoft Entra IDにサインインするときにユーザーに表示される文字列値の名前。
お客様は、"Contoso Inc" などのユーザーにとってなじみのあるものを使用することをお勧めします。
パラメーターのプロパティ
| 型: | System.String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 8 |
| 必須: | False |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-IssuerUri
フェデレーション サーバーから派生したMicrosoft Entra ID ID プラットフォーム内のドメインの一意識別子。
パラメーターのプロパティ
| 型: | System.String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 7 |
| 必須: | False |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-LogOffUri
URL クライアントは、Microsoft Entra ID サービスからサインアウトしたときにリダイレクトされます。
パラメーターのプロパティ
| 型: | System.String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 4 |
| 必須: | False |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
Lync Online などのリッチ クライアント アプリケーションからの認証に使用されるメタデータ交換エンドポイントを指定する URL。
| 型: | System.String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
(All)
| 配置: | 9 |
| 必須: | False |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-NextSigningCertificate
プライマリ署名証明書の有効期限が切れたときにトークンの署名に使用される次のトークン署名証明書。
パラメーターのプロパティ
| 型: | System.String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 3 |
| 必須: | False |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-PassiveLogOnUri
web ベースのクライアントがMicrosoft Entra ID サービスにサインインするときに送信される URL。
パラメーターのプロパティ
| 型: | System.String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 5 |
| 必須: | False |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-PreferredAuthenticationProtocol
優先する認証プロトコルを指定します。
パラメーターのプロパティ
| 型: | System.String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 10 |
| 必須: | False |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-PromptLoginBehavior
プロンプト のログイン動作を指定します。
パラメーターのプロパティ
| 型: | System.String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 12 |
| 必須: | False |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-SigningCertificate
Microsoft Entra ID ID プラットフォームに渡されたトークンの署名に使用される現在の証明書。
パラメーターのプロパティ
| 型: | System.String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 2 |
| 必須: | False |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-SigningCertificateUpdateStatus
署名証明書の更新状態を指定します。
パラメーターのプロパティ
| 型: | System.Object
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 11 |
| 必須: | False |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。