Workspaces - List Workspaces

Service:: Admin

Version d’API:: v1

Retourne une liste d’espaces de travail.
Cette API prend en charge pagination. Un maximum de 10 000 enregistrements peut être retourné par requête. Avec le jeton de continuation 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.

Le encryptionStatus filtre est appliqué uniquement lorsque le include paramètre contient encryption.

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}&encryptionStatus={encryptionStatus}&include={include}

Paramètres URI

Nom	Dans	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.
encryptionStatus	query	string	Indique l’état du chiffrement CMK de l’espace de travail et est utilisé pour filtrer les espaces de travail qui correspondent à l’état spécifié.
include	query	string	Spécifie des données supplémentaires à inclure pour chaque espace de travail dans la réponse. Valeurs prises en charge : `encryption`.
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

Nom	Type	Description
200 OK	Workspaces	L'opération a réussi.
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 : 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.

Workspaces

L'opération a réussi.

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 :

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

List workspaces for a given capacity, ignoring the encryptionStatus filter.

List workspaces with active encryption status in a given capacity

List workspaces with encryption details

Get a list of workspaces example

Exemple de requête

HTTP

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",
      "tags": [
        {
          "id": "b3f2c8e9-4d8e-4a7c-9a32-f8c1b2e4d6af",
          "displayName": "Finance"
        },
        {
          "id": "6f1a8d3b-92c4-4f67-8c2d-1e5a9b7f4a23",
          "displayName": "Production"
        }
      ]
    }
  ],
  "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

HTTP

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
}

List workspaces for a given capacity, ignoring the encryptionStatus filter.

Exemple de requête

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces?capacityId=61d6811f-7544-4e75-a1e6-1c59c0383312&encryptionStatus=Active

Exemple de réponse

Code d’état:: 200

{
  "workspaces": [
    {
      "id": "abf49964-6f70-4aea-a66c-4b78a22e3ddc",
      "name": "Contoso Workspace 1",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9"
    },
    {
      "id": "90119767-07b4-4657-82ee-53e90fece225",
      "name": "Contoso Workspace 3",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9"
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

List workspaces with active encryption status in a given capacity

Exemple de requête

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces?capacityId=61d6811f-7544-4e75-a1e6-1c59c0383312&encryptionStatus=Active&include=encryption

Exemple de réponse

Code d’état:: 200

{
  "workspaces": [
    {
      "id": "90119767-07b4-4657-82ee-53e90fece225",
      "name": "Contoso Workspace 3",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "encryption": {
        "status": "Active",
        "keyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test2k/"
      }
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

List workspaces with encryption details

Exemple de requête

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces?encryptionStatus={encryptionStatus}&include=encryption

Exemple de réponse

Code d’état:: 200

{
  "workspaces": [
    {
      "id": "abf49964-6f70-4aea-a66c-4b78a22e3ddc",
      "name": "Contoso Workspace 1",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "encryption": {
        "status": "Disabled"
      }
    },
    {
      "id": "9c7f06cc-e850-4961-b2bd-181a70b1a784",
      "name": "Contoso Workspace 2",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "encryption": {
        "status": "Disabled"
      }
    },
    {
      "id": "90119767-07b4-4657-82ee-53e90fece225",
      "name": "Contoso Workspace 3",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "encryption": {
        "status": "Active",
        "keyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test2k/"
      }
    },
    {
      "id": "adaa3051-b1de-41ed-b1b4-d5e08887c1e9",
      "name": "Contoso Workspace 4",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "encryption": {
        "status": "EnableInProgress",
        "keyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test2k/",
        "previousStatus": "Active",
        "previousKeyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test4k/"
      }
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

Définitions

Nom	Description
Encryption	Détails du chiffrement de l’espace de travail à l’aide d’une clé gérée par le client (CMK).
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.
WorkspaceAppliedTag	Représente une balise appliquée.
WorkspaceEncryptionStatus	État du chiffrement CMK de l’espace de travail.
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.

Encryption

Objet

Détails du chiffrement de l’espace de travail à l’aide d’une clé gérée par le client (CMK).

Nom	Type	Description
keyIdentifier	string	Identificateur de clé de chiffrement.
previousKeyIdentifier	string	Identificateur de clé de chiffrement précédent.
previousStatus	WorkspaceEncryptionStatus	État de chiffrement CMK précédent de l’espace de travail.
status	WorkspaceEncryptionStatus	État du chiffrement CMK de l’espace de travail.

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

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.
encryption	Encryption	Détails du chiffrement 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.
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.

WorkspaceEncryptionStatus

Énumération

État du chiffrement CMK de l’espace de travail.

Valeur	Description
Disabled	Le chiffrement de l’espace de travail n’est pas actif.
Active	Le chiffrement de l’espace de travail est actif et l’espace de travail est chiffré.
EnableInProgress	Le chiffrement de l’espace de travail est activé.
DisableInProgress	Le chiffrement de l’espace de travail est désactivé.
Failed	Échec de l’application de chiffrement de l’espace de travail.

Workspaces

Objet

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.