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

Name	Typ	Beschreibung
200 OK	Workspace	Die Anforderung wurde erfolgreich abgeschlossen.
429 Too Many Requests	ErrorResponse	Der Dienstratengrenzwert wurde überschritten. Der Server gibt einen `Retry-After` Header zurück, der in Sekunden angibt, wie lange der Client warten muss, bevor zusätzliche Anforderungen gesendet werden. Header Retry-After: integer
Other Status Codes	ErrorResponse	Häufige Fehlercodes: UnknownError – Ein Fehler ist aufgetreten.

Workspace

Die Anforderung wurde erfolgreich abgeschlossen.

429 Too Many Requests

ErrorResponse

Der Dienstratengrenzwert wurde überschritten. Der Server gibt einen Retry-After Header zurück, der in Sekunden angibt, wie lange der Client warten muss, bevor zusätzliche Anforderungen gesendet werden.

Header

Retry-After: integer

Other Status Codes

ErrorResponse

Häufige Fehlercodes:

UnknownError – Ein Fehler ist aufgetreten.

Beispiele

Update a workspace example

Beispielanforderung

HTTP

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",
  "capacityRegion": "East US"
}

Definitionen

Name	Beschreibung
CapacityRegion	Der Bereich der Kapazität, die diesem Arbeitsbereich zugeordnet ist. Zusätzliche Kapazitätsbereichswerte können im Laufe der Zeit hinzugefügt werden.
ErrorRelatedResource	Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
UpdateWorkspaceRequest	Aktualisieren der Arbeitsbereichsanforderungsnutzlast.
Workspace	Ein Arbeitsbereichsobjekt.
WorkspaceAppliedTag	Stellt ein angewendetes Tag dar.
WorkspaceType	Ein Arbeitsbereichstyp. Weitere Arbeitsbereichstypen können im Laufe der Zeit hinzugefügt werden.

CapacityRegion

Enumeration

Der Bereich der Kapazität, die diesem Arbeitsbereich zugeordnet ist. Zusätzliche Kapazitätsbereichswerte können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
Australia East	Region Australien Ost
Australia Southeast	Australien Südost-Region
Brazil South	Region Brasilien Süd
Brazil Southeast	Region Brasilien Südost
Canada Central	Kanada–Zentralregion
Canada East	Kanada-Ostregion
Central India	Region Zentralindien
Central US	Region Zentral-USA
Central US EUAP	Zentrale US-EUAP-Region
East Asia	Region Ostasien
East US	Region Ost-USA
East US 2	Region Ost-USA 2
France Central	Region Frankreich( Zentral)
France South	Region Frankreich Süd
Germany Central	Zentrale Region Deutschland
Germany Northeast	Region Nordosten Deutschland
Israel Central	Israel Central Region
Italy North	Region Italien Nord
Japan East	Japan Ostregion
Japan West	Region Japan West
Korea Central	Zentralregion Korea
Korea South	Südkorea-Region
Mexico Central	Mexiko-Zentralregion
North Central US	Region Nord-Mittel-USA
North Europe	Region Nordeuropa
Norway East	Norwegen Ostregion
Norway West	Region Norwegen West
Poland Central	Polen Zentralregion
South Africa North	Region Südafrika Nord
South Africa West	Region Südafrika West
South Central US	Region Süd-Zentral-USA
South India	Region Südindien
Southeast Asia	Region Südostasien
Spain Central	Spanien Zentralregion
Sweden Central	Schweden Zentralregion
Switzerland North	Schweiz Nordregion
Switzerland West	Schweiz Westregion
West Europe	Region „Europa, Westen“
West India	Region Westindien
West US	West-US-Region
West US 2	Region West US 2
West US 3	Region West US 3
West Central US	Region West Central US
UAE Central	Zentralregion DER VAE
UAE North	Region Vereinigte Arabische Emirate (Nord)
Qatar Central	Zentralregion Katar
Germany West Central	Region West-Mitteldeutschland
Germany North	Nordregion Deutschland
UK South	Region Vereinigtes Königreich Süd
UK West	Region Uk West
China North	Region China Nord
China East	China-Ostregion
China East 2	China Ost 2 Region
China East 3	China Ost 3 Region
China North 2	Region China Nord 2
China North 3	China Nord-3-Region

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.
isRetriable	boolean	Wenn true, kann die Anforderung wiederholt werden. Verwenden Sie den `Retry-After` Antwortheader, um die Verzögerung zu ermitteln, falls verfügbar.
message	string	Eine lesbare Darstellung des Fehlers.
moreDetails	ErrorResponseDetails[]	Liste der zusätzlichen Fehlerdetails.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.
requestId	string (uuid)	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.
capacityRegion	CapacityRegion	Der Bereich der Kapazität, die diesem Arbeitsbereich zugeordnet 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.
tags	WorkspaceAppliedTag[]	Liste der angewendeten Tags.
type	WorkspaceType	Der Arbeitsbereichstyp.

WorkspaceAppliedTag

Objekt

Stellt ein angewendetes Tag dar.

Name	Typ	Beschreibung
displayName	string	Der Name des Tags.
id	string (uuid)	Die Tag-ID.

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.