Domains - Create Domain

Служба:
Admin
Версия API:
v1

Создает новый домен.

Note

Этот API является версией предварительной версии предварительной версии из-за нерекомендуемой 31 марта 2026 г. При вызове этого API вызывающие должны задать параметр preview запроса значением. false

Permissions

Вызывающий объект должен быть администратором Fabric.

Обязательные делегированные области

Tenant.ReadWrite.All.

Limitations

Не более 25 запросов в одну минуту на участника.

Поддерживаемые удостоверения Microsoft Entra

Этот API поддерживает идентичности Microsoft, перечисленные в этом разделе.

Identity Support
User Yes
Представитель службы и управляемые удостоверения Yes

Interface

POST https://api.fabric.microsoft.com/v1/admin/domains?preview={preview}

Параметры URI

Имя В Обязательно Тип Описание
preview
 query True

boolean

Этот параметр задает используемую версию API. Установите для false использования версии выпуска.

Текст запроса

Имя Обязательно Тип Описание
displayName True

string

Отображаемое имя домена. Отображаемое имя не может содержать более 40 символов.
description

string

Описание домена. Описание не может содержать более 256 символов.
parentDomainId

string (uuid)

Идентификатор родительского объекта домена.

Ответы

Имя Тип Описание
201 Created

Domain

Домен успешно создан.
429 Too Many Requests

ErrorResponse

Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий Retry-After в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов.

Заголовки

Retry-After: integer
Other Status Codes

ErrorResponse

Распространенные коды ошибок:

  • EntityNotFound — не удалось создать домен, так как родительский идентификатор домена не найден.

  • EntityConflict — не удалось создать домен, так как отображаемое имя домена уже существует.

  • InvalidInput — недопустимый идентификатор родительского домена.

Примеры

Create a domain example

Образец запроса

POST https://api.fabric.microsoft.com/v1/admin/domains?preview=false

{
  "displayName": "Finance",
  "description": "This domain is used for identifying financial data and reports.",
  "parentDomainId": "5f6552c3-816c-43e7-8289-842f8b35f9df"
}

Пример ответа

Код состояния:
201 
{
  "id": "9eba6944-daff-4441-b9b5-630ce34238fd",
  "displayName": "Finance",
  "description": "This domain is used for identifying financial data and reports.",
  "parentDomainId": "5f6552c3-816c-43e7-8289-842f8b35f9df"
}

Определения

Имя Описание
CreateDomainRequest

Полезные данные запроса для создания домена или поддомена.
Domain
ErrorRelatedResource

Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse

Ответ на ошибку.
ErrorResponseDetails

Сведения об ответе на ошибку.

CreateDomainRequest

Объект

Полезные данные запроса для создания домена или поддомена.

Имя Тип Описание
description

string

Описание домена. Описание не может содержать более 256 символов.
displayName

string

Отображаемое имя домена. Отображаемое имя не может содержать более 40 символов.
parentDomainId

string (uuid)

Идентификатор родительского объекта домена.

Domain

Объект
Имя Тип Описание
defaultLabelId

string (uuid)

Метка конфиденциальности домена по умолчанию.
description

string

Описание домена.
displayName

string

Имя домена.
id

string (uuid)

Идентификатор объекта домена.
parentDomainId

string (uuid)

Идентификатор родительского объекта домена.

ErrorRelatedResource

Объект

Объект сведений об ошибках, связанных с ресурсом.

Имя Тип Описание
resourceId

string

Идентификатор ресурса, участвующий в ошибке.
resourceType

string

Тип ресурса, который участвует в ошибке.

ErrorResponse

Объект

Ответ на ошибку.

Имя Тип Описание
errorCode

string

Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message

string

Удобочитаемое представление ошибки.
moreDetails

ErrorResponseDetails[]

Список дополнительных сведений об ошибке.
relatedResource

ErrorRelatedResource

Сведения об ошибках, связанных с ресурсом.
requestId

string (uuid)

Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Объект

Сведения об ответе на ошибку.

Имя Тип Описание
errorCode

string

Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message

string

Удобочитаемое представление ошибки.
relatedResource

ErrorRelatedResource

Сведения об ошибках, связанных с ресурсом.