Partager via

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

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

Workspaces

La demande s’est terminée avec succès.
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

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",
      "domainId": "7c889f28-999b-4945-840d-54da3e3b5a29"
    }
  ]
}

List workspaces with continuation example

Exemple de requête

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"
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/workspaces?continuationToken=LDEsMTAwMDAwLDA%3D"
}

List workspaces with preferWorkspaceSpecificEndpoints example

Exemple de requête

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

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

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

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.

Workspace

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

string (uuid)

ID de la capacité à laquelle l’espace de travail est affecté.
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.
type

WorkspaceType

Type d’espace de travail.

Workspaces

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