Domains - Update 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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
domainId	path	True	string (uuid)	Идентификатор домена.
preview	query	True	boolean	Этот параметр задает используемую версию API. Установите для `false` использования версии выпуска.

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

Имя	Тип	Описание
defaultLabelId	string (uuid)	Метка конфиденциальности домена по умолчанию. Чтобы удалить defaultLabelId из домена, задайте для него пустой идентификатор UUID в запросе: "0000000000-0000-0000-00000-00000000000000000000".
description	string	Описание домена. Описание не может содержать более 256 символов.
displayName	string	Отображаемое имя домена. Отображаемое имя не может содержать более 40 символов.

Имя

Тип

Описание

defaultLabelId

string (uuid)

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

Чтобы удалить defaultLabelId из домена, задайте для него пустой идентификатор UUID в запросе: "0000000000-0000-0000-00000-00000000000000000000".

description

string

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

displayName

string

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

Ответы

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

200 OK

Имя	Тип	Описание
200 OK	Domain	Запрос успешно завершен.
429 Too Many Requests	ErrorResponse	Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий `Retry-After` в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов. Заголовки Retry-After: integer
Other Status Codes	ErrorResponse	Распространенные коды ошибок: DomainNotFound — предоставленный домен не найден EntityConflict — сбой обновления домена, так как отображаемое имя домена уже существует. UnknownError — произошла ошибка.

Domain

Запрос успешно завершен.

429 Too Many Requests

ErrorResponse

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

Заголовки

Retry-After: integer

Other Status Codes

ErrorResponse

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

DomainNotFound — предоставленный домен не найден
EntityConflict — сбой обновления домена, так как отображаемое имя домена уже существует.
UnknownError — произошла ошибка.

Примеры

Update a domain example

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

HTTP

PATCH https://api.fabric.microsoft.com/v1/admin/domains/97dd1d38-a4c6-41ed-bc4f-1e383f8ddd0f?preview=false

{
  "displayName": "Domain's new name",
  "description": "Domain's new description",
  "defaultLabelId": "d9a6c724-a08f-429d-9fa9-9659c5181b7f"
}

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

Код состояния:: 200

{
  "id": "f2f6a374-789e-4d1d-9cc7-6e0b934fc529",
  "displayName": "Domain's new name",
  "description": "Domain's new description",
  "parentDomainId": null,
  "defaultLabelId": "d9a6c724-a08f-429d-9fa9-9659c5181b7f"
}

Определения

Имя	Описание
Domain
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
UpdateDomainRequest

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	Сведения об ошибках, связанных с ресурсом.

UpdateDomainRequest

Объект

Имя	Тип	Описание
defaultLabelId	string (uuid)	Метка конфиденциальности домена по умолчанию. Чтобы удалить defaultLabelId из домена, задайте для него пустой идентификатор UUID в запросе: "0000000000-0000-0000-00000-00000000000000000000".
description	string	Описание домена. Описание не может содержать более 256 символов.
displayName	string	Отображаемое имя домена. Отображаемое имя не может содержать более 40 символов.

Имя

Тип

Описание

defaultLabelId

string (uuid)

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

description

string

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

displayName

string

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