Workspaces - Get Workspace

Service:: Core

Version d'API:: v1

Retourne les informations d’espace de travail spécifiées.

Autorisations

L’appelant doit avoir visionneuse ou un rôle d’espace de travail supérieur.

Étendues déléguées requises

Workspace.Read.All ou Workspace.ReadWrite.All

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identité	Soutien
Utilisateur	Oui
Service principal et identités gérées	Oui

Interface

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
workspaceId	path	True	string (uuid)	Identifiant de l’espace de travail.
preferWorkspaceSpecificEndpoints	query		boolean	Paramètre qui contrôle s’il faut inclure des points de terminaison publics spécifiques à l’espace de travail ou généraux pour l’accès API et OneLake. True : incluez des points de terminaison spécifiques à l’espace de travail pour l’ACCÈS API et OneLake, False : inclure des points de terminaison publics généraux pour l’accès OneLake.

Réponses

Nom	Type	Description
200 OK	WorkspaceInfo	La demande s’est terminée avec succès.
Other Status Codes	ErrorResponse	Codes d’erreur courants : UnknownError : une erreur s’est produite.

Nom

Type

Description

200 OK

WorkspaceInfo

La demande s’est terminée avec succès.

Other Status Codes

ErrorResponse

Codes d’erreur courants :

UnknownError : une erreur s’est produite.

Exemples

Get a workspace example

Get a workspace with preferWorkspaceSpecificEndpoints example

Get a workspace example

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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"
}

Définitions

Nom	Description
CapacityAssignmentProgress	Affectation d’espace de travail à l’état de progression de la capacité. Des valeurs supplémentaires de progression de l’affectation de capacité peuvent être ajoutées au fil du temps.
CapacityRegion	Région de la capacité associée à cet espace de travail. Des valeurs de région de capacité supplémentaires peuvent être ajoutées au fil du temps.
ErrorRelatedResource	Objet de détails de ressource associé à l’erreur.
ErrorResponse	Réponse d’erreur.
ErrorResponseDetails	Détails de la réponse d’erreur.
OneLakeEndpoints	Points de terminaison de l’API OneLake associés à cet espace de travail.
WorkspaceIdentity	Objet d’identité d’espace de travail.
WorkspaceInfo	Objet d’espace de travail.
WorkspaceType	Type d’espace de travail. Des types d’espace de travail supplémentaires peuvent être ajoutés au fil du temps.

CapacityAssignmentProgress

Énumération

Affectation d’espace de travail à l’état de progression de la capacité. Des valeurs supplémentaires de progression de l’affectation de capacité peuvent être ajoutées au fil du temps.

Valeur	Description
Completed	La dernière opération d’affectation de capacité a été effectuée avec succès.
Failed	L’opération d’affectation de capacité a rencontré une erreur ou un échec et n’a pas pu se terminer.
InProgress	L’opération d’affectation de capacité est en cours d’exécution et n’est pas encore terminée.

CapacityRegion

Énumération

Région de la capacité associée à cet espace de travail. Des valeurs de région de capacité supplémentaires peuvent être ajoutées au fil du temps.

Valeur	Description
Australia East	Région Australie Est
Australia Southeast	Région Sud-Est de l’Australie
Brazil South	Région Sud du Brésil
Brazil Southeast	Région Sud-Est du Brésil
Canada Central	Région centre du Canada
Canada East	Région Canada Est
Central India	Région Inde centrale
Central US	Région USA Centre
Central US EUAP	Région EUAP USA Centre
East Asia	Région Asie Est
East US	Région USA Est
East US 2	RÉGION USA Est 2
France Central	Région France Centre
France South	Région France Sud
Germany Central	Région centrale de l’Allemagne
Germany Northeast	Région Nord-Est de l’Allemagne
Israel Central	Région centrale d’Israël
Italy North	Région Nord de l’Italie
Japan East	Région Japon Est
Japan West	Région Japon Ouest
Korea Central	Région centrale de Corée
Korea South	Corée du Sud
Mexico Central	Région centrale du Mexique
North Central US	Région USA Centre Nord
North Europe	Région Europe Nord
Norway East	Région Norvège Est
Norway West	Région ouest de la Norvège
Poland Central	Région centrale de Pologne
South Africa North	Région Nord de l’Afrique du Sud
South Africa West	Région Ouest de l’Afrique du Sud
South Central US	Région USA Centre Sud
South India	Région Inde Sud
Southeast Asia	Région Asie Sud-Est
Spain Central	Région centrale de l’Espagne
Sweden Central	Région centrale de La Suède
Switzerland North	Région Suisse Nord
Switzerland West	Région Suisse Ouest
West Europe	Région Europe Ouest
West India	Région Inde Ouest
West US	Région USA Ouest
West US 2	Région USA Ouest 2
West US 3	Région USA Ouest 3
West Central US	Région USA Centre Ouest
UAE Central	Région centrale des Émirats arabes unis
UAE North	Région Nord des Émirats arabes unis
Qatar Central	Région du Qatar Centre
Germany West Central	Région Centre-Ouest de l’Allemagne
Germany North	Région Nord de l’Allemagne
UK South	Région Royaume-Uni Sud
UK West	Région Ouest du Royaume-Uni
China North	Région Chine Nord
China East	Région Chine Est
China East 2	Région Chine Est 2
China East 3	Chine Est 3 région
China North 2	Région Chine Nord 2
China North 3	Région Chine Nord 3

ErrorRelatedResource

Object

Objet de détails de ressource associé à l’erreur.

Nom	Type	Description
resourceId	string	ID de ressource impliqué dans l’erreur.
resourceType	string	Type de la ressource impliquée dans l’erreur.

ErrorResponse

Object

Réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
moreDetails	ErrorResponseDetails[]	Liste des détails d’erreur supplémentaires.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.
requestId	string	ID de la demande associée à l’erreur.

ErrorResponseDetails

Object

Détails de la réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.

OneLakeEndpoints

Object

Points de terminaison de l’API OneLake associés à cet espace de travail.

Nom	Type	Description
blobEndpoint	string	Point de terminaison de l’API OneLake disponible pour les opérations d’API Blob. Par défaut, il s’agit d’un point de terminaison spécifique à une région. Si l’utilisateur active preferWorkspaceSpecificEndpoints ou si l’espace de travail a un accès public désactivé, le point de terminaison spécifique à l’espace de travail est fourni pour autoriser l’accès via des liens privés.
dfsEndpoint	string	Point de terminaison de l’API OneLake disponible pour les opérations d’API du système de fichiers distribué (DFS) ou ADLSgen2. Par défaut, il s’agit d’un point de terminaison spécifique à une région. Si l’utilisateur active preferWorkspaceSpecificEndpoints ou si l’espace de travail a un accès public désactivé, le point de terminaison spécifique à l’espace de travail est fourni pour autoriser l’accès via des liens privés.

WorkspaceIdentity

Object

Objet d’identité d’espace de travail.

Nom	Type	Description
applicationId	string	ID d’application.
servicePrincipalId	string	ID du principal de service.

WorkspaceInfo

Object

Objet d’espace de travail.

Nom	Type	Description
apiEndpoint	string (uri)	URL HTTP qui représente le point de terminaison d’API spécifique à l’espace de travail. Cette valeur de point de terminaison est retournée lorsque l’utilisateur active preferWorkspaceSpecificEndpoints. Il permet l’accès aux API via des liaisons privées.
capacityAssignmentProgress	CapacityAssignmentProgress	État de la progression de l’affectation de capacité de l’espace de travail.
capacityId	string (uuid)	ID de la capacité à laquelle l’espace de travail est affecté.
capacityRegion	CapacityRegion	Région de la capacité associée à cet espace de travail.
description	string	Description de l’espace de travail.
displayName	string	Nom complet de l’espace de travail.
domainId	string (uuid)	L’ID du domaine auquel l’espace de travail est affecté.
id	string (uuid)	Identifiant de l’espace de travail.
oneLakeEndpoints	OneLakeEndpoints	Points de terminaison de l’API OneLake associés à cet espace de travail.
type	WorkspaceType	Type d’espace de travail.
workspaceIdentity	WorkspaceIdentity	Identité de l’espace de travail.

WorkspaceType

Énumération

Type d’espace de travail. Des types d’espace de travail supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
Personal	Mon dossier ou mon espace de travail utilisé pour gérer les éléments utilisateur.
Workspace	Espace de travail utilisé pour gérer les éléments Fabric.
AdminWorkspace	Espace de travail de surveillance administrateur. Contient des rapports d’administration tels que le rapport d’audit et le rapport d’utilisation et d’adoption.

Partager via

Workspaces - Get Workspace

Autorisations

Étendues déléguées requises

Identités prises en charge par Microsoft Entra

Interface

Paramètres URI

Réponses

Exemples

Get a workspace example

Exemple de requête

Exemple de réponse

Get a workspace with preferWorkspaceSpecificEndpoints example

Exemple de requête

Exemple de réponse

Définitions

CapacityAssignmentProgress

CapacityRegion

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

OneLakeEndpoints

WorkspaceIdentity

WorkspaceInfo

WorkspaceType