Freigeben über

Workspaces - Update Workspace

Dienst:
Core
API-Version:
v1

Aktualisiert die angegebenen Arbeitsbereichseigenschaften.

Erlaubnisse

Der Anrufer muss über Administratorrolle Arbeitsbereichs verfügen.

Erforderliche delegierte Bereiche

Arbeitsbereich.ReadWrite.All

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identität Unterstützung
Benutzer Ja
Service Principal und Verwaltete Identitäten Ja

Schnittstelle

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
workspaceId
 path True

string (uuid)

Die Arbeitsbereichs-ID.

Anforderungstext

Name Typ Beschreibung
description

string

Die Arbeitsbereichsbeschreibung.
Die Beschreibung darf nicht mehr als 4000 Zeichen enthalten.
displayName

string

Der Anzeigename des Arbeitsbereichs.
Der Anzeigename darf nicht mehr als 256 Zeichen enthalten.
Arbeitsbereichsnamen müssen innerhalb des Mandanten eindeutig sein.
"Administratorüberwachung" ist ein reservierter Arbeitsbereichsname.

Antworten

Name Typ Beschreibung
200 OK

Workspace

Die Anforderung wurde erfolgreich abgeschlossen.
Other Status Codes

ErrorResponse

Häufige Fehlercodes:

  • UnknownError – Ein Fehler ist aufgetreten.

Beispiele

Update a workspace example

Beispielanforderung

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

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse

Die Fehlerantwort.
ErrorResponseDetails

Die Fehlerantwortdetails.
UpdateWorkspaceRequest

Aktualisieren der Arbeitsbereichsanforderungsnutzlast.
Workspace

Ein Arbeitsbereichsobjekt.
WorkspaceType

Ein Arbeitsbereichstyp. Weitere Arbeitsbereichstypen können im Laufe der Zeit hinzugefügt werden.

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name Typ Beschreibung
resourceId

string

Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType

string

Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
moreDetails

ErrorResponseDetails[]

Liste der zusätzlichen Fehlerdetails.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.
requestId

string

ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.

UpdateWorkspaceRequest

Objekt

Aktualisieren der Arbeitsbereichsanforderungsnutzlast.

Name Typ Beschreibung
description

string

Die Arbeitsbereichsbeschreibung.
Die Beschreibung darf nicht mehr als 4000 Zeichen enthalten.
displayName

string

Der Anzeigename des Arbeitsbereichs.
Der Anzeigename darf nicht mehr als 256 Zeichen enthalten.
Arbeitsbereichsnamen müssen innerhalb des Mandanten eindeutig sein.
"Administratorüberwachung" ist ein reservierter Arbeitsbereichsname.

Workspace

Objekt

Ein Arbeitsbereichsobjekt.

Name Typ Beschreibung
apiEndpoint

string (uri)

HTTP-URL, die den API-Endpunkt für den Arbeitsbereich darstellt. Dieser Endpunktwert wird zurückgegeben, wenn der Benutzer preferWorkspaceSpecificEndpoints aktiviert. Er ermöglicht den API-Zugriff über private Links.
capacityId

string (uuid)

Die ID der Kapazität, der der Arbeitsbereich zugewiesen ist.
description

string

Die Arbeitsbereichsbeschreibung.
displayName

string

Der Anzeigename des Arbeitsbereichs.
domainId

string (uuid)

Die ID der Domäne, der der Arbeitsbereich zugewiesen ist.
id

string (uuid)

Die Arbeitsbereichs-ID.
type

WorkspaceType

Der Arbeitsbereichstyp.

WorkspaceType

Enumeration

Ein Arbeitsbereichstyp. Weitere Arbeitsbereichstypen können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
Personal

Mein Ordner oder Mein Arbeitsbereich, der zum Verwalten von Benutzerelementen verwendet wird.
Workspace

Arbeitsbereich, der zum Verwalten der Fabric-Elemente verwendet wird.
AdminWorkspace

Administratorüberwachungsarbeitsbereich. Enthält Administratorberichte wie den Überwachungsbericht und den Nutzungs- und Einführungsbericht.