Workspaces - Get Workspace

Dienst:: Admin

API-Version:: v1

Gibt den angegebenen Arbeitsbereich 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.

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/{workspaceId}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
workspaceId	path	True	string (uuid)	Die Arbeitsbereichs-ID.

Antworten

Name Typ Beschreibung

200 OK

Name	Typ	Beschreibung
200 OK	Workspace	OK
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: EntityNotFound – Die Arbeitsbereichs-ID ist nicht vorhanden. Nicht ausreichendprivilegiert – Der Aufrufer verfügt nicht über berechtigungen, um die API aufzurufen.

Workspace

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:

EntityNotFound – Die Arbeitsbereichs-ID ist nicht vorhanden.
Nicht ausreichendprivilegiert – Der Aufrufer verfügt nicht über berechtigungen, um die API aufzurufen.

Beispiele

Get workspace details by ID example

Beispielanforderung

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
  "name": "test report",
  "type": "Workspace",
  "state": "Active",
  "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84",
  "domainId": "8badadb6-9945-4e07-8134-00e0defec00b",
  "tags": [
    {
      "id": "b3f2c8e9-4d8e-4a7c-9a32-f8c1b2e4d6af",
      "displayName": "Finance"
    }
  ]
}

Definitionen

Name	Beschreibung
ErrorRelatedResource	Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
Workspace	Workspace.
WorkspaceAppliedTag	Stellt ein angewendetes Tag dar.
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.
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.
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.

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.