Udostępnij przez

Workspaces - Update Workspace

Usługa:
Core
Wersja interfejsu API:
v1

Aktualizuje określone właściwości obszaru roboczego.

Uprawnienia

Obiekt wywołujący musi mieć rolę administratora obszaru roboczego.

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

PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
workspaceId
 path True

string (uuid)

Identyfikator przestrzeni roboczej.

Treść żądania

Nazwa Typ Opis
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.
Nazwy obszarów roboczych muszą być unikatowe w ramach dzierżawy.
"Monitorowanie administratora" to nazwa zarezerwowanego obszaru roboczego.

Odpowiedzi

Nazwa Typ Opis
200 OK

Workspace

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

ErrorResponse

Typowe kody błędów:

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

Przykłady

Update a workspace example

Przykładowe żądanie

PATCH https://api.fabric.microsoft.com/v1/workspaces/33bae707-5fe7-4352-89bd-061a1318b60a

{
  "displayName": "Workspace New displayName",
  "description": "Workspace New description"
}

Przykładowa odpowiedź

Kod stanu:
200 
{
  "id": "33bae707-5fe7-4352-89bd-061a1318b60a",
  "displayName": "Workspace New displayName",
  "description": "Workspace New description",
  "type": "Workspace",
  "domainId": "686177b9-ef29-45e4-a5db-1786ca6dbb9f"
}

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

Zaktualizuj ładunek żądania obszaru roboczego.
Workspace

Obiekt obszaru roboczego.
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.

UpdateWorkspaceRequest

Objekt

Zaktualizuj ładunek żądania obszaru roboczego.

Nazwa Typ Opis
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.
Nazwy obszarów roboczych muszą być unikatowe w ramach dzierżawy.
"Monitorowanie administratora" to nazwa zarezerwowanego obszaru roboczego.

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.