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

Der encryptionStatus Filter wird nur angewendet, wenn der include Parameter enthält encryption.

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

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.
encryptionStatus
 query

string

Gibt den CMK-Verschlüsselungsstatus des Arbeitsbereichs an und wird verwendet, um Arbeitsbereiche zu filtern, die dem angegebenen Status entsprechen.
include
 query

string

Gibt zusätzliche Daten an, die für jeden Arbeitsbereich in der Antwort eingeschlossen werden sollen. Unterstützte Werte: encryption
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.
429 Too Many Requests

ErrorResponse

Der Dienstratengrenzwert wurde überschritten. Der Server gibt einen Retry-After Header zurück, der in Sekunden angibt, wie lange der Client warten muss, bevor zusätzliche Anforderungen gesendet werden.

Header

Retry-After: integer
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
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

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",
      "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

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
}

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

Beispielanforderung

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

Beispiel für eine Antwort

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

Beispielanforderung

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

Beispiel für eine Antwort

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

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
Encryption

Arbeitsbereichsverschlüsselungsdetails mithilfe eines vom Kunden verwalteten Schlüssels (CMK).
ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse

Die Fehlerantwort.
ErrorResponseDetails

Die Fehlerantwortdetails.
Workspace

Workspace.
WorkspaceAppliedTag

Stellt ein angewendetes Tag dar.
WorkspaceEncryptionStatus

Der CMK-Verschlüsselungsstatus des Arbeitsbereichs.
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.

Encryption

Objekt

Arbeitsbereichsverschlüsselungsdetails mithilfe eines vom Kunden verwalteten Schlüssels (CMK).

Name Typ Beschreibung
keyIdentifier

string

Der Verschlüsselungsschlüsselbezeichner.
previousKeyIdentifier

string

Der vorherige Verschlüsselungsschlüsselbezeichner.
previousStatus

WorkspaceEncryptionStatus

Der vorherige CMK-Verschlüsselungsstatus des Arbeitsbereichs.
status

WorkspaceEncryptionStatus

Der CMK-Verschlüsselungsstatus des Arbeitsbereichs.

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

boolean

Wenn true, kann die Anforderung wiederholt werden. Verwenden Sie den Retry-After Antwortheader, um die Verzögerung zu ermitteln, falls verfügbar.
message

string

Eine lesbare Darstellung des Fehlers.
moreDetails

ErrorResponseDetails[]

Liste der zusätzlichen Fehlerdetails.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.
requestId

string (uuid)

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

Encryption

Die Verschlüsselungsdetails des Arbeitsbereichs.
id

string (uuid)

Die Arbeitsbereichs-ID.
name

string

Der Arbeitsbereichsname.
state

WorkspaceState

Der Arbeitsbereichsstatus.
tags

WorkspaceAppliedTag[]

Liste der angewendeten Tags.
type

WorkspaceType

Der Arbeitsbereichstyp.

WorkspaceAppliedTag

Objekt

Stellt ein angewendetes Tag dar.

Name Typ Beschreibung
displayName

string

Der Name des Tags.
id

string (uuid)

Die Tag-ID.

WorkspaceEncryptionStatus

Enumeration

Der CMK-Verschlüsselungsstatus des Arbeitsbereichs.

Wert Beschreibung
Disabled

Die Arbeitsbereichsverschlüsselung ist nicht aktiv.
Active

Die Arbeitsbereichsverschlüsselung ist aktiv, und der Arbeitsbereich wird verschlüsselt.
EnableInProgress

Die Arbeitsbereichsverschlüsselung wird aktiviert.
DisableInProgress

Die Arbeitsbereichsverschlüsselung wird deaktiviert.
Failed

Fehler bei der Arbeitsbereichsverschlüsselungsanwendung.

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.