Workspaces - List Workspaces

Служба:

Admin

Версия API:

v1

Возвращает список рабочих областей.

Note

Этот API является частью предварительного выпуска и предоставляется только для оценки и разработки. Он может измениться на основе отзывов и не рекомендуется для использования в рабочей среде.

Этот API поддерживает разбиение на страницы. Для каждого запроса можно вернуть не более 10 000 записей. С помощью непрерывного маркера, предоставленного в ответе, можно получить следующие 10 000 записей.

Permissions

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

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

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

Limitations

Максимум 200 запросов в час.

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

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

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

Interface

GET https://api.fabric.microsoft.com/v1/admin/workspaces

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

GET https://api.fabric.microsoft.com/v1/admin/workspaces?type={type}&capacityId={capacityId}&name={name}&state={state}&continuationToken={continuationToken}

Параметры URI

Имя	В	Обязательно	Тип	Описание
capacityId	query		string (uuid)	Идентификатор емкости рабочей области.
continuationToken	query		string	Маркер продолжения. Используется для получения следующих элементов в списке.
name	query		string	Имя рабочей области.
state	query		string	Состояние рабочей области. Поддерживаемые состояния активны и удалены.
type	query		string	Тип рабочей области. Поддерживаемые типы — личные, рабочие области, администрирование.

Ответы

Имя	Тип	Описание
200 OK	Workspaces	Операция прошла успешно.
Other Status Codes	ErrorResponse	Распространенные коды ошибок: BadRequest — параметры запроса, такие как workspaceType или workspaceState недопустимые. НедостаточноPrivileges — вызывающий объект не имеет разрешений на вызов API.

Примеры

Get a list of workspaces example

Get a list of workspaces using state query parameter example

Get a list of workspaces example

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

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces

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

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

200

{
  "workspaces": [
    {
      "id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
      "name": "test report",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9"
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

Get a list of workspaces using state query parameter example

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

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces?state=Active

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

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

200

{
  "workspaces": [
    {
      "id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
      "name": "test report",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84"
    }
  ],
  "continuationUri": null,
  "continuationToken": null
}

Определения

Имя	Описание
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
Workspace	Workspace.
Workspaces	Список рабочих областей.
WorkspaceState	Состояние рабочей области. С течением времени могут добавляться дополнительные состояния рабочей области.
WorkspaceType	Тип рабочей области. С течением времени могут добавляться дополнительные типы рабочих областей.

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

Workspace

Object

Workspace.

Имя	Тип	Описание
capacityId	string (uuid)	Идентификатор емкости рабочей области.
domainId	string (uuid)	Идентификатор домена рабочей области.
id	string (uuid)	Идентификатор рабочей области.
name	string	Имя рабочей области.
state	WorkspaceState	Состояние рабочей области.
type	WorkspaceType	Тип рабочей области.

Workspaces

Object

Список рабочих областей.

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

WorkspaceState

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

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

Значение	Описание
Active	Рабочая область активна. Потерянные рабочие области отображаются как активные.
Deleted	Рабочая область удаляется.

WorkspaceType

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

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

Значение	Описание
Personal	Моя папка или моя рабочая область, используемая для управления элементами пользователя.
Workspace	Рабочая область, используемая для управления элементами Fabric.
AdminWorkspace	Рабочая область мониторинга администратора. Содержит отчеты администратора, такие как отчет аудита и отчет об использовании и внедрении.