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	Workspaces	Żądanie zostało ukończone pomyślnie.
Other Status Codes	ErrorResponse	Typowe kody błędów: InvalidParameter — nieprawidłowa rola obszaru roboczego. UnknownError — wystąpił błąd.

Nazwa

Typ

Opis

200 OK

Workspaces

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

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"
    },
    {
      "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"
    }
  ]
}

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"
    }
  ],
  "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
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.
Workspaces
WorkspaceType	Typ obszaru roboczego. Dodatkowe typy obszarów roboczych można dodawać w czasie.

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.

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.
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.
type	WorkspaceType	Typ obszaru roboczego.

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

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 - List Workspaces

Wymagane zakresy delegowane

Tożsamości obsługiwane przez Microsoft Entra

Interfejs

Parametry identyfikatora URI

Odpowiedzi

Przykłady

List workspaces example

Przykładowe żądanie

Przykładowa odpowiedź

List workspaces with continuation example

Przykładowe żądanie

Przykładowa odpowiedź

List workspaces with preferWorkspaceSpecificEndpoints example

Przykładowe żądanie

Przykładowa odpowiedź

List workspaces with roles filter example

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

Workspace

Workspaces

WorkspaceType