Partager via

Workspaces - List Workspaces

Service:
Admin
Version d'API:
v1

Retourne une liste d’espaces de travail.

Note

Cette API fait partie d’une préversion et est fournie uniquement à des fins d’évaluation et de développement. Il peut changer en fonction des commentaires et n’est pas recommandé pour une utilisation en production.

Cette API prend en charge pagination. Un maximum de 10 000 enregistrements peut être retourné par requête. Avec le jeton continu fourni dans la réponse, vous pouvez obtenir les 10 000 enregistrements suivants.

Permissions

L’appelant doit être un administrateur Fabric ou s’authentifier à l’aide d’un principal de service.

Étendues déléguées requises

Tenant.Read.All ou Tenant.ReadWrite.All

Limitations

Maximum 200 requêtes par heure.

Identités prises en charge par Microsoft Entra

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

Identity Support
User Yes
Service principal et identités gérées Yes

Interface

GET https://api.fabric.microsoft.com/v1/admin/workspaces
Avec des paramètres facultatifs: 
GET https://api.fabric.microsoft.com/v1/admin/workspaces?type={type}&capacityId={capacityId}&name={name}&state={state}&continuationToken={continuationToken}

Paramètres URI

Nom Dans Obligatoire Type Description
capacityId
 query

string (uuid)

ID de capacité de l’espace de travail.
continuationToken
 query

string

Jeton de continuation. Permet d’obtenir les éléments suivants dans la liste.
name
 query

string

Nom de l’espace de travail.
state
 query

string

État de l’espace de travail. Les états pris en charge sont actifs et supprimés.
type
 query

string

Type d’espace de travail. Les types pris en charge sont personnels, espace de travail, adminworkspace.

Réponses

Nom Type Description
200 OK

Workspaces

L'opération a réussi.
Other Status Codes

ErrorResponse

Codes d’erreur courants :

  • BadRequest : paramètres de requête tels que workspaceType ou workspaceState non valides.

  • InsufficientPrivileges : l’appelant n’a pas les autorisations nécessaires pour appeler l’API.

Exemples

Get a list of workspaces example
Get a list of workspaces using state query parameter example

Get a list of workspaces example

Exemple de requête

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

Exemple de réponse

Code d’état:
200 
{
  "workspaces": [
    {
      "id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
      "name": "test report",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9"
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

Get a list of workspaces using state query parameter example

Exemple de requête

GET https://api.fabric.microsoft.com/v1/admin/workspaces?state=Active

Exemple de réponse

Code d’état:
200 
{
  "workspaces": [
    {
      "id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
      "name": "test report",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84"
    }
  ],
  "continuationUri": null,
  "continuationToken": null
}

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

Workspace.
Workspaces

Liste des espaces de travail.
WorkspaceState

État de l’espace de travail. Des états d’espace de travail supplémentaires peuvent être ajoutés au fil du temps.
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

Workspace.

Nom Type Description
capacityId

string (uuid)

ID de capacité de l’espace de travail.
domainId

string (uuid)

ID de domaine de l’espace de travail.
id

string (uuid)

Identifiant de l’espace de travail.
name

string

Nom de l’espace de travail.
state

WorkspaceState

État de l’espace de travail.
type

WorkspaceType

Type d’espace de travail.

Workspaces

Object

Liste des espaces de travail.

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

Workspace[]

Liste des espaces de travail d’infrastructure.

WorkspaceState

Énumération

État de l’espace de travail. Des états d’espace de travail supplémentaires peuvent être ajoutés au fil du temps.

Valeur Description
Active

L’espace de travail est actif. Les espaces de travail orphelins sont affichés comme actifs.
Deleted

L’espace de travail est supprimé.

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.