Items - Publish Environment (preview)

Dienst:: Environment

API-Version:: v1

Auslösen eines Veröffentlichungsvorgangs für die Umgebung.

Hinweis

Diese API ist Teil einer Betaversion und wird nur für Evaluierungs- und Entwicklungszwecke bereitgestellt. Sie kann sich basierend auf Feedback ändern und wird nicht für den Produktionseinsatz empfohlen. Diese Beta-API wird am 1. März 2026 veraltet und durch eine stabile Version ersetzt, die hier verfügbar ist. Die neue Version führt zu wichtigen Änderungen und ist nicht abwärtskompatibel. Beim Aufrufen dieser API müssen Aufrufer den Wert für den Abfrageparameter angeben true (preview Der Abfrageparameter beta wurde durch betaersetzt. Aus Gründen der Abwärtskompatibilität preview wird weiterhin unterstützt und verhält sich wie beta).

Veraltete Hinweise

Es wurde ein neuer Abfrageparameter beta eingeführt, um diesen Übergang zu erleichtern:

Der beta Abfrageparameter ist derzeit standardmäßig auf true.
Legen Sie den Wert des beta Abfrageparameters fest, um die stabile Releaseversion dieser API zu false verwenden.
Ab dem 1. März 2026 ändert sich der Standardwert beta in false.

Es wird empfohlen, Ihre Integration so schnell wie möglich zu migrieren, um die Releaseversion zu verwenden, indem Sie den false Abfrageparameter angeben beta (der Standardwert für den Abfrageparameter wird auf beta das Veraltetsdatum der false API festgelegt).

Die folgenden inkompatiblen Änderungen wurden in der Releaseversion eingeführt:

Die Antwort folgt dem LRO-Muster (Long Running Operations), und der HTTP-Antwortcode 202 kann zurückgegeben werden.

Erlaubnisse

Schreibberechtigung für das Umgebungselement.

Erforderliche delegierte Bereiche

Item.ReadWrite.All oder Environment.ReadWrite.All

Von Microsoft Entra unterstützte Identitäten

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

Identität	Support
Benutzer	Yes
Service Principal und Verwaltete Identitäten	Yes

Schnittstelle

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/staging/publish?beta={beta}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
environmentId	path	True	string (uuid)	Die Umgebungs-ID.
workspaceId	path	True	string (uuid)	Die Arbeitsbereichs-ID.
beta	query	True	boolean	Dieser Parameter gibt an, welche Version der API verwendet werden soll. Legen Sie diese Einstellung fest, um `true` die auf dieser Seite beschriebene Betaversion zu verwenden oder `false` die hier beschriebene Version zu verwenden. Ab dem 1. März 2026 ändert sich der Standardwert `beta` in `false`.

Antworten

Name	Typ	Beschreibung
200 OK	EnvironmentProperties	Die Veröffentlichungsvorgangsanforderung wurde erfolgreich übermittelt.
Other Status Codes	ErrorResponse	Häufige Fehlercodes: InvalidEnvironmentPublish – Umgebungsveröffentlichungsvorgang für die < des fehlgeschlagenen Veröffentlichungsvorgangs> aufgrund eines Fehlers fehlgeschlagen: Code = EnvironmentAnotherOngoingPublishProcess.

Name

Typ

Beschreibung

200 OK

EnvironmentProperties

Die Veröffentlichungsvorgangsanforderung wurde erfolgreich übermittelt.

Other Status Codes

ErrorResponse

Häufige Fehlercodes:

InvalidEnvironmentPublish – Umgebungsveröffentlichungsvorgang für die < des fehlgeschlagenen Veröffentlichungsvorgangs> aufgrund eines Fehlers fehlgeschlagen: Code = EnvironmentAnotherOngoingPublishProcess.

Beispiele

Publish environment example

Beispielanforderung

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/environments/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/staging/publish?beta=True

Beispiel für eine Antwort

Statuscode:: 200

{
  "publishDetails": {
    "state": "Running",
    "targetVersion": "46838a80-5450-4414-bea0-40fb6f3e0c0d",
    "startTime": "2024-03-29T14:17:09.0697022Z",
    "componentPublishInfo": {
      "sparkLibraries": {
        "state": "Running"
      },
      "sparkSettings": {
        "state": "Running"
      }
    }
  }
}

Definitionen

Name	Beschreibung
ComponentPublishInfo	Veröffentlichen Sie Informationen für die einzelnen Komponenten in der Umgebung.
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.
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.

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.

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 - Publish Environment (preview)

Veraltete Hinweise

Erlaubnisse

Erforderliche delegierte Bereiche

Von Microsoft Entra unterstützte Identitäten

Schnittstelle

URI-Parameter

Antworten

Beispiele

Publish environment example

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ComponentPublishInfo

EnvironmentProperties

EnvironmentPublishState

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

PublishDetails

SparkLibraries

SparkSettings