Workspaces - Get Workspace

Servicio:

Admin

Versión de la API:

v1

Devuelve el área de trabajo especificada.

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.

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/{workspaceId}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
workspaceId	path	True	string (uuid)	El identificador del área de trabajo.

Respuestas

Nombre	Tipo	Description
200 OK	Workspace	OK
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: EntityNotFound: el identificador del área de trabajo no existe. InsufficientPrivileges: el autor de la llamada no tiene permisos para llamar a la API.

Ejemplos

Get workspace details by ID example

Solicitud de ejemplo

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48

Respuesta de muestra

status code:

200

{
  "id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
  "name": "test report",
  "type": "Workspace",
  "state": "Active",
  "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84",
  "domainId": "8badadb6-9945-4e07-8134-00e0defec00b",
  "tags": [
    {
      "id": "b3f2c8e9-4d8e-4a7c-9a32-f8c1b2e4d6af",
      "displayName": "Finance"
    }
  ]
}

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

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.