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

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	Workspaces	Solicitud completada correctamente.
Other Status Codes	ErrorResponse	Códigos de error comunes: InvalidParameter: rol de área de trabajo no válido. UnknownError: se produjo un error.

Nombre

Tipo

Description

200 OK

Workspaces

Solicitud completada correctamente.

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"
    },
    {
      "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"
    }
  ]
}

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"
    }
  ],
  "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
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.
Workspaces
WorkspaceType	Tipo de área de trabajo. Se pueden agregar tipos de área de trabajo adicionales a lo largo del tiempo.

ErrorRelatedResource

Object

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

Object

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.
moreDetails	ErrorResponseDetails[]	Lista de detalles de error adicionales.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.
requestId	string	Identificador de la solicitud asociada al error.

ErrorResponseDetails

Object

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

Object

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.
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.
type	WorkspaceType	Tipo de área de trabajo.

Workspaces

Object

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.

Compartir a través de

Workspaces - List Workspaces

Ámbitos delegados necesarios

Identidades admitidas de Microsoft Entra

Interfaz

Parámetros de identificador URI

Respuestas

Ejemplos

List workspaces example

Solicitud de ejemplo

Respuesta de muestra

List workspaces with continuation example

Solicitud de ejemplo

Respuesta de muestra

List workspaces with preferWorkspaceSpecificEndpoints example

Solicitud de ejemplo

Respuesta de muestra

List workspaces with roles filter example

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

Workspace

Workspaces

WorkspaceType