homeRealmDiscoveryPolicy 资源类型

命名空间：microsoft.graph

重要

Microsoft Graph版本下的 /beta API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。

表示用于控制联盟Azure Active Directory身份验证行为的策略，特别是针对联合域中的自动加速和用户身份验证限制。 您可以为组织的所有服务主体或组织的特定服务主体设置 homeRealmDiscoveryPolicy。 有关更多方案和策略详细信息，请参阅 Configure Azure AD sign in behavior for an application by using a Home Realm Discovery policy以及 Sign-in to Azure Active Directory using email as an alternate login ID。

继承自 stsPolicy。

方法

方法	返回类型	说明
创建 homeRealmDiscoveryPolicy	homeRealmDiscoveryPolicy	创建 homeRealmDiscoveryPolicy 对象。
获取 homeRealmDiscoveryPolicy	homeRealmDiscoveryPolicy	读取 homeRealmDiscoveryPolicy 对象的属性和关系。
列出 homeRealmDiscoveryPolicy	homeRealmDiscoveryPolicy	读取 homeRealmDiscoveryPolicies 对象的属性和关系。
更新 homeRealmDiscoveryPolicy	无	更新 homeRealmDiscoveryPolicy 对象。
删除 homeRealmDiscoveryPolicy	无	删除 homeRealmDiscoveryPolicy 对象。
List appliesTo	directoryObject collection	获取已应用此策略的 directoryObjects 列表。
分配 homeRealmDiscoveryPolicy	无	将 homeRealmDiscoveryPolicy 对象分配给 servicePrincipal 对象。
列出分配的 homeRealmDiscoveryPolicy	homeRealmDiscoveryPolicy 集合	列出分配给 servicePrincipal 对象的 homeRealmDiscoveryPolicy 对象。
删除 homeRealmDiscoveryPolicy	无	从 servicePrincipal 对象中删除 homeRealmDiscoveryPolicy 对象。

属性

属性	类型	说明
id	字符串	此策略的唯一标识符。 只读。
definition	字符串集合	包含 JSON 字符串的字符串集合，用于定义此策略的规则和设置。 有关 此属性的 JSON 架构的更多详细信息，请参阅主领域发现策略定义的属性。 必需。
description	字符串	此策略的说明。
displayName	字符串	此策略的显示名称。 必需。
isOrganizationDefault	布尔值	如果设置为 true，则激活此策略。 同一策略类型可以有很多策略，但只有一个策略可以激活为组织默认策略。 可选，默认值为 false。

主领域发现策略定义的属性

下面的属性构成表示令牌生存期策略的 JSON 对象。 此 JSON 对象必须 转换为 转义为要插入到定义属性中的 引号的字符串 。 下面以 JSON 格式显示了一个示例：

"definition": [
    "{
        \"HomeRealmDiscoveryPolicy\": {
          \"AccelerateToFederatedDomain\":true,
          \"AllowCloudPasswordValidation\": false,
          \"PreferredDomain\":\"federated.example.edu\",
          \"AlternateIdLogin\":{
            \"Enabled\":true
          }
        }
      }"
  ]

属性	类型	说明
AccelerateToFederatedDomain	布尔值	如果设置为， true 则自动加速 (主领域发现) 。 true如果租户中只有一个已验证和联合域，用户将直接进入联合身份提供程序 (如 ADFS) 登录。 如果 true 租户中存在多个已验证域，则必须指定 PreferredDomain 。 可选。
AllowCloudPasswordValidation	布尔值	true设置为 以允许应用程序通过直接向令牌终结点呈现用户名/密码凭据来Azure Active Directory用户。 仅在启用密码哈希同步时有效。 可选。
AlternateIdLogin	Json	{\"Enabled\": true}设置为 以允许Azure AD作为备用登录 ID 使用电子邮件登录。 仅在 IsOrganizationDefault 设置为 时有效 true。 可选。
PreferredDomain	字符串	指定加速登录的域。 如果租户只有一个联盟域，可以省略它。 如果省略它，并且存在多个已验证的联合域，则此策略不起作用。 如果 AccelerateToFederatedDomain 为 ，则必需 true。

关系

关系	类型	说明
appliesTo	directoryObject 集合	已应用此策略的 directoryObject 集合。 只读。

JSON 表示形式

下面是资源的 JSON 表示形式。

{
  "definition": ["String"],
  "description": "String",
  "displayName": "String",
  "id": "String (identifier)",
  "isOrganizationDefault": true
}