Workspaces - List Workspaces

Servicio:: Core

Versión de la API:: v1

Devuelve una lista de áreas de trabajo a las que puede acceder la entidad de seguridad. Use el parámetro de consulta roles para filtrar los resultados por el rol de área de trabajo principal.
Esta API admite paginación.

Ámbitos delegados necesarios

Workspace.Read.All o Workspace.ReadWrite.All

Limitaciones

Tipo de límite	Value
Cuota unificada para las API de plataforma	200 llamadas/min
Límite de API	200 llamadas/min

Identidades admitidas de Microsoft Entra

Esta API admite las identidades de Microsoft enumeradas en esta sección.

identidad	Apoyo
Usuario	Sí
Entidad de servicio e Identidades administradas	Sí

Interfaz

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

Con parámetros opcionales:

GET https://api.fabric.microsoft.com/v1/workspaces?roles={roles}&continuationToken={continuationToken}&preferWorkspaceSpecificEndpoints={preferWorkspaceSpecificEndpoints}

Parámetros de identificador URI

Nombre	En	Tipo	Description
continuationToken	query	string	Token para recuperar la siguiente página de resultados.
preferWorkspaceSpecificEndpoints	query	boolean	Configuración que controla si se debe incluir el punto de conexión de API específico del área de trabajo por área de trabajo. True: incluya el punto de conexión de API específico del área de trabajo, False: no incluya el punto de conexión de API específico del área de trabajo.
roles	query	string	Lista de roles. Separe los valores mediante una coma. Si no se proporciona, se devuelven todas las áreas de trabajo.

Respuestas

Nombre Tipo Description

200 OK

Nombre	Tipo	Description
200 OK	Workspaces	Solicitud completada correctamente.
429 Too Many Requests	ErrorResponse	Se superó el límite de frecuencia de servicio. El servidor devuelve un `Retry-After` encabezado que indica, en segundos, cuánto tiempo debe esperar el cliente antes de enviar solicitudes adicionales. Encabezados Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de error comunes: InvalidParameter: rol de área de trabajo no válido. UnknownError: se produjo un error.

Workspaces

Solicitud completada correctamente.

429 Too Many Requests

ErrorResponse

Se superó el límite de frecuencia de servicio. El servidor devuelve un Retry-After encabezado que indica, en segundos, cuánto tiempo debe esperar el cliente antes de enviar solicitudes adicionales.

Encabezados

Retry-After: integer

Other Status Codes

ErrorResponse

Códigos de error comunes:

InvalidParameter: rol de área de trabajo no válido.
UnknownError: se produjo un error.

Ejemplos

List workspaces example

List workspaces with continuation example

List workspaces with preferWorkspaceSpecificEndpoints example

List workspaces with roles filter example

List workspaces example

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 200

{
  "value": [
    {
      "id": "fa9ad228-3e6b-44d4-b5f4-e275f337afa9",
      "displayName": "My workspace",
      "description": "",
      "type": "Personal"
    },
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Marketing",
      "description": "A  workspace used by the marketing team",
      "type": "Workspace",
      "tags": [
        {
          "id": "b3f2c8e9-4d8e-4a7c-9a32-f8c1b2e4d6af",
          "displayName": "Marketing"
        }
      ]
    },
    {
      "id": "f2d70dc6-8f3e-4f2c-b00e-e2d336d7d711",
      "displayName": "Finance",
      "description": "A workspace used by the finance team",
      "type": "Workspace",
      "capacityId": "171018af-1531-4e61-942a-74f024b7f9fd",
      "domainId": "7c889f28-999b-4945-840d-54da3e3b5a29",
      "capacityRegion": "East US",
      "tags": [
        {
          "id": "9b8c7d6e-5f4a-3b2c-1d0e-9f8a7b6c5d4e",
          "displayName": "Finance"
        },
        {
          "id": "b3f2c8e9-4d8e-4a7c-9a32-f8c1b2e4d6af",
          "displayName": "Marketing"
        }
      ]
    }
  ]
}

List workspaces with continuation example

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 200

{
  "value": [
    {
      "id": "fa9ad228-3e6b-44d4-b5f4-e275f337afa9",
      "displayName": "My workspace",
      "description": "",
      "type": "Personal"
    },
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Marketing",
      "description": "A  workspace used by the marketing team",
      "type": "Workspace"
    },
    {
      "id": "f2d70dc6-8f3e-4f2c-b00e-e2d336d7d711",
      "displayName": "Finance",
      "description": "A workspace used by the finance team",
      "type": "Workspace",
      "capacityId": "171018af-1531-4e61-942a-74f024b7f9fd",
      "capacityRegion": "East US"
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/workspaces?continuationToken=LDEsMTAwMDAwLDA%3D"
}

List workspaces with preferWorkspaceSpecificEndpoints example

Solicitud de ejemplo

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces?preferWorkspaceSpecificEndpoints=True

Respuesta de muestra

status code:: 200

{
  "value": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Alice's Workspace",
      "description": "A workspace for Alice",
      "type": "Workspace",
      "apiEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.w.api.fabric.microsoft.com"
    },
    {
      "id": "0c02a0cd-71bc-410f-aa05-5a7bc98765f7",
      "displayName": "Bob's Workspace",
      "description": "A workspace for Bob",
      "type": "Workspace",
      "apiEndpoint": "https://0c02a0cd71bc410faa055a7bc98765f7.z0c.w.api.fabric.microsoft.com"
    }
  ]
}

List workspaces with roles filter example

Solicitud de ejemplo

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces?roles=Admin,Member,Contributor,Viewer

Respuesta de muestra

status code:: 200

{
  "value": [
    {
      "id": "fa9ad228-3e6b-44d4-b5f4-e275f337afa9",
      "displayName": "Admins workspace",
      "description": "A workspace for admins",
      "type": "Personal"
    },
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Members workspace",
      "description": "A workspace for members",
      "type": "Workspace"
    },
    {
      "id": "0c02a0cd-71bc-410f-aa05-5a7bc98765f7",
      "displayName": "Contributors workspace",
      "description": "A workspace for contributors",
      "type": "Workspace"
    },
    {
      "id": "99d58687-8903-4dbd-8a78-40f95dca7177",
      "displayName": "Viewers workspace",
      "description": "A workspace for viewers",
      "type": "Workspace"
    }
  ]
}

Definiciones

Nombre	Description
CapacityRegion	Región de la capacidad asociada a esta área de trabajo. Se pueden agregar valores adicionales de región de capacidad a lo largo del tiempo.
ErrorRelatedResource	Objeto de detalles del recurso relacionado con el error.
ErrorResponse	Respuesta de error.
ErrorResponseDetails	Detalles de la respuesta de error.
Workspace	Un objeto de área de trabajo.
WorkspaceAppliedTag	Representa una etiqueta aplicada.
Workspaces
WorkspaceType	Tipo de área de trabajo. Se pueden agregar tipos de área de trabajo adicionales a lo largo del tiempo.

CapacityRegion

Enumeración

Región de la capacidad asociada a esta área de trabajo. Se pueden agregar valores adicionales de región de capacidad a lo largo del tiempo.

Valor	Description
Australia East	Región Este de Australia
Australia Southeast	Región sudeste de Australia
Brazil South	Región sur de Brasil
Brazil Southeast	Región sudeste de Brasil
Canada Central	Región central de Canadá
Canada East	Región Este de Canadá
Central India	Región centro de la India
Central US	Región Centro de EE. UU.
Central US EUAP	Región EUAP centro de EE. UU.
East Asia	Región de Asia Oriental
East US	Región Este de EE. UU.
East US 2	Región Este de EE. UU. 2
France Central	Región centro de Francia
France South	Región sur de Francia
Germany Central	Región central de Alemania
Germany Northeast	Región noreste de Alemania
Israel Central	Región central de Israel
Italy North	Región norte de Italia
Japan East	Región Este de Japón
Japan West	Región Oeste de Japón
Korea Central	Región central de Corea
Korea South	Región sur de Corea
Mexico Central	Región Centro de México
North Central US	Región Centro-norte de EE. UU.
North Europe	Región norte de Europa
Norway East	Región Este de Noruega
Norway West	Región Oeste de Noruega
Poland Central	Región central de Polonia
South Africa North	Región norte de Sudáfrica
South Africa West	Región Oeste de Sudáfrica
South Central US	Región Centro-sur de EE. UU.
South India	Región Sur de la India
Southeast Asia	Región sudeste de Asia
Spain Central	Región Central de España
Sweden Central	Región central de Suecia
Switzerland North	Región norte de Suiza
Switzerland West	Región Oeste de Suiza
West Europe	Región Oeste de Europa
West India	Región oeste de la India
West US	Región Oeste de EE. UU.
West US 2	Región Oeste de EE. UU. 2
West US 3	Región Oeste de EE. UU. 3
West Central US	Región Centro-oeste de EE. UU.
UAE Central	Región central de Emiratos Árabes Unidos
UAE North	Región norte de Emiratos Árabes Unidos
Qatar Central	Región central de Qatar
Germany West Central	Región Centro-oeste de Alemania
Germany North	Región norte de Alemania
UK South	Región sur de Reino Unido
UK West	Región Oeste de Reino Unido
China North	Región norte de China
China East	Región Este de China
China East 2	Región Este de China 2
China East 3	Región Este de China 3
China North 2	Región norte de China 2
China North 3	Región norte de China 3

ErrorRelatedResource

Objeto

Objeto de detalles del recurso relacionado con el error.

Nombre	Tipo	Description
resourceId	string	Identificador de recurso implicado en el error.
resourceType	string	Tipo del recurso implicado en el error.

ErrorResponse

Objeto

Respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
isRetriable	boolean	Cuando es true, se puede reintentar la solicitud. Use el `Retry-After` encabezado de respuesta para determinar el retraso, si está disponible.
message	string	Representación legible del error.
moreDetails	ErrorResponseDetails[]	Lista de detalles de error adicionales.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.
requestId	string (uuid)	Identificador de la solicitud asociada al error.

ErrorResponseDetails

Objeto

Detalles de la respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message	string	Representación legible del error.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.

Workspace

Objeto

Un objeto de área de trabajo.

Nombre	Tipo	Description
apiEndpoint	string (uri)	Dirección URL HTTP que representa el punto de conexión de API específico del área de trabajo. Este valor de punto de conexión se devuelve cuando el usuario habilita preferWorkspaceSpecificEndpoints. Permite el acceso a la API a través de vínculos privados.
capacityId	string (uuid)	Identificador de la capacidad a la que se asigna el área de trabajo.
capacityRegion	CapacityRegion	Región de la capacidad asociada a esta área de trabajo.
description	string	Descripción del área de trabajo.
displayName	string	Nombre para mostrar del área de trabajo.
domainId	string (uuid)	Identificador del dominio al que se asigna el área de trabajo.
id	string (uuid)	El identificador del área de trabajo.
tags	WorkspaceAppliedTag[]	Lista de etiquetas aplicadas.
type	WorkspaceType	Tipo de área de trabajo.

WorkspaceAppliedTag

Objeto

Representa una etiqueta aplicada.

Nombre	Tipo	Description
displayName	string	Nombre de la etiqueta.
id	string (uuid)	Identificador de etiqueta.

Workspaces

Objeto

Nombre	Tipo	Description
continuationToken	string	Token del siguiente lote del conjunto de resultados. Si no hay más registros, se quita de la respuesta.
continuationUri	string	Identificador URI del siguiente lote del conjunto de resultados. Si no hay más registros, se quita de la respuesta.
value	Workspace[]	Lista de áreas de trabajo.

WorkspaceType

Enumeración

Tipo de área de trabajo. Se pueden agregar tipos de área de trabajo adicionales a lo largo del tiempo.

Valor	Description
Personal	Mi carpeta o Mi área de trabajo se usa para administrar elementos de usuario.
Workspace	Área de trabajo que se usa para administrar los elementos de Fabric.
AdminWorkspace	Área de trabajo de supervisión de administración. Contiene informes de administración, como el informe de auditoría y el informe de uso y adopción.