Workspaces - List Workspaces

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

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

Permissions

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

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

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

Limitations

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

Фильтр encryptionStatus применяется только в том случае, если include параметр содержит encryption.

Идентификаторы, поддерживаемые 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}&encryptionStatus={encryptionStatus}&include={include}

Параметры URI

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

string (uuid)

Идентификатор емкости рабочей области.
continuationToken
 query

string

Маркер продолжения. Используется для получения следующих элементов в списке.
encryptionStatus
 query

string

Указывает состояние шифрования CMK рабочей области и используется для фильтрации рабочих областей, соответствующих указанному состоянию.
include
 query

string

Указывает дополнительные данные для каждой рабочей области в ответе. Поддерживаемые значения: encryption.
name
 query

string

Имя рабочей области.
state
 query

string

Состояние рабочей области. Поддерживаемые состояния активны и удалены.
type
 query

string

Тип рабочей области. Поддерживаемые типы — личные, рабочие области, администрирование.

Ответы

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

Workspaces

Операция прошла успешно.
429 Too Many Requests

ErrorResponse

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

Заголовки

Retry-After: integer
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
List workspaces for a given capacity, ignoring the encryptionStatus filter.
List workspaces with active encryption status in a given capacity
List workspaces with encryption details

Get a list of workspaces example

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

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",
      "tags": [
        {
          "id": "b3f2c8e9-4d8e-4a7c-9a32-f8c1b2e4d6af",
          "displayName": "Finance"
        },
        {
          "id": "6f1a8d3b-92c4-4f67-8c2d-1e5a9b7f4a23",
          "displayName": "Production"
        }
      ]
    }
  ],
  "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

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

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
}

List workspaces for a given capacity, ignoring the encryptionStatus filter.

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

GET https://api.fabric.microsoft.com/v1/admin/workspaces?capacityId=61d6811f-7544-4e75-a1e6-1c59c0383312&encryptionStatus=Active

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

Код состояния:
200 
{
  "workspaces": [
    {
      "id": "abf49964-6f70-4aea-a66c-4b78a22e3ddc",
      "name": "Contoso Workspace 1",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9"
    },
    {
      "id": "90119767-07b4-4657-82ee-53e90fece225",
      "name": "Contoso Workspace 3",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9"
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

List workspaces with active encryption status in a given capacity

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

GET https://api.fabric.microsoft.com/v1/admin/workspaces?capacityId=61d6811f-7544-4e75-a1e6-1c59c0383312&encryptionStatus=Active&include=encryption

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

Код состояния:
200 
{
  "workspaces": [
    {
      "id": "90119767-07b4-4657-82ee-53e90fece225",
      "name": "Contoso Workspace 3",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "encryption": {
        "status": "Active",
        "keyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test2k/"
      }
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

List workspaces with encryption details

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

GET https://api.fabric.microsoft.com/v1/admin/workspaces?encryptionStatus={encryptionStatus}&include=encryption

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

Код состояния:
200 
{
  "workspaces": [
    {
      "id": "abf49964-6f70-4aea-a66c-4b78a22e3ddc",
      "name": "Contoso Workspace 1",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "encryption": {
        "status": "Disabled"
      }
    },
    {
      "id": "9c7f06cc-e850-4961-b2bd-181a70b1a784",
      "name": "Contoso Workspace 2",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "encryption": {
        "status": "Disabled"
      }
    },
    {
      "id": "90119767-07b4-4657-82ee-53e90fece225",
      "name": "Contoso Workspace 3",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "encryption": {
        "status": "Active",
        "keyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test2k/"
      }
    },
    {
      "id": "adaa3051-b1de-41ed-b1b4-d5e08887c1e9",
      "name": "Contoso Workspace 4",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "encryption": {
        "status": "EnableInProgress",
        "keyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test2k/",
        "previousStatus": "Active",
        "previousKeyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test4k/"
      }
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

Определения

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

Сведения о шифровании рабочей области с помощью ключа, управляемого клиентом (CMK).
ErrorRelatedResource

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

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

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

Workspace.
WorkspaceAppliedTag

Представляет примененный тег.
WorkspaceEncryptionStatus

Состояние шифрования CMK рабочей области.
Workspaces

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

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

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

Encryption

Объект

Сведения о шифровании рабочей области с помощью ключа, управляемого клиентом (CMK).

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

string

Идентификатор ключа шифрования.
previousKeyIdentifier

string

Предыдущий идентификатор ключа шифрования.
previousStatus

WorkspaceEncryptionStatus

Предыдущее состояние шифрования CMK рабочей области.
status

WorkspaceEncryptionStatus

Состояние шифрования CMK рабочей области.

ErrorRelatedResource

Объект

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

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

string

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

string

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

ErrorResponse

Объект

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

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

string

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

boolean

Если задано значение true, запрос можно получить. Retry-After Используйте заголовок ответа, чтобы определить задержку, если она доступна.
message

string

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

ErrorResponseDetails[]

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

ErrorRelatedResource

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

string (uuid)

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

ErrorResponseDetails

Объект

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

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

string

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

string

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

ErrorRelatedResource

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

Workspace

Объект

Workspace.

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

string (uuid)

Идентификатор емкости рабочей области.
domainId

string (uuid)

Идентификатор домена рабочей области.
encryption

Encryption

Сведения о шифровании рабочей области.
id

string (uuid)

Идентификатор рабочей области.
name

string

Имя рабочей области.
state

WorkspaceState

Состояние рабочей области.
tags

WorkspaceAppliedTag[]

Список примененных тегов.
type

WorkspaceType

Тип рабочей области.

WorkspaceAppliedTag

Объект

Представляет примененный тег.

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

string

Имя тега.
id

string (uuid)

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

WorkspaceEncryptionStatus

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

Состояние шифрования CMK рабочей области.

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

Шифрование рабочей области не активно.
Active

Шифрование рабочей области активно, а рабочая область шифруется.
EnableInProgress

Шифрование рабочей области включается.
DisableInProgress

Шифрование рабочей области отключено.
Failed

Сбой приложения шифрования рабочей области.

Workspaces

Объект

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

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

string

Маркер для следующего пакета результирующих наборов. Если больше записей нет, он удаляется из ответа.
continuationUri

string

Универсальный код ресурса (URI) следующего пакета результирующих наборов. Если больше записей нет, он удаляется из ответа.
workspaces

Workspace[]

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

WorkspaceState

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

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

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

Рабочая область активна. Потерянные рабочие области отображаются как активные.
Deleted

Рабочая область удаляется.

WorkspaceType

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

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

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

Моя папка или моя рабочая область, используемая для управления элементами пользователя.
Workspace

Рабочая область, используемая для управления элементами Fabric.
AdminWorkspace

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