Workspaces - Create Workspace

Dienst:

Core

API-Version:

v1

Erstellt einen neuen Arbeitsbereich.

Erlaubnisse

• Der Aufrufer muss über die Berechtigung zum Erstellen von Arbeitsbereichen verfügen, die vom Fabric-Administrator gewährt werden. Weitere Informationen finden Sie unter: Erstellen von Arbeitsbereichen.
• Der Aufrufer muss über Mitwirkendeberechtigungen verfügen oder ein Administrator für die Kapazität sein. Weitere Informationen finden Sie unter: Kapazitätsbenutzerberechtigungen.
• Dienstprinzipale müssen über die Berechtigung des Fabric-Administrators verfügen. Weitere Informationen finden Sie unter: Dienstprinzipale können Arbeitsbereiche, Verbindungen und Bereitstellungspipelinen erstellen.

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

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

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
displayName	True	string	Der Anzeigename des Arbeitsbereichs. Der Anzeigename darf nicht mehr als 256 Zeichen enthalten. Nur nicht verwendete Arbeitsbereichsnamen sind zulässig. "Administratorüberwachung" ist ein reservierter Arbeitsbereichsname.
capacityId		string (uuid)	Die ID der Kapazität, der der Arbeitsbereich zugewiesen werden soll.
description		string	Die Arbeitsbereichsbeschreibung. Die Beschreibung darf nicht mehr als 4000 Zeichen enthalten.
domainId		string (uuid)	Die ID der Domäne, der der Arbeitsbereich zugewiesen werden soll.

Antworten

Name	Typ	Beschreibung
201 Created	Workspace	Erfolgreich erstellt. Header Location: string
Other Status Codes	ErrorResponse	Häufige Fehlercodes: DomainNotFound – Die bereitgestellte Domäne wurde nicht gefunden. InsufficientPermissionsToDomain – Benutzerberechtigung für die Domäne reicht nicht aus, um den Vorgang auszuführen. UnknownError – Ein Fehler ist aufgetreten.

Beispiele

Create a workspace example

Beispielanforderung

HTTP

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

{
  "displayName": "New workspace"
}

Beispiel für eine Antwort

Statuscode:

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"
}

Definitionen

Name	Beschreibung
CreateWorkspaceRequest	Arbeitsbereichsanforderungsnutzlast erstellen.
ErrorRelatedResource	Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
Workspace	Ein Arbeitsbereichsobjekt.
WorkspaceType	Ein Arbeitsbereichstyp. Weitere Arbeitsbereichstypen können im Laufe der Zeit hinzugefügt werden.

CreateWorkspaceRequest

Objekt

Arbeitsbereichsanforderungsnutzlast erstellen.

Name	Typ	Beschreibung
capacityId	string (uuid)	Die ID der Kapazität, der der Arbeitsbereich zugewiesen werden soll.
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. Nur nicht verwendete Arbeitsbereichsnamen sind zulässig. "Administratorüberwachung" ist ein reservierter Arbeitsbereichsname.
domainId	string (uuid)	Die ID der Domäne, der der Arbeitsbereich zugewiesen werden soll.

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.

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.