Workspaces - Get Workspace

Dienst:: Core

API-Version:: v1

Gibt angegebene Arbeitsbereichsinformationen zurück.

Erlaubnisse

Der Anrufer muss Viewer-rolle oder höherer Arbeitsbereichsrolle haben.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
workspaceId	path	True	string (uuid)	Die Arbeitsbereichs-ID.
preferWorkspaceSpecificEndpoints	query		boolean	Eine Einstellung, die steuert, ob arbeitsbereichspezifische oder allgemeine öffentliche Endpunkte für API- und OneLake-Zugriff eingeschlossen werden sollen. True – Schließen Sie arbeitsbereichspezifische Endpunkte für API- und OneLake-Zugriff ein, False – Schließen Sie allgemeine öffentliche Endpunkte für den OneLake-Zugriff ein.

Antworten

Name	Typ	Beschreibung
200 OK	WorkspaceInfo	Die Anforderung wurde erfolgreich abgeschlossen.
Other Status Codes	ErrorResponse	Häufige Fehlercodes: UnknownError – Ein Fehler ist aufgetreten.

Name

Typ

Beschreibung

200 OK

WorkspaceInfo

Die Anforderung wurde erfolgreich abgeschlossen.

Other Status Codes

ErrorResponse

Häufige Fehlercodes:

UnknownError – Ein Fehler ist aufgetreten.

Beispiele

Get a workspace example

Get a workspace with preferWorkspaceSpecificEndpoints example

Get a workspace example

Beispielanforderung

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff227

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
  "displayName": "New workspace",
  "description": "New workspace description",
  "type": "Workspace",
  "domainId": "9ce364e0-8e9d-4605-887a-b599b3e8b123",
  "capacityId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
  "capacityAssignmentProgress": "Completed",
  "workspaceIdentity": {
    "applicationId": "00a4a8f9-78d3-41b3-b87a-6ae5271c8d0d",
    "servicePrincipalId": "5ba4ae58-d402-45c6-a848-0253e834fd78"
  },
  "capacityRegion": "East US",
  "oneLakeEndpoints": {
    "blobEndpoint": "https://eastus-onelake.blob.fabric.microsoft.com",
    "dfsEndpoint": "https://eastus-onelake.dfs.fabric.microsoft.com"
  }
}

Get a workspace with preferWorkspaceSpecificEndpoints example

Beispielanforderung

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff227?preferWorkspaceSpecificEndpoints=True

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
  "displayName": "New workspace",
  "description": "New workspace description",
  "type": "Workspace",
  "capacityId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
  "capacityAssignmentProgress": "Completed",
  "workspaceIdentity": {
    "applicationId": "00a4a8f9-78d3-41b3-b87a-6ae5271c8d0d",
    "servicePrincipalId": "5ba4ae58-d402-45c6-a848-0253e834fd78"
  },
  "capacityRegion": "East US",
  "oneLakeEndpoints": {
    "blobEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.blob.fabric.microsoft.com",
    "dfsEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.dfs.fabric.microsoft.com"
  },
  "apiEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.w.api.fabric.microsoft.com"
}

Definitionen

Name	Beschreibung
CapacityAssignmentProgress	Eine Arbeitsbereichszuweisung zum Status des Kapazitätsfortschritts. Zusätzliche Statuswerte für die Kapazitätszuweisung können im Laufe der Zeit hinzugefügt werden.
CapacityRegion	Der Bereich der Kapazität, die diesem Arbeitsbereich zugeordnet ist. Zusätzliche Kapazitätsbereichswerte können im Laufe der Zeit hinzugefügt werden.
ErrorRelatedResource	Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
OneLakeEndpoints	Die OneLake-API-Endpunkte, die diesem Arbeitsbereich zugeordnet sind.
WorkspaceIdentity	Ein Arbeitsbereichsidentitätsobjekt.
WorkspaceInfo	Ein Arbeitsbereichsobjekt.
WorkspaceType	Ein Arbeitsbereichstyp. Weitere Arbeitsbereichstypen können im Laufe der Zeit hinzugefügt werden.

CapacityAssignmentProgress

Enumeration

Eine Arbeitsbereichszuweisung zum Status des Kapazitätsfortschritts. Zusätzliche Statuswerte für die Kapazitätszuweisung können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
Completed	Der letzte Kapazitätszuordnungsvorgang wurde erfolgreich abgeschlossen.
Failed	Der Kapazitätszuweisungsvorgang hat einen Fehler oder Fehler festgestellt und konnte nicht abgeschlossen werden.
InProgress	Der Kapazitätszuweisungsvorgang wird derzeit ausgeführt und ist noch nicht abgeschlossen.

CapacityRegion

Enumeration

Der Bereich der Kapazität, die diesem Arbeitsbereich zugeordnet ist. Zusätzliche Kapazitätsbereichswerte können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
Australia East	Region Australien Ost
Australia Southeast	Australien Südost-Region
Brazil South	Region Brasilien Süd
Brazil Southeast	Region Brasilien Südost
Canada Central	Kanada–Zentralregion
Canada East	Kanada-Ostregion
Central India	Region Zentralindien
Central US	Region Zentral-USA
Central US EUAP	Zentrale US-EUAP-Region
East Asia	Region Ostasien
East US	Region Ost-USA
East US 2	Region Ost-USA 2
France Central	Region Frankreich( Zentral)
France South	Region Frankreich Süd
Germany Central	Zentrale Region Deutschland
Germany Northeast	Region Nordosten Deutschland
Israel Central	Israel Central Region
Italy North	Region Italien Nord
Japan East	Japan Ostregion
Japan West	Region Japan West
Korea Central	Zentralregion Korea
Korea South	Südkorea-Region
Mexico Central	Mexiko-Zentralregion
North Central US	Region Nord-Mittel-USA
North Europe	Region Nordeuropa
Norway East	Norwegen Ostregion
Norway West	Region Norwegen West
Poland Central	Polen Zentralregion
South Africa North	Region Südafrika Nord
South Africa West	Region Südafrika West
South Central US	Region Süd-Zentral-USA
South India	Region Südindien
Southeast Asia	Region Südostasien
Spain Central	Spanien Zentralregion
Sweden Central	Schweden Zentralregion
Switzerland North	Schweiz Nordregion
Switzerland West	Schweiz Westregion
West Europe	Region „Europa, Westen“
West India	Region Westindien
West US	West-US-Region
West US 2	Region West US 2
West US 3	Region West US 3
West Central US	Region West Central US
UAE Central	Zentralregion DER VAE
UAE North	Region Vereinigte Arabische Emirate (Nord)
Qatar Central	Zentralregion Katar
Germany West Central	Region West-Mitteldeutschland
Germany North	Nordregion Deutschland
UK South	Region Vereinigtes Königreich Süd
UK West	Region Uk West
China North	Region China Nord
China East	China-Ostregion
China East 2	China Ost 2 Region
China East 3	China Ost 3 Region
China North 2	Region China Nord 2
China North 3	China Nord-3-Region

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.

OneLakeEndpoints

Objekt

Die OneLake-API-Endpunkte, die diesem Arbeitsbereich zugeordnet sind.

Name	Typ	Beschreibung
blobEndpoint	string	Der OneLake-API-Endpunkt, der für Blob-API-Vorgänge verfügbar ist. Standardmäßig ist dies ein regionsspezifischer Endpunkt. Wenn der Benutzer preferWorkspaceSpecificEndpoints aktiviert oder der Arbeitsbereich den öffentlichen Zugriff deaktiviert hat, wird der arbeitsbereichspezifische Endpunkt bereitgestellt, um den Zugriff über private Links zu ermöglichen.
dfsEndpoint	string	Der OneLake-API-Endpunkt, der für DFS-Vorgänge (Distributed File System) oder ADLSgen2-Dateisystem-API-Vorgänge verfügbar ist. Standardmäßig ist dies ein regionsspezifischer Endpunkt. Wenn der Benutzer preferWorkspaceSpecificEndpoints aktiviert oder der Arbeitsbereich den öffentlichen Zugriff deaktiviert hat, wird der arbeitsbereichspezifische Endpunkt bereitgestellt, um den Zugriff über private Links zu ermöglichen.

WorkspaceIdentity

Objekt

Ein Arbeitsbereichsidentitätsobjekt.

Name	Typ	Beschreibung
applicationId	string	Die Anwendungs-ID.
servicePrincipalId	string	Die Dienstprinzipal-ID.

WorkspaceInfo

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.
capacityAssignmentProgress	CapacityAssignmentProgress	Der Status des Kapazitätszuweisungsstatus des Arbeitsbereichs.
capacityId	string (uuid)	Die ID der Kapazität, der der Arbeitsbereich zugewiesen ist.
capacityRegion	CapacityRegion	Der Bereich der Kapazität, die diesem Arbeitsbereich zugeordnet 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.
oneLakeEndpoints	OneLakeEndpoints	Die OneLake-API-Endpunkte, die diesem Arbeitsbereich zugeordnet sind.
type	WorkspaceType	Der Arbeitsbereichstyp.
workspaceIdentity	WorkspaceIdentity	Die Arbeitsbereichsidentität.

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 - Get Workspace

Erlaubnisse

Erforderliche delegierte Bereiche

Von Microsoft Entra unterstützte Identitäten

Schnittstelle

URI-Parameter

Antworten

Beispiele

Get a workspace example

Beispielanforderung

Beispiel für eine Antwort

Get a workspace with preferWorkspaceSpecificEndpoints example

Beispielanforderung

Beispiel für eine Antwort

Definitionen

CapacityAssignmentProgress

CapacityRegion

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

OneLakeEndpoints

WorkspaceIdentity

WorkspaceInfo

WorkspaceType