Workspaces - Get Workspace

Usługa:: Admin

Wersja interfejsu API:: v1

Zwraca określony obszar roboczy.

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.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
workspaceId	path	True	string (uuid)	Identyfikator przestrzeni roboczej.

Odpowiedzi

Nazwa Typ Opis

200 OK

Nazwa	Typ	Opis
200 OK	Workspace	OK
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: EntityNotFound — identyfikator obszaru roboczego nie istnieje. InsufficientPrivileges — obiekt wywołujący nie ma uprawnień do wywoływania interfejsu API.

Workspace

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:

EntityNotFound — identyfikator obszaru roboczego nie istnieje.
InsufficientPrivileges — obiekt wywołujący nie ma uprawnień do wywoływania interfejsu API.

Przykłady

Get workspace details by ID example

Przykładowe żądanie

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48

Przykładowa odpowiedź

Kod stanu:: 200

{
  "id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
  "name": "test report",
  "type": "Workspace",
  "state": "Active",
  "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84",
  "domainId": "8badadb6-9945-4e07-8134-00e0defec00b",
  "tags": [
    {
      "id": "b3f2c8e9-4d8e-4a7c-9a32-f8c1b2e4d6af",
      "displayName": "Finance"
    }
  ]
}

Definicje

Nazwa	Opis
Encryption	Szczegóły szyfrowania obszaru roboczego przy użyciu klucza zarządzanego przez klienta (CMK).
ErrorRelatedResource	Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.
Workspace	Workspace.
WorkspaceAppliedTag	Reprezentuje zastosowany tag.
WorkspaceEncryptionStatus	Stan szyfrowania cmK obszaru roboczego.
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.

Encryption

Objekt

Szczegóły szyfrowania obszaru roboczego przy użyciu klucza zarządzanego przez klienta (CMK).

Nazwa	Typ	Opis
keyIdentifier	string	Identyfikator klucza szyfrowania.
previousKeyIdentifier	string	Poprzedni identyfikator klucza szyfrowania.
previousStatus	WorkspaceEncryptionStatus	Poprzedni stan szyfrowania cmK obszaru roboczego.
status	WorkspaceEncryptionStatus	Stan szyfrowania cmK obszaru roboczego.

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

Workspace.

Nazwa	Typ	Opis
capacityId	string (uuid)	Identyfikator pojemności obszaru roboczego.
domainId	string (uuid)	Identyfikator domeny obszaru roboczego.
encryption	Encryption	Szczegóły szyfrowania obszaru roboczego.
id	string (uuid)	Identyfikator przestrzeni roboczej.
name	string	Nazwa obszaru roboczego.
state	WorkspaceState	Stan obszaru roboczego.
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.

WorkspaceEncryptionStatus

Wyliczenie

Stan szyfrowania cmK obszaru roboczego.

Wartość	Opis
Disabled	Szyfrowanie obszaru roboczego nie jest aktywne.
Active	Szyfrowanie obszaru roboczego jest aktywne i obszar roboczy jest szyfrowany.
EnableInProgress	Szyfrowanie obszaru roboczego jest włączone.
DisableInProgress	Szyfrowanie obszaru roboczego jest wyłączane.
Failed	Aplikacja szyfrowania obszaru roboczego nie powiodła się.

WorkspaceState

Wyliczenie

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

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.