Udostępnij przez

Workspaces - List Workspaces

Usługa:
Admin
Wersja interfejsu API:
v1

Zwraca listę obszarów roboczych.

Note

Ten interfejs API jest częścią wersji zapoznawczej i jest dostarczany tylko do celów ewaluacyjnych i programistycznych. Może ona ulec zmianie na podstawie opinii i nie jest zalecana do użytku produkcyjnego.

Ten interfejs API obsługuje stronicowanie. Na żądanie można zwrócić maksymalnie 10 000 rekordów. Dzięki tokenowi ciągłego podanego w odpowiedzi możesz uzyskać kolejne 10 000 rekordów.

Permissions

Obiekt wywołujący musi być administratorem sieci szkieletowej lub uwierzytelniać się przy użyciu jednostki usługi.

Wymagane zakresy delegowane

Tenant.Read.All lub Tenant.ReadWrite.All

Limitations

Maksymalna liczba żądań na godzinę wynosi 200.

Tożsamości obsługiwane przez Microsoft Entra

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

Identity Support
User Yes
Główne usługi i Tożsamości zarządzane Yes

Interface

GET https://api.fabric.microsoft.com/v1/admin/workspaces
Z parametrami opcjonalnymi: 
GET https://api.fabric.microsoft.com/v1/admin/workspaces?type={type}&capacityId={capacityId}&name={name}&state={state}&continuationToken={continuationToken}

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
capacityId
 query

string (uuid)

Identyfikator pojemności obszaru roboczego.
continuationToken
 query

string

Token kontynuacji. Służy do pobierania kolejnych elementów na liście.
name
 query

string

Nazwa obszaru roboczego.
state
 query

string

Stan obszaru roboczego. Obsługiwane stany są aktywne i usuwane.
type
 query

string

Typ obszaru roboczego. Obsługiwane typy to osobiste, obszary robocze, przestrzeń administracyjna.

Odpowiedzi

Nazwa Typ Opis
200 OK

Workspaces

Operacja zakończyła się pomyślnie.
Other Status Codes

ErrorResponse

Typowe kody błędów:

  • BadRequest — parametry zapytania, takie jak workspaceType lub workspaceState nie są prawidłowe.

  • InsufficientPrivileges — obiekt wywołujący nie ma uprawnień do wywoływania interfejsu API.

Przykłady

Get a list of workspaces example
Get a list of workspaces using state query parameter example

Get a list of workspaces example

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
200 
{
  "workspaces": [
    {
      "id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
      "name": "test report",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9"
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

Get a list of workspaces using state query parameter example

Przykładowe żądanie

GET https://api.fabric.microsoft.com/v1/admin/workspaces?state=Active

Przykładowa odpowiedź

Kod stanu:
200 
{
  "workspaces": [
    {
      "id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
      "name": "test report",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84"
    }
  ],
  "continuationUri": null,
  "continuationToken": null
}

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

Workspace.
Workspaces

Lista obszarów roboczych.
WorkspaceState

Stan obszaru roboczego. Dodatkowe stany obszaru roboczego można dodawać z upływem czasu.
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

Workspace.

Nazwa Typ Opis
capacityId

string (uuid)

Identyfikator pojemności obszaru roboczego.
domainId

string (uuid)

Identyfikator domeny obszaru roboczego.
id

string (uuid)

Identyfikator przestrzeni roboczej.
name

string

Nazwa obszaru roboczego.
state

WorkspaceState

Stan obszaru roboczego.
type

WorkspaceType

Typ obszaru roboczego.

Workspaces

Objekt

Lista obszarów roboczych.

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.
workspaces

Workspace[]

Lista obszarów roboczych sieci szkieletowej.

WorkspaceState

Wyliczanie

Stan obszaru roboczego. Dodatkowe stany obszaru roboczego można dodawać z upływem czasu.

Wartość Opis
Active

Obszar roboczy jest aktywny. Oddzielone obszary robocze są wyświetlane jako aktywne.
Deleted

Obszar roboczy zostanie usunięty.

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.