域资源类型
命名空间:microsoft.graph
表示与租户关联的域。
使用域操作将域关联到租户,验证域所有权并配置受支持的服务。 域操作使注册机构能够为 Microsoft 365 等服务自动执行域关联。 例如,作为域注册的一部分,注册机构可以为电子邮件、网站、身份验证等启用虚荣域。
若要将域与租户关联,请执行下表操作:
将 域与租户关联。
检索 域验证记录。 使用域注册机构或 DNS 服务器配置将验证记录详细信息添加到域的区域文件。
验证 域的所有权。 这将验证域并将 isVerified 属性设置为
true。指示 计划与域一起使用的受支持服务。
通过检索启用域服务所需的记录列表来配置支持的服务。 使用域注册机构或 DNS 服务器配置将配置记录详细信息添加到域的区域文件。
方法
| 方法 | 返回类型 | 说明 |
|---|---|---|
| 获取域 | domain | 读取域对象的属性和关系。 |
| 创建域 | domain | 向租户添加域。 |
| 列出域 | domain | 检索链接到租户的所有域。 |
| 列出 domainNameReference | directoryObject 集合 | 检索引用域的目录对象列表。 |
| 列出 serviceConfigurationRecords | domainDnsRecord 集合 | 检索域配置的域 DNS 记录列表。 |
| 列出 verificationDnsRecords | domainDnsRecord 集合 | 检索域 DNS 记录的列表以进行域验证。 |
| 更新域 | domain | 更新域。 |
| 删除域 | 无 | 删除域。 |
| ForceDelete 域 | 无 | 使用异步操作删除域。 |
| 验证域 | domain | 验证域的所有权。 |
属性
| 属性 | 类型 | 说明 |
|---|---|---|
| authenticationType | String | 指示为域配置的身份验证类型。 值为或 Managed Federated. Managed 指示 Azure AD 执行用户身份验证的云托管域。 Federated指示身份验证通过Active Directory 联合身份验证服务与标识提供者(例如租户的本地 Active Directory)联合。 此属性为只读属性,不可为 null。 |
| availabilityStatus | String | 此属性始终 null 是使用 验证 操作时除外。 使用 验证 操作时,会在响应中返回 域 实体。 响应中 域 实体的 availabilityStatus 属性为或 AvailableImmediately EmailVerifiedDomainTakeoverScheduled。 |
| id | String | 域的完全限定名称。 键,不可变,不可为 null,唯一。 |
| isAdminManaged | Boolean | 该属性的值是 false 域的 DNS 记录管理是否已委托给 Microsoft 365。 否则,值为 true. 不可为 null |
| isDefault | Boolean | true 如果这是用于创建用户的默认域。 每个公司只有一个默认域。 不可为 null |
| isInitial | Boolean | true 如果这是 Microsoft Online Services (companyname.onmicrosoft.com) 创建的初始域。 每个公司只有一个初始域。 不可为 null |
| isRoot | Boolean | true 如果域是已验证的根域, 否则, false 如果域是子域或未验证。 不可为 null |
| isVerified | Boolean | true 如果域已完成域所有权验证。 不可为 null |
| passwordNotificationWindowInDays | Int32 | 指定用户收到其密码过期通知之前的天数。 如果未设置该属性,将使用默认值 14 天。 |
| passwordValidityPeriodInDays | Int32 | 指定必须更改密码之前密码有效的时间长度。 如果未设置该属性,将使用默认值 90 天。 |
| supportedServices | String collection | 分配给域的功能。 可以包含0``1或包含以下值的更多内容:Email、Sharepoint、、EmailInternalRelayOnly``OfficeCommunicationsOnline、SharePointDefaultDomain、FullRedelegation、SharePointPublic、、OrgIdAuthentication、。 Intune``Yammer 可以使用图形 API添加/删除的值包括: Email, , OfficeCommunicationsOnline。 Yammer 不可为 null。 |
| state | domainState | 为域计划异步操作的状态。 |
关系
域与目录中的其他对象(如验证记录和服务配置记录)之间的关系通过导航属性公开。 可以通过在请求中针对这些导航属性来读取这些关系。
| 关系 | 类型 | 说明 |
|---|---|---|
| domainNameReferences | directoryObject 集合 | 引用域 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 集合 | 在客户可以使用 Azure AD 完成域所有权验证之前,DNS 记录客户添加到域的 DNS 区域文件。 只读,可为 Null。 支持 $expand。 |
| federationConfiguration | internalDomainFederation | 客户在与 Azure AD 联合时配置的域设置。 支持 $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"]
}
反馈
提交和查看相关反馈