域资源类型
命名空间:microsoft.graph
表示与租户关联的域。
使用域操作将域关联到租户、验证域所有权并配置受支持的服务。 通过 Microsoft Graph 验证域不会配置域以用于 Exchange 等Office 365服务。 完全配置域以使用 Microsoft 365 产品可能需要额外的步骤。 有关详细信息,请参阅 Microsoft 365 管理员设置。
若要将域与租户关联,请执行以下操作:
将 域与租户关联。
检索 域验证记录。 使用域注册机构或 DNS 服务器配置将验证记录详细信息添加到域的区域文件。
验证 域的所有权。 这会验证域并将 isVerified 属性设置为
true
。指示 你计划与域一起使用的受支持服务。
通过检索为域启用服务所需的记录列表来配置受支持的服务。 使用域注册机构或 DNS 服务器配置将配置记录详细信息添加到域的区域文件。
方法
方法 | 返回类型 | Description |
---|---|---|
List | domain | 检索链接到租户的所有域。 |
创建 | domain | 向租户添加域。 |
Get | domain | 读取域对象的属性和关系。 |
获取根域 | domain | 获取子域的根域。 |
更新 | domain | 汇报域。 |
删除 | None | 删除域。 |
强制删除 | None | 使用异步操作删除域。 |
验证 | domain | 验证域的所有权。 |
Promote | 布尔值 | 将已验证的子域 升级 为根域。 |
列出域名引用 | directoryObject collection | 检索包含对域的引用的目录对象的列表。 |
列出服务配置记录 | domainDnsRecord 集合 | 检索域配置的域 DNS 记录列表。 |
列出验证 DNS 记录 | domainDnsRecord 集合 | 检索用于域验证的域 DNS 记录列表。 |
属性
属性 | 类型 | 说明 |
---|---|---|
authenticationType | String | 指示为域配置的身份验证类型。 值为 Managed 或 Federated 。
Managed 指示Microsoft Entra ID执行用户身份验证的云托管域。
Federated 指示身份验证通过 Active Directory 联合身份验证服务 与标识提供者(例如租户的本地 Active Directory)联合。 不可为 null。 若要在委托方案中更新此属性,必须为调用应用分配 Directory.AccessAsUser.All 委托权限。 |
availabilityStatus | String | 除非使用验证操作,否则此属性始终null 除外。 使用 验证 操作时,响应中会返回 域 实体。 响应中域实体的 availabilityStatus 属性为 AvailableImmediately 或 EmailVerifiedDomainTakeoverScheduled 。 |
id | String | 域的完全限定名称。 键,不可变,不可为 null,唯一。 |
isAdminManaged | 布尔值 | 如果域的 DNS 记录管理委托给 Microsoft 365,则 属性值 false 为 。 否则,值为 true 。 不可为 null |
isDefault | 布尔值 |
true 如果这是用于创建用户的默认域,则为 。 每个公司只有一个默认域。 不可为 null。 |
isInitial | 布尔值 |
true 如果这是 Microsoft Online Services (contoso.com) 创建的初始域,则为 。 每个公司只有一个初始域。 不可为 null |
isRoot | 布尔值 |
true 如果域是已验证的根域,则为 。 否则, false 如果域是子域或未验证域,则为 。 不可为 null。 |
isVerified | 布尔值 |
true 如果域已完成域所有权验证,则为 。 不可为 null。 |
passwordNotificationWindowInDays | Int32 | 指定用户收到密码过期通知之前的天数。 如果未设置 属性,则使用默认值 14 天。 |
passwordValidityPeriodInDays | Int32 | 指定密码在必须更改之前有效的时间长度。 如果未设置 属性,则使用默认值 90 天。 |
state | domainState | 为域计划的异步操作的状态。 |
supportedServices | 字符串集合 | 分配给域的功能。 可以包括 0 或1 更多以下值:Email 、、Sharepoint 、EmailInternalRelayOnly OfficeCommunicationsOnline 、SharePointDefaultDomain 、FullRedelegation 、SharePointPublic 、OrgIdAuthentication Yammer 、、 。 Intune 可以使用 API 添加或删除的值包括: Email 、 OfficeCommunicationsOnline 、 Yammer 。 不可为空。 |
关系
域与目录中其他对象(例如其验证记录和服务配置记录)之间的关系通过导航属性公开。 可以通过在请求中定位这些导航属性来读取这些关系。
关系 | 类型 | 说明 |
---|---|---|
domainNameReferences | directoryObject collection | 引用域 ID 的对象,例如用户和组。 只读,可为 Null。 不支持 $expand 。 由 $filter OData 类型的对象返回支持。 例如, /domains/{domainId}/domainNameReferences/microsoft.graph.user 和 /domains/{domainId}/domainNameReferences/microsoft.graph.group 。 |
federationConfiguration | internalDomainFederation | 与 Microsoft Entra ID 联合时由客户配置的域设置。 不支持 $expand 。 |
rootDomain | domain | 子域的根域。 只读,可为 Null。 支持 $expand 。 |
serviceConfigurationRecords | domainDnsRecord 集合 | DNS 记录客户添加到域的 DNS 区域文件,然后Microsoft Online 服务才能使用该域。 只读,可为 Null。 不支持 $expand 。 |
verificationDnsRecords | domainDnsRecord 集合 | 在客户可以使用Microsoft Entra ID完成域所有权验证之前,客户添加到域的 DNS 区域文件的 DNS 记录。 只读,可为 Null。 不支持 $expand 。 |
JSON 表示形式
以下 JSON 表示形式显示了资源类型。
{
"authenticationType": "String",
"availabilityStatus": "String",
"id": "String (identifier)",
"isAdminManaged": true,
"isDefault": true,
"isInitial": true,
"isRoot": true,
"isVerified": true,
"passwordNotificationWindowInDays": 14,
"passwordValidityPeriodInDays": 90,
"state": {"@odata.type": "microsoft.graph.domainState"},
"supportedServices": ["String"]
}