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

Domains - Update Domain

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

Заметка

Этот API находится в предварительной версии.

Обновляет указанные сведения о домене.

Разрешения

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

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

Tenant.ReadWrite.All.

Ограничения

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

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

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

Тождество Поддержка
Пользователь Да
субъекта-службы и управляемых удостоверений Да

Интерфейс

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

Параметры URI

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

string

uuid

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

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

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

ContributorsScopeType

Область участников домена.
description

string

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

string

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

Ответы

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

Domain

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

ErrorResponse

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

  • UnknownError — произошла ошибка.

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

Примеры

Update a domain example

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

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

{
  "displayName": "Domain's new name",
  "description": "Domain's new description",
  "contributorsScope": "SpecificUsersAndGroups"
}

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

Код состояния:
200 
{
  "id": "f2f6a374-789e-4d1d-9cc7-6e0b934fc529",
  "displayName": "Domain's new name",
  "description": "Domain's new description",
  "parentDomainId": null,
  "contributorsScope": "SpecificUsersAndGroups"
}

Определения

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

Область участника. С течением времени могут добавляться дополнительные области участников.
Domain

Представляет домен или поддомен.
ErrorRelatedResource

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

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

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

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

ContributorsScopeType

Перечисление

Область участника. С течением времени могут добавляться дополнительные области участников.

Значение Описание
AdminsOnly

Только администраторы клиента и домена.
AllTenant

Все пользователи клиента.
SpecificUsersAndGroups

Определенные пользователи и группы.

Domain

Object

Представляет домен или поддомен.

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

ContributorsScopeType

Область участников домена.
description

string

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

string

Имя домена.
id

string

uuid

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

string

uuid

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

ErrorRelatedResource

Object

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

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

string

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

string

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

ErrorResponse

Object

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

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

string

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

string

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

ErrorResponseDetails[]

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

ErrorRelatedResource

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

string

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

ErrorResponseDetails

Object

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

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

string

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

string

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

ErrorRelatedResource

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

UpdateDomainRequest

Object

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

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

ContributorsScopeType

Область участников домена.
description

string

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

string

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