тип ресурса домена

Статья
05/30/2024

Пространство имен: microsoft.graph

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Представляет домен, связанный с клиентом.

Используйте операции с доменом, чтобы связать домены с клиентом, проверить владение доменом и настроить поддерживаемые службы. Операции с доменом позволяют регистраторам автоматизировать связывание доменов для таких служб, как Microsoft 365. Например, в рамках регистрации домена регистратор может включить домен тщеславия для электронной почты, веб-сайтов, проверки подлинности и т. д.

Чтобы связать домен с клиентом, выполните приведенные далее действия.

Связывание домена с клиентом.
Получите записи проверки домена. Добавьте сведения о записи проверки в файл зоны домена с помощью регистратора доменных имен или конфигурации dns-сервера.
Проверьте владение доменом и задайте для свойства isVerified значение true.
Укажите поддерживаемые службы, которые планируется использовать с доменом.
Настройте поддерживаемые службы, извлекая список записей, необходимых для включения служб для домена. Добавьте сведения о записи конфигурации в файл зоны домена с помощью регистратора доменных имен или конфигурации DNS-сервера.

Методы

Метод	Возвращаемый тип	Описание
Список	domain;	Получите все домены, связанные с клиентом.
Создание	domain;	Добавьте домен в клиент.
Получение	domain;	Чтение свойств и связей объекта предметной области.
Обновление	domain;	Обновите домен.
удаление;	Нет	Удаление домена.
Принудительное удаление	Нет	Удаление домена с помощью асинхронной операции.
Проверять	domain;	Проверьте владение доменом.
Promote	Логический	Повышение уровня проверенного поддомена до корневого домена.
Получение корневого домена	Получите корневой домен поддомена.
Перечисление ссылок на доменные имена	Коллекция directoryObject	Получите список объектов каталога со ссылкой на домен.
Перечисление записей конфигурации службы	коллекция domainDnsRecord	Получение списка записей DNS домена для настройки домена.
Вывод списка записей DNS для проверки	коллекция domainDnsRecord	Получение списка записей DNS домена для проверки домена.

Свойства

Свойство	Тип	Описание
authenticationType	String	Указывает настроенный тип проверки подлинности для домена. Значение равно или `ManagedFederated`. `Managed` указывает управляемый облачным доменом, где Идентификатор Microsoft Entra выполняет проверку подлинности пользователя. `Federated` указывает, что проверка подлинности является федеративной с поставщиком удостоверений, например локальной службой Active Directory клиента, через службы федерации Active Directory. Значение null не допускается. Чтобы обновить это свойство в делегированных сценариях, вызывающему приложению должно быть назначено делегированное разрешение Directory.AccessAsUser.All .
availabilityStatus	String	Это свойство всегда `null` имеет значение, за исключением случаев, когда используется действие проверки . При использовании действия проверки в ответе возвращается сущность домена . Свойство availabilityStatus сущности домена в ответе имеет значение `AvailableImmediately` или `EmailVerifiedDomainTakeoverScheduled`.
id	String	Полное имя домена. Ключ, неизменяемый, не допускающий значения NULL, уникальный.
isAdminManaged	Логический	Значение свойства равно, `false` если управление записями DNS домена делегировано Microsoft 365. В противном случае значение равно `true`. Значение null не допускается.
isDefault	Логический	`true` для домена по умолчанию, используемого для создания пользователей. Существует только один домен по умолчанию для каждой компании. Значение null не допускается.
isInitial	Логический	`true` для начального домена, созданного Microsoft Online Services. Например, `contoso.onmicrosoft.com`. На каждую компанию имеется только один начальный домен. Значение null не допускается.
isRoot	Логический	`true` Значение , если домен является проверенным корневым доменом. В противном случае , `false` если домен является поддоменом или непроверен. Значение null не допускается.
isVerified	Логический	`true` для проверенных доменов. Значение null не допускается.
passwordNotificationWindowInDays	Int32	Указывает количество дней, в течение которых пользователь получит уведомление об истечении срока действия пароля. 14 дней по умолчанию.
passwordValidityPeriodInDays	Int32	Указывает срок действия пароля до его изменения. 90 дней по умолчанию.
supportedServices	Коллекция строк	Возможности, назначенные домену. Может включать `0`, `1`или несколько из следующих значений: `Email`, `Sharepoint`, `EmailInternalRelayOnly`, `OfficeCommunicationsOnline`, , `FullRedelegationSharePointDefaultDomain`, `SharePointPublic`, `OrgIdAuthenticationYammerIntune`, . `CustomUrlDomain` Значения, которые можно добавить или удалить с помощью API: `Email`, `OfficeCommunicationsOnline`, `Yammer`и `CustomUrlDomain`. Значение null не допускается. Дополнительные сведения о `CustomUrlDomain`см. в разделе Личные домены URL-адресов во внешних клиентах.
state	domainState	Состояние асинхронных операций, запланированных для домена.

Связи

Связи между доменом и другими объектами в каталоге, такими как его записи проверки и записи конфигурации службы, предоставляются через свойства навигации. Эти связи можно прочитать, нацелив на эти свойства навигации в запросах.

Связь	Тип	Описание
domainNameReferences	Коллекция directoryObject	Такие объекты, как пользователи и группы, ссылающиеся на идентификатор домена. Только для чтения, допускает значение NULL. Поддерживает `$expand` и `$filter` по типу OData возвращаемых объектов. Например, `/domains/{domainId}/domainNameReferences/microsoft.graph.user` и `/domains/{domainId}/domainNameReferences/microsoft.graph.group`.
serviceConfigurationRecords	коллекция domainDnsRecord	DNS записывает, что клиент добавляет в dns-файл зоны домена, прежде чем домен можно будет использовать службами Microsoft Online. Только для чтения, допускает значение NULL. Поддерживает `$expand`.
verificationDnsRecords	коллекция domainDnsRecord	Записи DNS, добавляемые клиентом в файл зоны DNS домена, прежде чем клиент сможет пройти проверку владения доменом с помощью идентификатора Microsoft Entra. Только для чтения, допускает значение NULL. Поддерживает `$expand`.
federationConfiguration	internalDomainFederation	Параметры домена, настроенные клиентом при федерации с идентификатором Microsoft Entra. Поддерживает `$expand`.
rootDomain	domain;	Корневой домен поддомена. Только для чтения, допускает значение 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"]
}

Поделиться через