Workspaces - Get Workspace

Servicio:: Core

Versión de la API:: v1

Devuelve la información del área de trabajo especificada.

Permisos

El autor de la llamada debe tener rol de área de trabajo o superior del visor.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
workspaceId	path	True	string (uuid)	El identificador del área de trabajo.
preferWorkspaceSpecificEndpoints	query		boolean	Configuración que controla si se deben incluir puntos de conexión públicos públicos o específicos del área de trabajo para la API y el acceso de OneLake. True: incluya puntos de conexión específicos del área de trabajo para la API y el acceso de OneLake, False: incluya puntos de conexión públicos generales para el acceso a OneLake.

Respuestas

Nombre	Tipo	Description
200 OK	WorkspaceInfo	Solicitud completada correctamente.
Other Status Codes	ErrorResponse	Códigos de error comunes: UnknownError: se produjo un error.

Nombre

Tipo

Description

200 OK

WorkspaceInfo

Solicitud completada correctamente.

Other Status Codes

ErrorResponse

Códigos de error comunes:

UnknownError: se produjo un error.

Ejemplos

Get a workspace example

Get a workspace with preferWorkspaceSpecificEndpoints example

Get a workspace example

Solicitud de ejemplo

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff227

Respuesta de muestra

status code:: 200

{
  "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
  "displayName": "New workspace",
  "description": "New workspace description",
  "type": "Workspace",
  "domainId": "9ce364e0-8e9d-4605-887a-b599b3e8b123",
  "capacityId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
  "capacityAssignmentProgress": "Completed",
  "workspaceIdentity": {
    "applicationId": "00a4a8f9-78d3-41b3-b87a-6ae5271c8d0d",
    "servicePrincipalId": "5ba4ae58-d402-45c6-a848-0253e834fd78"
  },
  "capacityRegion": "East US",
  "oneLakeEndpoints": {
    "blobEndpoint": "https://eastus-onelake.blob.fabric.microsoft.com",
    "dfsEndpoint": "https://eastus-onelake.dfs.fabric.microsoft.com"
  }
}

Get a workspace with preferWorkspaceSpecificEndpoints example

Solicitud de ejemplo

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff227?preferWorkspaceSpecificEndpoints=True

Respuesta de muestra

status code:: 200

{
  "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
  "displayName": "New workspace",
  "description": "New workspace description",
  "type": "Workspace",
  "capacityId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
  "capacityAssignmentProgress": "Completed",
  "workspaceIdentity": {
    "applicationId": "00a4a8f9-78d3-41b3-b87a-6ae5271c8d0d",
    "servicePrincipalId": "5ba4ae58-d402-45c6-a848-0253e834fd78"
  },
  "capacityRegion": "East US",
  "oneLakeEndpoints": {
    "blobEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.blob.fabric.microsoft.com",
    "dfsEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.dfs.fabric.microsoft.com"
  },
  "apiEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.w.api.fabric.microsoft.com"
}

Definiciones

Nombre	Description
CapacityAssignmentProgress	Asignación del área de trabajo al estado de progreso de la capacidad. Se pueden agregar valores de progreso de asignación de capacidad adicionales a lo largo del tiempo.
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.
OneLakeEndpoints	Los puntos de conexión de la API de OneLake asociados a esta área de trabajo.
WorkspaceIdentity	Objeto de identidad del área de trabajo.
WorkspaceInfo	Un objeto de área de trabajo.
WorkspaceType	Tipo de área de trabajo. Se pueden agregar tipos de área de trabajo adicionales a lo largo del tiempo.

CapacityAssignmentProgress

Enumeración

Asignación del área de trabajo al estado de progreso de la capacidad. Se pueden agregar valores de progreso de asignación de capacidad adicionales a lo largo del tiempo.

Valor	Description
Completed	La última operación de asignación de capacidad se completó correctamente.
Failed	La operación de asignación de capacidad ha encontrado un error o error y no se pudo completar.
InProgress	La operación de asignación de capacidad se está ejecutando actualmente y aún no se ha completado.

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

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.

OneLakeEndpoints

Object

Los puntos de conexión de la API de OneLake asociados a esta área de trabajo.

Nombre	Tipo	Description
blobEndpoint	string	El punto de conexión de la API de OneLake disponible para las operaciones de la API de blobs. De forma predeterminada, se trata de un punto de conexión específico de la región. Si el usuario habilita preferWorkspaceSpecificEndpoints o el área de trabajo tiene deshabilitado el acceso público, se proporciona el punto de conexión específico del área de trabajo para permitir el acceso a través de vínculos privados.
dfsEndpoint	string	El punto de conexión de la API de OneLake disponible para las operaciones de API del sistema de archivos distribuido (DFS) o ADLSgen2. De forma predeterminada, se trata de un punto de conexión específico de la región. Si el usuario habilita preferWorkspaceSpecificEndpoints o el área de trabajo tiene deshabilitado el acceso público, se proporciona el punto de conexión específico del área de trabajo para permitir el acceso a través de vínculos privados.

WorkspaceIdentity

Object

Objeto de identidad del área de trabajo.

Nombre	Tipo	Description
applicationId	string	El id. de aplicación.
servicePrincipalId	string	Identificador de la entidad de servicio.

WorkspaceInfo

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.
capacityAssignmentProgress	CapacityAssignmentProgress	Estado del progreso de la asignación de capacidad del área de trabajo.
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.
oneLakeEndpoints	OneLakeEndpoints	Los puntos de conexión de la API de OneLake asociados a esta área de trabajo.
type	WorkspaceType	Tipo de área de trabajo.
workspaceIdentity	WorkspaceIdentity	Identidad del á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.

Compartir a través de

Workspaces - Get Workspace

Permisos

Ámbitos delegados necesarios

Identidades admitidas de Microsoft Entra

Interfaz

Parámetros de identificador URI

Respuestas

Ejemplos

Get a workspace example

Solicitud de ejemplo

Respuesta de muestra

Get a workspace with preferWorkspaceSpecificEndpoints example

Solicitud de ejemplo

Respuesta de muestra

Definiciones

CapacityAssignmentProgress

CapacityRegion

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

OneLakeEndpoints

WorkspaceIdentity

WorkspaceInfo

WorkspaceType