Udostępnij przez

Workspaces - Create Workspace

Usługa:
Core
Wersja interfejsu API:
v1

Tworzy nowy obszar roboczy.

Uprawnienia

Wymagane zakresy delegowane

Przestrzeń robocza.OdczytZapis.Wszystko

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

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

Treść żądania

Nazwa Wymagane Typ Opis
displayName True

string

Nazwa wyświetlana obszaru roboczego.
Nazwa wyświetlana nie może zawierać więcej niż 256 znaków.
Dozwolone są tylko nieużywane nazwy obszarów roboczych.
"Monitorowanie administratora" to nazwa zarezerwowanego obszaru roboczego.
capacityId

string (uuid)

Identyfikator pojemności do przypisania obszaru roboczego.
description

string

Opis obszaru roboczego.
Opis nie może zawierać więcej niż 4000 znaków.
domainId

string (uuid)

Identyfikator domeny do przypisania obszaru roboczego.

Odpowiedzi

Nazwa Typ Opis
201 Created

Workspace

Pomyślnie utworzono.

Nagłówki

Location: string
Other Status Codes

ErrorResponse

Typowe kody błędów:

  • DomainNotFound — nie znaleziono podanej domeny

  • InsufficientPermissionsToDomain — uprawnienia użytkownika do domeny nie są wystarczające do wykonania operacji

  • UnknownError — wystąpił błąd.

Przykłady

Create a workspace example

Przykładowe żądanie

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

{
  "displayName": "New workspace"
}

Przykładowa odpowiedź

Kod stanu:
201 
Location: https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb22287ff
{
  "id": "cfafbeb1-8037-4d0c-896e-a46fb22287ff",
  "displayName": "New workspace",
  "description": "",
  "type": "Workspace"
}

Definicje

Nazwa Opis
CreateWorkspaceRequest

Utwórz ładunek żądania obszaru roboczego.
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.
WorkspaceType

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

CreateWorkspaceRequest

Objekt

Utwórz ładunek żądania obszaru roboczego.

Nazwa Typ Opis
capacityId

string (uuid)

Identyfikator pojemności do przypisania obszaru roboczego.
description

string

Opis obszaru roboczego.
Opis nie może zawierać więcej niż 4000 znaków.
displayName

string

Nazwa wyświetlana obszaru roboczego.
Nazwa wyświetlana nie może zawierać więcej niż 256 znaków.
Dozwolone są tylko nieużywane nazwy obszarów roboczych.
"Monitorowanie administratora" to nazwa zarezerwowanego obszaru roboczego.
domainId

string (uuid)

Identyfikator domeny do przypisania 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.
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.

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.