Workspaces - List Workspaces

Usługa:: Core

Wersja interfejsu API:: v1

Zwraca listę obszarów roboczych, do których może uzyskać dostęp podmiot zabezpieczeń. Użyj parametru zapytania role, aby filtrować wyniki według głównej roli obszaru roboczego.
Ten interfejs API obsługuje stronicowanie.

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Typ	Opis
continuationToken	query	string	Token do pobierania następnej strony wyników.
preferWorkspaceSpecificEndpoints	query	boolean	Ustawienie, które określa, czy uwzględnić punkt końcowy interfejsu API specyficzny dla obszaru roboczego na obszar roboczy. True — uwzględnij punkt końcowy interfejsu API specyficzny dla obszaru roboczego, wartość False — nie uwzględniaj punktu końcowego interfejsu API specyficznego dla obszaru roboczego.
roles	query	string	Lista ról. Oddzielaj wartości przecinkami. Jeśli nie zostanie podana, zostaną zwrócone wszystkie obszary robocze.

Odpowiedzi

Nazwa Typ Opis

200 OK

Nazwa	Typ	Opis
200 OK	Workspaces	Żądanie zostało ukończone pomyślnie.
429 Too Many Requests	ErrorResponse	Przekroczono limit szybkości usługi. Serwer zwraca nagłówek wskazujący `Retry-After` w sekundach, jak długo klient musi czekać przed wysłaniem dodatkowych żądań. Nagłówki Retry-After: integer
Other Status Codes	ErrorResponse	Typowe kody błędów: InvalidParameter — nieprawidłowa rola obszaru roboczego. UnknownError — wystąpił błąd.

Workspaces

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

429 Too Many Requests

ErrorResponse

Przekroczono limit szybkości usługi. Serwer zwraca nagłówek wskazujący Retry-After w sekundach, jak długo klient musi czekać przed wysłaniem dodatkowych żądań.

Nagłówki

Retry-After: integer

Other Status Codes

ErrorResponse

Typowe kody błędów:

InvalidParameter — nieprawidłowa rola obszaru roboczego.
UnknownError — wystąpił błąd.

Przykłady

List workspaces example

List workspaces with continuation example

List workspaces with preferWorkspaceSpecificEndpoints example

List workspaces with roles filter example

List workspaces example

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

{
  "value": [
    {
      "id": "fa9ad228-3e6b-44d4-b5f4-e275f337afa9",
      "displayName": "My workspace",
      "description": "",
      "type": "Personal"
    },
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Marketing",
      "description": "A  workspace used by the marketing team",
      "type": "Workspace",
      "tags": [
        {
          "id": "b3f2c8e9-4d8e-4a7c-9a32-f8c1b2e4d6af",
          "displayName": "Marketing"
        }
      ]
    },
    {
      "id": "f2d70dc6-8f3e-4f2c-b00e-e2d336d7d711",
      "displayName": "Finance",
      "description": "A workspace used by the finance team",
      "type": "Workspace",
      "capacityId": "171018af-1531-4e61-942a-74f024b7f9fd",
      "domainId": "7c889f28-999b-4945-840d-54da3e3b5a29",
      "capacityRegion": "East US",
      "tags": [
        {
          "id": "9b8c7d6e-5f4a-3b2c-1d0e-9f8a7b6c5d4e",
          "displayName": "Finance"
        },
        {
          "id": "b3f2c8e9-4d8e-4a7c-9a32-f8c1b2e4d6af",
          "displayName": "Marketing"
        }
      ]
    }
  ]
}

List workspaces with continuation example

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

{
  "value": [
    {
      "id": "fa9ad228-3e6b-44d4-b5f4-e275f337afa9",
      "displayName": "My workspace",
      "description": "",
      "type": "Personal"
    },
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Marketing",
      "description": "A  workspace used by the marketing team",
      "type": "Workspace"
    },
    {
      "id": "f2d70dc6-8f3e-4f2c-b00e-e2d336d7d711",
      "displayName": "Finance",
      "description": "A workspace used by the finance team",
      "type": "Workspace",
      "capacityId": "171018af-1531-4e61-942a-74f024b7f9fd",
      "capacityRegion": "East US"
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/workspaces?continuationToken=LDEsMTAwMDAwLDA%3D"
}

List workspaces with preferWorkspaceSpecificEndpoints example

Przykładowe żądanie

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces?preferWorkspaceSpecificEndpoints=True

Przykładowa odpowiedź

Kod stanu:: 200

{
  "value": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Alice's Workspace",
      "description": "A workspace for Alice",
      "type": "Workspace",
      "apiEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.w.api.fabric.microsoft.com"
    },
    {
      "id": "0c02a0cd-71bc-410f-aa05-5a7bc98765f7",
      "displayName": "Bob's Workspace",
      "description": "A workspace for Bob",
      "type": "Workspace",
      "apiEndpoint": "https://0c02a0cd71bc410faa055a7bc98765f7.z0c.w.api.fabric.microsoft.com"
    }
  ]
}

List workspaces with roles filter example

Przykładowe żądanie

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces?roles=Admin,Member,Contributor,Viewer

Przykładowa odpowiedź

Kod stanu:: 200

{
  "value": [
    {
      "id": "fa9ad228-3e6b-44d4-b5f4-e275f337afa9",
      "displayName": "Admins workspace",
      "description": "A workspace for admins",
      "type": "Personal"
    },
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Members workspace",
      "description": "A workspace for members",
      "type": "Workspace"
    },
    {
      "id": "0c02a0cd-71bc-410f-aa05-5a7bc98765f7",
      "displayName": "Contributors workspace",
      "description": "A workspace for contributors",
      "type": "Workspace"
    },
    {
      "id": "99d58687-8903-4dbd-8a78-40f95dca7177",
      "displayName": "Viewers workspace",
      "description": "A workspace for viewers",
      "type": "Workspace"
    }
  ]
}

Definicje

Nazwa	Opis
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.
Workspace	Obiekt obszaru roboczego.
WorkspaceAppliedTag	Reprezentuje zastosowany tag.
Workspaces
WorkspaceType	Typ obszaru roboczego. Dodatkowe typy obszarów roboczych można dodawać w czasie.

CapacityRegion

Wyliczenie

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.
isRetriable	boolean	Jeśli to prawda, żądanie można ponowić. Użyj nagłówka `Retry-After` odpowiedzi, aby określić opóźnienie, jeśli jest dostępne.
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 (uuid)	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.

Workspace

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.
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.
tags	WorkspaceAppliedTag[]	Lista zastosowanych tagów.
type	WorkspaceType	Typ obszaru roboczego.

WorkspaceAppliedTag

Objekt

Reprezentuje zastosowany tag.

Nazwa	Typ	Opis
displayName	string	Nazwa znacznika.
id	string (uuid)	Identyfikator tagu.

Workspaces

Objekt

Nazwa	Typ	Opis
continuationToken	string	Token dla następnej partii zestawu wyników. Jeśli nie ma więcej rekordów, zostanie on usunięty z odpowiedzi.
continuationUri	string	Identyfikator URI następnego zestawu wyników wsadowy. Jeśli nie ma więcej rekordów, zostanie on usunięty z odpowiedzi.
value	Workspace[]	Lista obszarów roboczych.

WorkspaceType

Wyliczenie

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.