域资源类型domain resource type

表示与租户关联的域。Represents a domain associated with the tenant.

使用域操作将域与租户相关联, 验证域所有权并配置受支持的服务。Use domain operations to associate domains to a tenant, verify domain ownership, and configure supported services. 域操作使注册机构能够自动为 Office 365 等服务的域关联。Domain operations enable registrars to automate domain association for services such as Office 365. 例如, 在注册域的过程中, 注册机构可以为电子邮件、网站、身份验证等启用虚域。For example, as part of domain sign up, a registrar can enable a vanity domain for email, websites, authentication, etc.

将域与租户相关联:To associate a domain with a tenant:

  1. 将域与租户相关联Associate a domain with a tenant.

  2. 检索域验证记录。Retrieve the domain verification records. 使用域注册机构或 DNS 服务器配置将验证记录详细信息添加到域的区域文件。Add the verification record details to the domain's zone file using the domain registrar or DNS server configuration.

  3. 验证域的所有权。Verify the ownership of the domain. 这将验证域并将isVerified属性设置为trueThis will verify the domain and set the isVerified property to true.

  4. 指明计划与域一起使用的受支持服务。Indicate the supported services you plan to use with the domain.

  5. 通过检索为域启用服务所需的记录列表来配置受支持的服务。Configure supported services by retrieving a list of records needed to enable services for the domain. 使用域注册机构或 DNS 服务器配置将配置记录详细信息添加到域的区域文件中。Add the configuration record details to the domain's zone file using the domain registrar or DNS server configuration.

方法Methods

方法Method 返回类型Return Type 说明Description
获取域Get domain domaindomain 读取域对象的属性和关系。Read properties and relationships of a domain object.
创建域Create domain domaindomain 向租户添加域。Adds a domain to the tenant.
列出 domainNameReferenceList domainNameReference directoryObject collectiondirectoryObject collection 使用对域的引用检索目录对象的列表。Retrieve a list of directory objects with a reference to the domain.
列出 serviceConfigurationRecordsList serviceConfigurationRecords domainDnsRecord集合domainDnsRecord collection 检索域配置的域 DNS 记录列表。Retrieve a list of domain DNS records for domain configuration.
列出 verificationDnsRecordsList verificationDnsRecords domainDnsRecord集合domainDnsRecord collection 检索域验证的域 DNS 记录列表。Retrieve a list of domain DNS records for domain verification.
更新域Update domain domaindomain 更新域。Updates a domain.
删除域Delete domain None 删除域。Deletes a domain.
ForceDelete 域ForceDelete domain None 使用异步操作删除域。Deletes a domain using an asynchronous operation.
验证域Verify domain domaindomain 验证域的所有权。Validates the ownership of the domain.

属性Properties

属性Property 类型Type 说明Description
authenticationTypeauthenticationType StringString 指示为域配置的身份验证类型。Indicates the configured authentication type for the domain. 值为 "托管" 或 "联合"。The value is either Managed or Federated.
托管表示 Azure AD 执行用户身份验证的云托管域。Managed indicates a cloud managed domain where Azure AD performs user authentication.
联合指示身份验证通过使用标识提供程序 (如通过 Active Directory 联合身份验证服务的租户的本地 Active directory) 进行联合。Federated indicates authentication is federated with an identity provider such as the tenant's on-premises Active Directory via Active Directory Federation Services. 不可为 nullNot nullable
availabilityStatusavailabilityStatus StringString 除非使用了verify操作, 否则此属性始终为 null。This property is always null except when the verify action is used. 使用验证操作时, 会在响应中返回实体。When the verify action is used, a domain entity is returned in the response. 响应中的实体的AvailabilityStatus属性为AvailableImmediatelyEmailVerifiedDomainTakeoverScheduledThe availabilityStatus property of the domain entity in the response is either AvailableImmediately or EmailVerifiedDomainTakeoverScheduled.
idid StringString 域的完全限定的名称。The fully qualified name of the domain. 键、不可变、不可为 null、唯一Key, immutable, not nullable, unique
isAdminManagedisAdminManaged BooleanBoolean 如果域的 DNS 记录管理已委派给 Office 365, 则该属性的值为 false。The value of the property is false if the DNS record management of the domain has been delegated to Office 365. 否则, 该值为 true。Otherwise, the value is true. 不可为 nullNot nullable
isDefaultisDefault BooleanBoolean 如果这是用于创建用户的默认域, 则为 True。True if this is the default domain that is used for user creation. 每个公司只有一个默认域。There is only one default domain per company. 不可为 nullNot nullable
isInitialisInitial BooleanBoolean 如果这是 Microsoft Online Services (companyname.onmicrosoft.com) 创建的初始域, 则为 True。True if this is the initial domain created by Microsoft Online Services (companyname.onmicrosoft.com). 每个公司只有一个初始域。There is only one initial domain per company. 不可为 nullNot nullable
isRootisRoot BooleanBoolean 如果域是经过验证的根域, 则为 True。True if the domain is a verified root domain. 否则, 如果域是子域或未验证, 则为 false。Otherwise, false if the domain is a subdomain or unverified. 不可为 nullNot nullable
isVerifiedisVerified BooleanBoolean 如果域已完成域所有权验证, 则为 True。True if the domain has completed domain ownership verification. 不可为 nullNot nullable
passwordNotificationWindowInDayspasswordNotificationWindowInDays Int32Int32 指定用户收到其密码将到期的通知之前的天数。Specifies the number of days before a user receives notification that their password will expire. 如果未设置该属性, 则将使用默认值14天。If the property is not set, a default value of 14 days will be used.
passwordValidityPeriodInDayspasswordValidityPeriodInDays Int32Int32 指定密码在必须更改之前有效的时间长度。Specifies the length of time that a password is valid before it must be changed. 如果未设置该属性, 则将使用默认值90天。If the property is not set, a default value of 90 days will be used.
supportedServicessupportedServices String collectionString collection 分配给域的功能。The capabilities assigned to the domain.

可以包含0个、1个或更多的以下值: EmailSharepointEmailInternalRelayOnlyOfficeCommunicationsOnlineSharePointDefaultDomainFullRedelegationSharePointPublicOrgIdAuthenticationYammerIntuneCan include 0, 1 or more of following values: Email, Sharepoint, EmailInternalRelayOnly, OfficeCommunicationsOnline, SharePointDefaultDomain, FullRedelegation, SharePointPublic, OrgIdAuthentication, Yammer, Intune

您可以使用 Graph API 添加/删除的值包括: EmailOfficeCommunicationsOnlineYammerThe values which you can add/remove using Graph API include: Email, OfficeCommunicationsOnline, Yammer
不可为 nullNot nullable
statestate domainStatedomainState 为域计划的异步操作的状态。Status of asynchronous operations scheduled for the domain.

关系Relationships

域和目录中的其他对象 (如其验证记录和服务配置记录) 之间的关系通过导航属性公开。Relationships between a domain and other objects in the directory such as its verification records and service configuration records are exposed through navigation properties. 您可以通过在请求中将这些导航属性作为目标来读取这些关系。You can read these relationships by targeting these navigation properties in your requests.

关系Relationship 类型Type 说明Description
domainNameReferencesdomainNameReferences directoryObject collectiondirectoryObject collection 只读、可以为 NullRead-only, Nullable
serviceConfigurationRecordsserviceConfigurationRecords domainDnsRecord集合domainDnsRecord collection 在 Microsoft Online services 可以使用域之前, 客户添加到域的 DNS 区域文件中的 DNS 记录。DNS records the customer adds to the DNS zone file of the domain before the domain can be used by Microsoft Online services.
只读、可以为 NullRead-only, Nullable
verificationDnsRecordsverificationDnsRecords domainDnsRecord集合domainDnsRecord collection 在客户可以使用 Azure AD 完成域所有权验证之前, 客户添加到域的 DNS 区域文件中的 DNS 记录。DNS records that the customer adds to the DNS zone file of the domain before the customer can complete domain ownership verification with Azure AD.
只读、可以为 NullRead-only, Nullable

JSON 表示形式JSON representation

下面是资源的 JSON 表示形式。Here is a JSON representation of the resource.

{
  "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"]
}