Freigeben über

Workspaces - List Workspaces

Dienst:
Admin
API-Version:
v1

Gibt eine Liste von Arbeitsbereichen zurück.

Note

Diese API ist Teil einer Preview-Version und wird nur für Evaluierungs- und Entwicklungszwecke bereitgestellt. Sie kann sich basierend auf Feedback ändern und wird nicht für den Produktionseinsatz empfohlen.

Diese API unterstützt Paginierung. Pro Anforderung können maximal 10.000 Datensätze zurückgegeben werden. Mit dem in der Antwort bereitgestellten fortlaufenden Token können Sie die nächsten 10.000 Datensätze abrufen.

Permissions

Der Aufrufer muss ein Fabric-Administrator sein oder sich mit einem Dienstprinzipal authentifizieren.

Erforderliche delegierte Bereiche

Tenant.Read.All oder Tenant.ReadWrite.All

Limitations

Maximal 200 Anforderungen pro Stunde.

Von Microsoft Entra unterstützte Identitäten

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

Identity Support
User Yes
Service Principal und Verwaltete Identitäten Yes

Interface

GET https://api.fabric.microsoft.com/v1/admin/workspaces
Mit optionalen Parametern: 
GET https://api.fabric.microsoft.com/v1/admin/workspaces?type={type}&capacityId={capacityId}&name={name}&state={state}&continuationToken={continuationToken}

URI-Parameter

Name In Erforderlich Typ Beschreibung
capacityId
 query

string (uuid)

Die Kapazitäts-ID des Arbeitsbereichs.
continuationToken
 query

string

Fortsetzungstoken. Wird verwendet, um die nächsten Elemente in der Liste abzurufen.
name
 query

string

Der Arbeitsbereichsname.
state
 query

string

Der Arbeitsbereichsstatus. Unterstützte Zustände sind aktiv und gelöscht.
type
 query

string

Der Arbeitsbereichstyp. Unterstützte Typen sind personal, workspace, adminworkspace.

Antworten

Name Typ Beschreibung
200 OK

Workspaces

Der Vorgang wurde durchgeführt.
Other Status Codes

ErrorResponse

Häufige Fehlercodes:

  • BadRequest – Abfrageparameter wie workspaceType oder workspaceState sind ungültig.

  • Nicht ausreichendprivilegiert – Der Aufrufer verfügt nicht über berechtigungen, um die API aufzurufen.

Beispiele

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

Get a list of workspaces example

Beispielanforderung

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

Beispiel für eine Antwort

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

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse

Die Fehlerantwort.
ErrorResponseDetails

Die Fehlerantwortdetails.
Workspace

Workspace.
Workspaces

Eine Liste der Arbeitsbereiche.
WorkspaceState

Der Arbeitsbereichsstatus. Zusätzliche Arbeitsbereichszustände können im Laufe der Zeit hinzugefügt werden.
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

Workspace.

Name Typ Beschreibung
capacityId

string (uuid)

Die Kapazitäts-ID des Arbeitsbereichs.
domainId

string (uuid)

Die Domänen-ID des Arbeitsbereichs.
id

string (uuid)

Die Arbeitsbereichs-ID.
name

string

Der Arbeitsbereichsname.
state

WorkspaceState

Der Arbeitsbereichsstatus.
type

WorkspaceType

Der Arbeitsbereichstyp.

Workspaces

Objekt

Eine Liste der Arbeitsbereiche.

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

Workspace[]

Die Liste der Fabric-Arbeitsbereiche.

WorkspaceState

Enumeration

Der Arbeitsbereichsstatus. Zusätzliche Arbeitsbereichszustände können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
Active

Der Arbeitsbereich ist aktiv. Verwaiste Arbeitsbereiche werden als aktiv angezeigt.
Deleted

Der Arbeitsbereich wird gelöscht.

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.