Compartir a través de

Workspaces - List Workspaces

Servicio:
Admin
Versión de la API:
v1

Devuelve una lista de áreas de trabajo.

Note

Esta API forma parte de una versión preliminar y solo se proporciona con fines de evaluación y desarrollo. Puede cambiar en función de los comentarios y no se recomienda para su uso en producción.

Esta API admite paginación. Se puede devolver un máximo de 10 000 registros por solicitud. Con el token continuo proporcionado en la respuesta, puede obtener los siguientes 10 000 registros.

Permissions

El autor de la llamada debe ser un administrador de Fabric o autenticarse mediante una entidad de servicio.

Ámbitos delegados necesarios

Tenant.Read.All o Tenant.ReadWrite.All

Limitations

Máximo de 200 solicitudes por hora.

Identidades admitidas de Microsoft Entra

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

Identity Support
User Yes
Entidad de servicio e Identidades administradas Yes

Interface

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
capacityId
 query

string (uuid)

Identificador de capacidad del área de trabajo.
continuationToken
 query

string

Token de continuación. Se usa para obtener los siguientes elementos de la lista.
name
 query

string

Nombre del área de trabajo.
state
 query

string

Estado del área de trabajo. Los estados admitidos están activos y eliminados.
type
 query

string

Tipo de área de trabajo. Los tipos admitidos son personales, áreas de trabajo, adminworkspace.

Respuestas

Nombre Tipo Description
200 OK

Workspaces

La operación se realizó 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:

  • BadRequest: los parámetros de consulta como workspaceType o workspaceState no son válidos.

  • InsufficientPrivileges: el autor de la llamada no tiene permisos para llamar a la API.

Ejemplos

Get a list of workspaces example
Get a list of workspaces using state query parameter example

Get a list of workspaces example

Solicitud de ejemplo

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

Respuesta de muestra

status code:
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

Solicitud de ejemplo

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

Respuesta de muestra

status code:
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
}

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

Workspace.
WorkspaceAppliedTag

Representa una etiqueta aplicada.
Workspaces

Lista de áreas de trabajo.
WorkspaceState

Estado del área de trabajo. Se pueden agregar estados de área de trabajo adicionales a lo largo del tiempo.
WorkspaceType

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

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.
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

Workspace.

Nombre Tipo Description
capacityId

string (uuid)

Identificador de capacidad del área de trabajo.
domainId

string (uuid)

Identificador de dominio del área de trabajo.
id

string (uuid)

El identificador del área de trabajo.
name

string

Nombre del área de trabajo.
state

WorkspaceState

Estado 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

Lista de áreas de trabajo.

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.
workspaces

Workspace[]

Lista de áreas de trabajo de tejido.

WorkspaceState

Enumeración

Estado del área de trabajo. Se pueden agregar estados de área de trabajo adicionales a lo largo del tiempo.

Valor Description
Active

El área de trabajo está activa. Las áreas de trabajo huérfanas se muestran como activas.
Deleted

Se elimina el área 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.