域资源类型

命名空间：microsoft.graph

表示与租户关联的域。

使用域操作将域关联到租户、验证域所有权并配置受支持的服务。 域操作使注册机构能够自动执行 Microsoft 365 等服务的域关联。 例如，作为域注册的一部分，注册机构可以为电子邮件、网站、身份验证等启用虚域。

若要将域与租户关联，请执行以下操作：

1. 将 域与租户关联。

2. 检索 域验证记录。 使用域注册机构或 DNS 服务器配置将验证记录详细信息添加到域的区域文件。

3. 验证 域的所有权。 这会验证域并将 isVerified 属性设置为 true。

4. 指示 你计划与域一起使用的受支持服务。

5. 通过检索为域启用服务所需的记录列表来配置受支持的服务。 使用域注册机构或 DNS 服务器配置将配置记录详细信息添加到域的区域文件。

方法

方法	返回类型	说明
获取域	domain	读取域对象的属性和关系。
创建域	domain	向租户添加域。
列表域	domain	检索链接到租户的所有域。
列出 domainNameReference	directoryObject collection	检索包含对域的引用的目录对象的列表。
列出 serviceConfigurationRecords	domainDnsRecord 集合	检索域配置的域 DNS 记录列表。
列出 verificationDnsRecords	domainDnsRecord 集合	检索用于域验证的域 DNS 记录列表。
更新域	domain	汇报域。
删除域	无	删除域。
ForceDelete 域	无	使用异步操作删除域。
验证域	domain	验证域的所有权。
提升域	布尔值	将已验证的子域 升级 为根域。

属性

属性	类型	说明
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、EmailInternalRelayOnlyOfficeCommunicationsOnline、SharePointDefaultDomain、FullRedelegation、SharePointPublic、OrgIdAuthenticationYammer、、 。 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。
serviceConfigurationRecords	domainDnsRecord 集合	在 Microsoft Online 服务可以使用域之前，DNS 记录客户添加到域的 DNS 区域文件。 只读，可为 Null。 支持 $expand。
verificationDnsRecords	domainDnsRecord 集合	在客户可以使用Microsoft Entra ID完成域所有权验证之前，客户添加到域的 DNS 区域文件的 DNS 记录。 只读，可为 Null。 支持 $expand。
federationConfiguration	internalDomainFederation	与 Microsoft Entra ID 联合时由客户配置的域设置。 支持 $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"]
}