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

Статья
02/23/2024

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

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

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

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

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

Методы

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

Свойства

Свойство	Тип	Описание
authenticationType	String	Указывает настроенный тип проверки подлинности для домена. Значение равно или `ManagedFederated`. `Managed`указывает управляемый облачный домен, в котором Microsoft Entra ID выполняет проверку подлинности пользователей. `Federated`указывает, что проверка подлинности является федеративной с поставщиком удостоверений, например с локальная служба Active Directory клиента, через службы федерации Active Directory (AD FS). Значение 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.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`. Значение null не допускается.

Связи

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

Связь	Тип	Описание
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 ID. Только для чтения, допускает значение 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"]
}