Workspaces - List Workspaces

Dienst:: Core

API-Version:: v1

Gibt eine Liste von Arbeitsbereichen zurück, auf die der Prinzipal zugreifen kann. Verwenden Sie den Rollenabfrageparameter, um Ergebnisse nach der Hauptarbeitsbereichsrolle zu filtern.
Diese API unterstützt Paginierung.

Erforderliche delegierte Bereiche

Workspace.Read.All oder Workspace.ReadWrite.All

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identität	Unterstützung
Benutzer	Ja
Service Principal und Verwaltete Identitäten	Ja

Schnittstelle

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Typ	Beschreibung
continuationToken	query	string	Ein Token zum Abrufen der nächsten Seite mit Ergebnissen.
preferWorkspaceSpecificEndpoints	query	boolean	Eine Einstellung, die steuert, ob der arbeitsbereichspezifische API-Endpunkt pro Arbeitsbereich eingeschlossen werden soll. True – Schließen Sie den arbeitsbereichspezifischen API-Endpunkt ein, False – Schließen Sie nicht den arbeitsbereichspezifischen API-Endpunkt ein.
roles	query	string	Eine Liste der Rollen. Trennen Sie Werte mithilfe eines Kommas. Wenn nicht angegeben, werden alle Arbeitsbereiche zurückgegeben.

Antworten

Name	Typ	Beschreibung
200 OK	Workspaces	Die Anforderung wurde erfolgreich abgeschlossen.
Other Status Codes	ErrorResponse	Häufige Fehlercodes: InvalidParameter - Ungültige Arbeitsbereichsrolle. UnknownError – Ein Fehler ist aufgetreten.

Name

Typ

Beschreibung

200 OK

Workspaces

Die Anforderung wurde erfolgreich abgeschlossen.

Other Status Codes

ErrorResponse

Häufige Fehlercodes:

InvalidParameter - Ungültige Arbeitsbereichsrolle.
UnknownError – Ein Fehler ist aufgetreten.

Beispiele

List workspaces example

List workspaces with continuation example

List workspaces with preferWorkspaceSpecificEndpoints example

List workspaces with roles filter example

List workspaces example

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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"
    }
  ]
}

Definitionen

Name	Beschreibung
ErrorRelatedResource	Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
Workspace	Ein Arbeitsbereichsobjekt.
Workspaces
WorkspaceType	Ein Arbeitsbereichstyp. Weitere Arbeitsbereichstypen können im Laufe der Zeit hinzugefügt werden.

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name	Typ	Beschreibung
resourceId	string	Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType	string	Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message	string	Eine lesbare Darstellung des Fehlers.
moreDetails	ErrorResponseDetails[]	Liste der zusätzlichen Fehlerdetails.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.
requestId	string	ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message	string	Eine lesbare Darstellung des Fehlers.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.

Workspace

Objekt

Ein Arbeitsbereichsobjekt.

Name	Typ	Beschreibung
apiEndpoint	string (uri)	HTTP-URL, die den API-Endpunkt für den Arbeitsbereich darstellt. Dieser Endpunktwert wird zurückgegeben, wenn der Benutzer preferWorkspaceSpecificEndpoints aktiviert. Er ermöglicht den API-Zugriff über private Links.
capacityId	string (uuid)	Die ID der Kapazität, der der Arbeitsbereich zugewiesen ist.
description	string	Die Arbeitsbereichsbeschreibung.
displayName	string	Der Anzeigename des Arbeitsbereichs.
domainId	string (uuid)	Die ID der Domäne, der der Arbeitsbereich zugewiesen ist.
id	string (uuid)	Die Arbeitsbereichs-ID.
type	WorkspaceType	Der Arbeitsbereichstyp.

Workspaces

Objekt

Name	Typ	Beschreibung
continuationToken	string	Das Token für den nächsten Resultsetbatch. Wenn keine weiteren Datensätze vorhanden sind, wird sie aus der Antwort entfernt.
continuationUri	string	Der URI des nächsten Resultsetbatches. Wenn keine weiteren Datensätze vorhanden sind, wird sie aus der Antwort entfernt.
value	Workspace[]	Eine Liste der Arbeitsbereiche.

WorkspaceType

Enumeration

Ein Arbeitsbereichstyp. Weitere Arbeitsbereichstypen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
Personal	Mein Ordner oder Mein Arbeitsbereich, der zum Verwalten von Benutzerelementen verwendet wird.
Workspace	Arbeitsbereich, der zum Verwalten der Fabric-Elemente verwendet wird.
AdminWorkspace	Administratorüberwachungsarbeitsbereich. Enthält Administratorberichte wie den Überwachungsbericht und den Nutzungs- und Einführungsbericht.

Freigeben über

Workspaces - List Workspaces

Erforderliche delegierte Bereiche

Von Microsoft Entra unterstützte Identitäten

Schnittstelle

URI-Parameter

Antworten

Beispiele

List workspaces example

Beispielanforderung

Beispiel für eine Antwort

List workspaces with continuation example

Beispielanforderung

Beispiel für eine Antwort

List workspaces with preferWorkspaceSpecificEndpoints example

Beispielanforderung

Beispiel für eine Antwort

List workspaces with roles filter example

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

Workspace

Workspaces

WorkspaceType