Items - Create Environment

Dienst:: Environment

API-Version:: v1

Erstellt eine Umgebung im angegebenen Arbeitsbereich.
Diese API unterstützt LRO-.

Erlaubnisse

Der Aufrufer muss über eine Rolle des Mitwirkenden-Arbeitsbereichs verfügen.

Erforderliche delegierte Bereiche

Environment.ReadWrite.All oder Item.ReadWrite.All

Begrenzungen

Zum Erstellen einer Umgebung muss sich der Arbeitsbereich auf einer unterstützten Fabric-Kapazität befinden.

Von Microsoft Entra unterstützte Identitäten

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

Identität	Unterstützen
Benutzer	Ja
Dienstprinzipal und verwaltete Identitäten	Ja

Schnittstelle

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
workspaceId	path	True	string (uuid)	Die Arbeitsbereichs-ID.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
displayName	True	string	Der Anzeigename der Umgebung.
definition		EnvironmentDefinition	Die öffentliche Umgebungsdefinition.
description		string	Die Umgebungsbeschreibung. Die maximale Länge beträgt 256 Zeichen.
folderId		string (uuid)	Die Ordner-ID. Wenn sie nicht angegeben oder null ist, wird die Umgebung mit dem Arbeitsbereich als Ordner erstellt.

Antworten

Name	Typ	Beschreibung
201 Created	Environment	Erfolgreich erstellt
202 Accepted		Akzeptierte Anforderung, Umgebungsbereitstellung in Bearbeitung Header Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Häufige Fehlercodes: InvalidItemType – Elementtyp ist ungültig. ItemDisplayNameAlreadyInUse - Elementanzeigename wird bereits verwendet CorruptedPayload – Die bereitgestellte Nutzlast ist beschädigt. WorkspaceItemsLimitExceededed – Grenzwert für Arbeitsbereichselemente wurde überschritten.

Name

Typ

Beschreibung

201 Created

Environment

Erfolgreich erstellt

202 Accepted

Akzeptierte Anforderung, Umgebungsbereitstellung in Bearbeitung

Header

Location: string
x-ms-operation-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

Häufige Fehlercodes:

InvalidItemType – Elementtyp ist ungültig.
ItemDisplayNameAlreadyInUse - Elementanzeigename wird bereits verwendet
CorruptedPayload – Die bereitgestellte Nutzlast ist beschädigt.
WorkspaceItemsLimitExceededed – Grenzwert für Arbeitsbereichselemente wurde überschritten.

Beispiele

Create an environment example

Create an environment with public definition example

Create an environment example

Beispielanforderung

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/environments

{
  "displayName": "Environment_1",
  "description": "An environment description."
}

Beispiel für eine Antwort

Statuscode:: 201

{
  "displayName": "Environment_1",
  "description": "An environment description.",
  "type": "Environment",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Statuscode:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Create an environment with public definition example

Beispielanforderung

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/environments

{
  "displayName": "Environment_1",
  "description": "An environment description.",
  "definition": {
    "parts": [
      {
        "path": "Libraries/CustomLibraries/samplelibrary.jar",
        "payload": "eyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/CustomLibraries/samplepython.py",
        "payload": "FyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/CustomLibraries/samplewheel-0.18.0-py2.py3-none-any.whl",
        "payload": "LyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/CustomLibraries/sampleR.tar.gz",
        "payload": "ZyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/PublicLibraries/environment.yml",
        "payload": "IyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Setting/Sparkcompute.yml",
        "payload": "GyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Beispiel für eine Antwort

Statuscode:: 201

{
  "displayName": "Environment_1",
  "description": "An environment description.",
  "type": "Environment",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Statuscode:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Definitionen

Name	Beschreibung
ComponentPublishInfo	Veröffentlichen Sie Informationen für die einzelnen Komponenten in der Umgebung.
CreateEnvironmentRequest	Erstellen Sie die Nutzlast der Umgebungsanforderung.
Environment	Ein Umgebungselement.
EnvironmentDefinition	Öffentliches Definitionsobjekt der Umgebung. Weitere Informationen zum Erstellen einer öffentlichen Umgebungsdefinition finden Sie in diesem Artikel .
EnvironmentDefinitionPart	Umgebungsdefinitionsteilobjekt.
EnvironmentProperties	Umgebungseigenschaften.
EnvironmentPublishState	Veröffentlichungsstatus. Zusätzliche Statustypen können im Laufe der Zeit hinzugefügt werden.
ErrorRelatedResource	Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
ItemTag	Stellt ein Tag dar, das auf ein Element angewendet wird.
ItemType	Der Typ des Elements. Zusätzliche Elementtypen können im Laufe der Zeit hinzugefügt werden.
PayloadType	Der Typ der Definitionsteilnutzlast. Zusätzliche Nutzlasttypen können im Laufe der Zeit hinzugefügt werden.
PublishDetails	Details des Veröffentlichungsvorgangs.
SparkLibraries	Spark-Bibliotheken.
SparkSettings	Spark-Einstellungen.

ComponentPublishInfo

Objekt

Veröffentlichen Sie Informationen für die einzelnen Komponenten in der Umgebung.

Name	Typ	Beschreibung
sparkLibraries	SparkLibraries	Spark-Bibliotheken veröffentlichen Informationen.
sparkSettings	SparkSettings	Spark-Einstellungen veröffentlichen Informationen.

CreateEnvironmentRequest

Objekt

Erstellen Sie die Nutzlast der Umgebungsanforderung.

Name	Typ	Beschreibung
definition	EnvironmentDefinition	Die öffentliche Umgebungsdefinition.
description	string	Die Umgebungsbeschreibung. Die maximale Länge beträgt 256 Zeichen.
displayName	string	Der Anzeigename der Umgebung.
folderId	string (uuid)	Die Ordner-ID. Wenn sie nicht angegeben oder null ist, wird die Umgebung mit dem Arbeitsbereich als Ordner erstellt.

Environment

Objekt

Ein Umgebungselement.

Name	Typ	Beschreibung
description	string	Die Elementbeschreibung.
displayName	string	Der Anzeigename des Elements.
folderId	string (uuid)	Die Ordner-ID.
id	string (uuid)	Die Element-ID.
properties	EnvironmentProperties	Die Umgebungseigenschaften.
tags	ItemTag[]	Liste der angewendeten Tags.
type	ItemType	Der Elementtyp.
workspaceId	string (uuid)	Die Arbeitsbereichs-ID.

EnvironmentDefinition

Objekt

Öffentliches Definitionsobjekt der Umgebung. Weitere Informationen zum Erstellen einer öffentlichen Umgebungsdefinition finden Sie in diesem Artikel .

Name	Typ	Beschreibung
format	string	Das Format der Umgebungsdefinition.
parts	EnvironmentDefinitionPart[]	Eine Liste der Definitionsteile.

EnvironmentDefinitionPart

Objekt

Umgebungsdefinitionsteilobjekt.

Name	Typ	Beschreibung
path	string	Der Umgebungsteilpfad.
payload	string	Die Nutzlast des Umgebungsteils.
payloadType	PayloadType	Der Nutzlasttyp.

EnvironmentProperties

Objekt

Umgebungseigenschaften.

Name	Typ	Beschreibung
publishDetails	PublishDetails	Details zum Veröffentlichen von Vorgängen in der Umgebung.

EnvironmentPublishState

Enumeration

Veröffentlichungsstatus. Zusätzliche Statustypen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
Success	Die Veröffentlichung der Umgebung befindet sich im Erfolgszustand.
Cancelled	Die Veröffentlichung der Umgebung befindet sich im Zustand "Abgebrochen".
Failed	Die Veröffentlichung der Umgebung ist fehlgeschlagen.
Cancelling	Die Veröffentlichung der Umgebung befindet sich im Zustand "Abbrechen".
Running	Die Veröffentlichung der Umgebung befindet sich im Ausführungszustand.
Waiting	Die Veröffentlichung der Umgebung befindet sich im Wartezustand.

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.

ItemTag

Objekt

Stellt ein Tag dar, das auf ein Element angewendet wird.

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

ItemType

Enumeration

Der Typ des Elements. Zusätzliche Elementtypen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
Dashboard	PowerBI-Dashboard.
Report	PowerBI-Bericht.
SemanticModel	PowerBI-Semantikmodell.
PaginatedReport	PowerBI-Paginated-Bericht.
Datamart	PowerBI datamart.
Lakehouse	Ein Seehaus.
Eventhouse	Ein Eventhouse.
Environment	Eine Umgebung.
KQLDatabase	Eine KQL-Datenbank.
KQLQueryset	Ein KQL-Abfrageset.
KQLDashboard	Ein KQL-Dashboard.
DataPipeline	Eine Datenpipeline.
Notebook	Ein Notizbuch.
SparkJobDefinition	Eine Sparkauftragsdefinition.
MLExperiment	Ein Machine Learning-Experiment.
MLModel	Ein Machine Learning-Modell.
Warehouse	Ein Lagerhaus.
Eventstream	Ein Ereignisstream.
SQLEndpoint	Ein SQL-Endpunkt.
MirroredWarehouse	Ein gespiegeltes Lager.
MirroredDatabase	Eine gespiegelte Datenbank.
Reflex	Ein Reflex.
GraphQLApi	Eine API für GraphQL-Element.
MountedDataFactory	Eine MountedDataFactory.
SQLDatabase	Eine SQLDatabase.
CopyJob	Ein Kopierauftrag.
VariableLibrary	Eine VariableLibrary.
Dataflow	Ein Datenfluss.
ApacheAirflowJob	Ein ApacheAirflowJob.
WarehouseSnapshot	Eine Warehouse-Momentaufnahme.
DigitalTwinBuilder	Ein DigitalTwinBuilder.
DigitalTwinBuilderFlow	Ein Digital Twin Builder Flow.
MirroredAzureDatabricksCatalog	Ein gespiegelter Azure Databricks-Katalog.
Map	Eine Karte.
AnomalyDetector	Anomaliedetektor.
UserDataFunction	Eine Benutzerdatenfunktion.
GraphModel	Ein GraphModel.
GraphQuerySet	Ein Graph QuerySet.
SnowflakeDatabase	Eine Snowflake-Datenbank zum Speichern von Iceberg-Tabellen, die aus dem Snowflake-Konto erstellt wurden.
OperationsAgent	Ein OperationsAgent.
CosmosDBDatabase	Eine Cosmos DB-Datenbank.
Ontology	Eine Ontologie.
EventSchemaSet	Ein EventSchemaSet.

PayloadType

Enumeration

Der Typ der Definitionsteilnutzlast. Zusätzliche Nutzlasttypen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
InlineBase64	Inlinebasis 64.

PublishDetails

Objekt

Details des Veröffentlichungsvorgangs.

Name	Typ	Beschreibung
componentPublishInfo	ComponentPublishInfo	Informationen zur Umgebungskomponente veröffentlichen.
endTime	string (date-time)	Endzeit des Veröffentlichungsvorgangs in UTC mit dem Format JJJJ-MM-DDTHH:mm:sssZ.
startTime	string (date-time)	Startzeit des Veröffentlichungsvorgangs in UTC mit dem Format JJJJ-MM-TTTHH:mm:sssZ.
state	EnvironmentPublishState	Veröffentlichungsstatus. Zusätzliche Statustypen können im Laufe der Zeit hinzugefügt werden.
targetVersion	string (uuid)	Zielverion, die veröffentlicht werden soll.

SparkLibraries

Objekt

Spark-Bibliotheken.

Name	Typ	Beschreibung
state	EnvironmentPublishState	Veröffentlichungsstatus. Zusätzliche Statustypen können im Laufe der Zeit hinzugefügt werden.

SparkSettings

Objekt

Spark-Einstellungen.

Name	Typ	Beschreibung
state	EnvironmentPublishState	Veröffentlichungsstatus. Zusätzliche Statustypen können im Laufe der Zeit hinzugefügt werden.

Freigeben über

Items - Create Environment

Erlaubnisse

Erforderliche delegierte Bereiche

Begrenzungen

Von Microsoft Entra unterstützte Identitäten

Schnittstelle

URI-Parameter

Anforderungstext

Antworten

Beispiele

Create an environment example

Beispielanforderung

Beispiel für eine Antwort

Create an environment with public definition example

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ComponentPublishInfo

CreateEnvironmentRequest

Environment

EnvironmentDefinition

EnvironmentDefinitionPart

EnvironmentProperties

EnvironmentPublishState

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

PayloadType

PublishDetails

SparkLibraries

SparkSettings