Domains - List Domain Workspaces

Служба:: Admin

Версия API:: v1

Возвращает список рабочих областей, назначенных указанному домену.
Этот API поддерживает разбивки на страницы.

Разрешения

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

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

Tenant.Read.All или Tenant.ReadWrite.All.

Ограничения

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

Идентификаторы, поддерживаемые Microsoft Entra

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

Идентичность	Поддержка
Пользователь	Да
Представитель службы и управляемые удостоверения	Да

Интерфейс

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

С использованием необязательных параметров:

GET https://api.fabric.microsoft.com/v1/admin/domains/{domainId}/workspaces?continuationToken={continuationToken}

Параметры URI

Имя	В	Обязательно	Тип	Описание
domainId	path	True	string (uuid)	Идентификатор домена.
continuationToken	query		string	Маркер получения следующей страницы результатов.

Ответы

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

200 OK

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

DomainWorkspaces

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

429 Too Many Requests

ErrorResponse

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

Заголовки

Retry-After: integer

Other Status Codes

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

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

Примеры

Get all domain workspaces example

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

HTTP

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

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

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

{
  "value": [
    {
      "id": "e281785b-5608-41ac-a1a1-78b48b95b825",
      "displayName": "Mark8ProjectTeam"
    },
    {
      "id": "24402490-9519-48b9-9d51-b2db4095a56b",
      "displayName": "Team southern region"
    },
    {
      "id": "46f8ccd7-a209-4e12-978f-56ef3c44a68c",
      "displayName": "SalesAndMarketing"
    }
  ],
  "continuationToken": null,
  "continuationUri": null
}

Определения

Имя	Описание
DomainWorkspace	Представляет рабочую область в домене.
DomainWorkspaces	Оболочка ответа для списка всех рабочих областей, назначенных домену с непрерывным маркером.
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.

DomainWorkspace

Объект

Представляет рабочую область в домене.

Имя	Тип	Описание
displayName	string	Имя рабочей области.
id	string (uuid)	Идентификатор рабочей области.

DomainWorkspaces

Объект

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

Имя	Тип	Описание
continuationToken	string	Маркер для следующего пакета результирующих наборов. Если больше записей нет, он удаляется из ответа.
continuationUri	string	Универсальный код ресурса (URI) следующего пакета результирующих наборов. Если больше записей нет, он удаляется из ответа.
value	DomainWorkspace[]	Список всех рабочих областей, назначенных домену.

ErrorRelatedResource

Объект

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

Имя	Тип	Описание
resourceId	string	Идентификатор ресурса, участвующий в ошибке.
resourceType	string	Тип ресурса, который участвует в ошибке.

ErrorResponse

Объект

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

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
moreDetails	ErrorResponseDetails[]	Список дополнительных сведений об ошибке.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.
requestId	string (uuid)	Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Объект

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

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.