Items - Update Environment

Dienst:

Environment

API-Version:

v1

Aktualisiert die Eigenschaften der angegebenen Umgebung.

Erlaubnisse

Der Aufrufer muss Über Lese- und Schreibberechtigungen für die Umgebung verfügen.

Erforderliche delegierte Bereiche

Environment.ReadWrite.All oder Item.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ützen
Benutzer	Ja
Dienstprinzipal und verwaltete Identitäten	Ja

Schnittstelle

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

URI-Parameter

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

Anforderungstext

Name	Typ	Beschreibung
description	string	Die Umgebungsbeschreibung. Die maximale Länge beträgt 256 Zeichen.
displayName	string	Der Anzeigename der Umgebung.

Antworten

Name	Typ	Beschreibung
200 OK	Environment	Die Anforderung wurde erfolgreich abgeschlossen.
Other Status Codes	ErrorResponse	Häufige Fehlercodes: ItemNotFound – Das angeforderte Element wurde nicht gefunden. InvalidRequest – Ungültige Updateanforderung

Beispiele

Update a environment example

Beispielanforderung

HTTP

PATCH https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/environments/5b218778-e7a5-4d73-8187-f10824047715

{
  "displayName": "Environment_New_Name",
  "description": "A new description for environment."
}

Beispiel für eine Antwort

Statuscode:

200

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

Definitionen

Name	Beschreibung
ComponentPublishInfo	Veröffentlichen Sie Informationen für die einzelnen Komponenten in der Umgebung.
Environment	Ein Umgebungselement.
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.
PublishDetails	Details des Veröffentlichungsvorgangs.
SparkLibraries	Spark-Bibliotheken.
SparkSettings	Spark-Einstellungen.
UpdateEnvironmentRequest	Aktualisieren der Umgebungsanforderung.

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.

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.

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.

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.

UpdateEnvironmentRequest

Objekt

Aktualisieren der Umgebungsanforderung.

Name	Typ	Beschreibung
description	string	Die Umgebungsbeschreibung. Die maximale Länge beträgt 256 Zeichen.
displayName	string	Der Anzeigename der Umgebung.