Workspaces - Get Workspace

Usługa:: Core

Wersja interfejsu API:: v1

Zwraca określone informacje o obszarze roboczym.

Uprawnienia

Obiekt wywołujący musi mieć lub większą rolę obszaru roboczego.

Wymagane zakresy delegowane

Workspace.Read.All lub Workspace.ReadWrite.All

Tożsamości obsługiwane przez Microsoft Entra

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

Tożsamość	Wsparcie
Użytkownik	Tak
Główne usługi i Tożsamości zarządzane	Tak

Interfejs

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
workspaceId	path	True	string (uuid)	Identyfikator przestrzeni roboczej.
preferWorkspaceSpecificEndpoints	query		boolean	Ustawienie, które określa, czy mają być uwzględniane publiczne punkty końcowe dla interfejsu API i usługi OneLake. Prawda — uwzględniaj punkty końcowe specyficzne dla obszaru roboczego dla interfejsu API i dostępu OneLake, False — uwzględnia ogólne publiczne punkty końcowe dla dostępu usługi OneLake.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	WorkspaceInfo	Żądanie zostało ukończone pomyślnie.
Other Status Codes	ErrorResponse	Typowe kody błędów: UnknownError — wystąpił błąd.

Nazwa

Typ

Opis

200 OK

WorkspaceInfo

Żądanie zostało ukończone pomyślnie.

Other Status Codes

ErrorResponse

Typowe kody błędów:

UnknownError — wystąpił błąd.

Przykłady

Get a workspace example

Get a workspace with preferWorkspaceSpecificEndpoints example

Get a workspace example

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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"
}

Definicje

Nazwa	Opis
CapacityAssignmentProgress	Przypisanie obszaru roboczego do stanu postępu pojemności. W miarę upływu czasu można dodać dodatkowe wartości postępu przypisania pojemności.
CapacityRegion	Region pojemności skojarzonej z tym obszarem roboczym. Dodatkowe wartości regionów pojemności mogą być dodawane w czasie.
ErrorRelatedResource	Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.
OneLakeEndpoints	Punkty końcowe interfejsu API OneLake skojarzone z tym obszarem roboczym.
WorkspaceIdentity	Obiekt tożsamości obszaru roboczego.
WorkspaceInfo	Obiekt obszaru roboczego.
WorkspaceType	Typ obszaru roboczego. Dodatkowe typy obszarów roboczych można dodawać w czasie.

CapacityAssignmentProgress

Wyliczanie

Przypisanie obszaru roboczego do stanu postępu pojemności. W miarę upływu czasu można dodać dodatkowe wartości postępu przypisania pojemności.

Wartość	Opis
Completed	Ostatnia operacja przypisania pojemności została ukończona pomyślnie.
Failed	Operacja przypisania pojemności napotkała błąd lub błąd i nie można go ukończyć.
InProgress	Operacja przypisania pojemności jest obecnie uruchomiona i nie została jeszcze ukończona.

CapacityRegion

Wyliczanie

Region pojemności skojarzonej z tym obszarem roboczym. Dodatkowe wartości regionów pojemności mogą być dodawane w czasie.

Wartość	Opis
Australia East	Australia Wschodnia
Australia Southeast	Australia Południowo-Wschodnia
Brazil South	Brazylia Południowa
Brazil Southeast	Brazylia Południowo-Wschodnia
Canada Central	Region Środkowy Kanady
Canada East	Kanada Wschodnia
Central India	Region Indii Środkowych
Central US	Region Środkowe stany USA
Central US EUAP	Środkowe stany USA EUAP
East Asia	Region Azji Wschodniej
East US	Region Wschodnie stany USA
East US 2	Region Wschodnie stany USA 2
France Central	Region Środkowy Francji
France South	Francja Południowa
Germany Central	Region Środkowy Niemiec
Germany Northeast	Niemcy Północno-Wschodnie
Israel Central	Region Środkowy Izraela
Italy North	Region Północny Włoch
Japan East	Region Japonii Wschodniej
Japan West	Region Japonii Zachodniej
Korea Central	Korea Środkowa
Korea South	Korea Południowa
Mexico Central	Region Środkowy Meksyk
North Central US	Region Północno-środkowe stany USA
North Europe	Region Europa Północna
Norway East	Region Wschodni Norwegii
Norway West	Region Zachodni Norwegii
Poland Central	Polska Środkowa
South Africa North	Republika Południowej Afryki Północnej
South Africa West	Region Zachodni w Republice Południowej Afryki
South Central US	Region Południowo-środkowe stany USA
South India	Region Indii Południowych
Southeast Asia	Region Azji Południowo-Wschodniej
Spain Central	Region środkowy Hiszpanii
Sweden Central	Szwecja Środkowa
Switzerland North	Region Północny Szwajcarii
Switzerland West	Region Zachodni Szwajcarii
West Europe	Region Europa Zachodnia
West India	Region Indii Zachodnich
West US	Region Zachodnie stany USA
West US 2	Region Zachodnie stany USA 2
West US 3	Region Zachodnie stany USA 3
West Central US	Region Zachodnio-środkowe stany USA
UAE Central	Region środkowy ZEA
UAE North	Region północny ZEA
Qatar Central	Katar Środkowy region
Germany West Central	Region Zachodnio-środkowy Niemiec
Germany North	Region Północny w Niemczech
UK South	Region Południowy Zjednoczone Królestwo
UK West	Region Zachodni w Wielkiej Brytanii
China North	Region Północny Chin
China East	Region WschodniCh Chin
China East 2	Chiny Wschodnie 2 region
China East 3	Chiny Wschodnie 3 region
China North 2	Chiny Północne 2 region
China North 3	Chiny Północne 3 region

ErrorRelatedResource

Objekt

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwa	Typ	Opis
resourceId	string	Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType	string	Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
moreDetails	ErrorResponseDetails[]	Lista dodatkowych szczegółów błędu.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.
requestId	string	Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.

OneLakeEndpoints

Objekt

Punkty końcowe interfejsu API OneLake skojarzone z tym obszarem roboczym.

Nazwa	Typ	Opis
blobEndpoint	string	Punkt końcowy interfejsu API usługi OneLake dostępny dla operacji interfejsu API obiektów blob. Domyślnie jest to punkt końcowy specyficzny dla regionu. Jeśli użytkownik włączy opcję preferujWorkspaceSpecificEndpoints lub obszar roboczy ma wyłączony dostęp publiczny, punkt końcowy specyficzny dla obszaru roboczego jest udostępniany w celu umożliwienia dostępu za pośrednictwem linków prywatnych.
dfsEndpoint	string	Punkt końcowy interfejsu API usługi OneLake dostępny dla operacji interfejsu API rozproszonego systemu plików (DFS) lub ADLSgen2. Domyślnie jest to punkt końcowy specyficzny dla regionu. Jeśli użytkownik włączy opcję preferujWorkspaceSpecificEndpoints lub obszar roboczy ma wyłączony dostęp publiczny, punkt końcowy specyficzny dla obszaru roboczego jest udostępniany w celu umożliwienia dostępu za pośrednictwem linków prywatnych.

WorkspaceIdentity

Objekt

Obiekt tożsamości obszaru roboczego.

Nazwa	Typ	Opis
applicationId	string	Identyfikator aplikacji.
servicePrincipalId	string	Identyfikator jednostki usługi.

WorkspaceInfo

Objekt

Obiekt obszaru roboczego.

Nazwa	Typ	Opis
apiEndpoint	string (uri)	Adres URL HTTP reprezentujący punkt końcowy interfejsu API specyficzny dla obszaru roboczego. Ta wartość punktu końcowego jest zwracana, gdy użytkownik włączy opcję PreferWorkspaceSpecificEndpoints. Umożliwia dostęp do interfejsu API za pośrednictwem linków prywatnych.
capacityAssignmentProgress	CapacityAssignmentProgress	Stan postępu przypisywania pojemności obszaru roboczego.
capacityId	string (uuid)	Identyfikator pojemności, do której jest przypisany obszar roboczy.
capacityRegion	CapacityRegion	Region pojemności skojarzonej z tym obszarem roboczym.
description	string	Opis obszaru roboczego.
displayName	string	Nazwa wyświetlana obszaru roboczego.
domainId	string (uuid)	Identyfikator domeny, do której jest przypisany obszar roboczy.
id	string (uuid)	Identyfikator przestrzeni roboczej.
oneLakeEndpoints	OneLakeEndpoints	Punkty końcowe interfejsu API OneLake skojarzone z tym obszarem roboczym.
type	WorkspaceType	Typ obszaru roboczego.
workspaceIdentity	WorkspaceIdentity	Tożsamość obszaru roboczego.

WorkspaceType

Wyliczanie

Typ obszaru roboczego. Dodatkowe typy obszarów roboczych można dodawać w czasie.

Wartość	Opis
Personal	Mój folder lub Mój obszar roboczy służący do zarządzania elementami użytkownika.
Workspace	Obszar roboczy służący do zarządzania elementami sieci szkieletowej.
AdminWorkspace	Obszar roboczy monitorowania przez administratora. Zawiera raporty administratora, takie jak raport inspekcji i raport użycia i wdrażania.

Udostępnij przez

Workspaces - Get Workspace

Uprawnienia

Wymagane zakresy delegowane

Tożsamości obsługiwane przez Microsoft Entra

Interfejs

Parametry identyfikatora URI

Odpowiedzi

Przykłady

Get a workspace example

Przykładowe żądanie

Przykładowa odpowiedź

Get a workspace with preferWorkspaceSpecificEndpoints example

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

CapacityAssignmentProgress

CapacityRegion

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

OneLakeEndpoints

WorkspaceIdentity

WorkspaceInfo

WorkspaceType