Workspaces - List Workspaces

Service:: Core

Version d’API:: v1

Retourne une liste d’espaces de travail auquel le principal peut accéder. Utilisez le paramètre de requête de rôles pour filtrer les résultats par le rôle d’espace de travail principal.
Cette API prend en charge pagination.

Étendues déléguées requises

Workspace.Read.All ou Workspace.ReadWrite.All

Limites de la limitation

Type de limite	Value
Quota unifié pour les API de plateforme	200 appels/min
Limite d’API	200 appels/min

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Type	Description
continuationToken	query	string	Jeton permettant de récupérer la page suivante des résultats.
preferWorkspaceSpecificEndpoints	query	boolean	Paramètre qui contrôle s’il faut inclure le point de terminaison d’API spécifique à l’espace de travail par espace de travail. True : incluez le point de terminaison d’API spécifique à l’espace de travail, False : n’incluez pas le point de terminaison d’API spécifique à l’espace de travail.
roles	query	string	Liste des rôles. Séparez les valeurs à l’aide d’une virgule. S’il n’est pas fourni, tous les espaces de travail sont retournés.

Réponses

Nom Type Description

200 OK

Nom	Type	Description
200 OK	Workspaces	La demande s’est terminée avec succès.
429 Too Many Requests	ErrorResponse	La limite de débit de service a été dépassée. Le serveur retourne un `Retry-After` en-tête indiquant, en secondes, combien de temps le client doit attendre avant d’envoyer des demandes supplémentaires. En-têtes Retry-After: integer
Other Status Codes	ErrorResponse	Codes d’erreur courants : InvalidParameter : rôle d’espace de travail non valide. UnknownError : une erreur s’est produite.

Workspaces

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

429 Too Many Requests

ErrorResponse

La limite de débit de service a été dépassée. Le serveur retourne un Retry-After en-tête indiquant, en secondes, combien de temps le client doit attendre avant d’envoyer des demandes supplémentaires.

En-têtes

Retry-After: integer

Other Status Codes

ErrorResponse

Codes d’erreur courants :

InvalidParameter : rôle d’espace de travail non valide.
UnknownError : une erreur s’est produite.

Exemples

List workspaces example

List workspaces with continuation example

List workspaces with preferWorkspaceSpecificEndpoints example

List workspaces with roles filter example

List workspaces example

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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",
      "tags": [
        {
          "id": "b3f2c8e9-4d8e-4a7c-9a32-f8c1b2e4d6af",
          "displayName": "Marketing"
        }
      ]
    },
    {
      "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",
      "capacityRegion": "East US",
      "tags": [
        {
          "id": "9b8c7d6e-5f4a-3b2c-1d0e-9f8a7b6c5d4e",
          "displayName": "Finance"
        },
        {
          "id": "b3f2c8e9-4d8e-4a7c-9a32-f8c1b2e4d6af",
          "displayName": "Marketing"
        }
      ]
    }
  ]
}

List workspaces with continuation example

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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",
      "capacityRegion": "East US"
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/workspaces?continuationToken=LDEsMTAwMDAwLDA%3D"
}

List workspaces with preferWorkspaceSpecificEndpoints example

Exemple de requête

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces?preferWorkspaceSpecificEndpoints=True

Exemple de réponse

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

Exemple de requête

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces?roles=Admin,Member,Contributor,Viewer

Exemple de réponse

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

Définitions

Nom	Description
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.
Workspace	Objet d’espace de travail.
WorkspaceAppliedTag	Représente une balise appliquée.
Workspaces
WorkspaceType	Type d’espace de travail. Des types d’espace de travail supplémentaires peuvent être ajoutés au fil du temps.

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

Objet

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

Objet

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.
isRetriable	boolean	Lorsque la valeur est true, la requête peut être retentée. Utilisez l’en-tête `Retry-After` de réponse pour déterminer le délai, le cas échéant.
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 (uuid)	ID de la demande associée à l’erreur.

ErrorResponseDetails

Objet

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.

Workspace

Objet

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.
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.
tags	WorkspaceAppliedTag[]	Liste des balises appliquées.
type	WorkspaceType	Type d’espace de travail.

WorkspaceAppliedTag

Objet

Représente une balise appliquée.

Nom	Type	Description
displayName	string	Nom de la balise.
id	string (uuid)	ID de balise.

Workspaces

Objet

Nom	Type	Description
continuationToken	string	Jeton du lot du jeu de résultats suivant. S’il n’y a plus d’enregistrements, il est supprimé de la réponse.
continuationUri	string	URI du lot du jeu de résultats suivant. S’il n’y a plus d’enregistrements, il est supprimé de la réponse.
value	Workspace[]	Liste des espaces 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.