Items - Publish Environment (preview)

Service:: Environment

Version d'API:: v1

Déclenchez une opération de publication d’environnement.

Note

Cette API fait partie d’une version bêta et est fournie uniquement à des fins d’évaluation et de développement. Il peut changer en fonction des commentaires et n’est pas recommandé pour une utilisation en production. Cette API bêta sera déconseillée le 1er mars 2026 et remplacée par une version stable disponible ici. La nouvelle version introduit des changements cassants et n’est pas compatible descendante. Lors de l’appel de cette API, les appelants doivent spécifier true comme valeur pour le paramètre beta de requête (preview le paramètre de requête a été remplacé par beta. Pour la compatibilité descendante, preview il est toujours pris en charge et se comporte de la même façon que beta).

Avis de dépréciation

Un nouveau paramètre beta de requête a été introduit pour faciliter cette transition :

Le beta paramètre de requête est actuellement défini par défaut sur true.
Définissez la valeur du paramètre de beta requête pour false utiliser la version release stable de cette API.
À compter du 1er mars 2026, la valeur par défaut pour beta laquelle la valeur sera modifiée false.

Il est recommandé de migrer votre intégration pour utiliser la version release dès que possible en spécifiant false pour le beta paramètre de requête (la valeur par défaut du beta paramètre de requête sera définie false sur la date de dépréciation de l’API).

Les modifications incompatibles suivantes ont été introduites dans la version release :

La réponse suit le modèle DRO (Long Running Operations) et le code de réponse HTTP 202 peuvent être retournés.

Permissions

Autorisation d’écriture pour l’élément d’environnement.

Étendues déléguées requises

Item.ReadWrite.All ou Environment.ReadWrite.All

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identité	Support
Utilisateur	Oui
Service principal et identités gérées	Oui

Interface

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
environmentId	path	True	string (uuid)	ID d’environnement.
workspaceId	path	True	string (uuid)	Identifiant de l’espace de travail.
beta	query	True	boolean	Ce paramètre spécifie la version de l’API à utiliser. Définissez cette option pour `true` utiliser la version bêta décrite dans cette page ou pour `false` utiliser la version release détaillée ici. À compter du 1er mars 2026, la valeur par défaut pour `beta` laquelle la valeur sera modifiée `false`.

Réponses

Nom	Type	Description
200 OK	EnvironmentProperties	La demande d’opération de publication a été envoyée avec succès.
Other Status Codes	ErrorResponse	Codes d’erreur courants : InvalidEnvironmentPublish - Opération de publication d’environnement pour le < de version de l’opération> de publication ayant échoué en raison d’une erreur : Code = EnvironmentAnotherOngoingPublishProcess.

Nom

Type

Description

200 OK

EnvironmentProperties

La demande d’opération de publication a été envoyée avec succès.

Other Status Codes

ErrorResponse

Codes d’erreur courants :

InvalidEnvironmentPublish - Opération de publication d’environnement pour le < de version de l’opération> de publication ayant échoué en raison d’une erreur : Code = EnvironmentAnotherOngoingPublishProcess.

Exemples

Publish environment example

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

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

Définitions

Nom	Description
ComponentPublishInfo	Publier des informations pour chaque composant dans l’environnement.
EnvironmentProperties	Propriétés de l’environnement.
EnvironmentPublishState	État de publication. Des types d’état supplémentaires peuvent être ajoutés au fil du temps.
ErrorRelatedResource	Objet de détails de ressource associé à l’erreur.
ErrorResponse	Réponse d’erreur.
ErrorResponseDetails	Détails de la réponse d’erreur.
PublishDetails	Détails de l’opération de publication.
SparkLibraries	Bibliothèques Spark.
SparkSettings	Paramètres Spark.

ComponentPublishInfo

Objet

Publier des informations pour chaque composant dans l’environnement.

Nom	Type	Description
sparkLibraries	SparkLibraries	Les bibliothèques Spark publient des informations.
sparkSettings	SparkSettings	Les paramètres Spark publient des informations.

EnvironmentProperties

Objet

Propriétés de l’environnement.

Nom	Type	Description
publishDetails	PublishDetails	Détails de l’opération de publication de l’environnement.

EnvironmentPublishState

Énumération

État de publication. Des types d’état supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
Success	La publication de l’environnement est en état de réussite.
Cancelled	La publication de l’environnement est à l’état annulé.
Failed	La publication de l’environnement est en état d’échec.
Cancelling	La publication de l’environnement est en état d’annulation.
Running	La publication de l’environnement est en cours d’exécution.
Waiting	La publication de l’environnement est en attente.

ErrorRelatedResource

Objet

Objet de détails de ressource associé à l’erreur.

Nom	Type	Description
resourceId	string	ID de ressource impliqué dans l’erreur.
resourceType	string	Type de la ressource impliquée dans l’erreur.

ErrorResponse

Objet

Réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
moreDetails	ErrorResponseDetails[]	Liste des détails d’erreur supplémentaires.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.
requestId	string	ID de la demande associée à l’erreur.

ErrorResponseDetails

Objet

Détails de la réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.

PublishDetails

Objet

Détails de l’opération de publication.

Nom	Type	Description
componentPublishInfo	ComponentPublishInfo	Informations de publication du composant d’environnement.
endTime	string (date-time)	Heure de fin de l’opération de publication au format UTC, à l’aide du format AAAA-MM-DDTHH :mm :sssssssz.
startTime	string (date-time)	Heure de début de l’opération de publication au format UTC, à l’aide du format AAAA-MM-DDTHH :mm :sssssssZ.
state	EnvironmentPublishState	État de publication. Des types d’état supplémentaires peuvent être ajoutés au fil du temps.
targetVersion	string (uuid)	Verion cible à publier.

SparkLibraries

Objet

Bibliothèques Spark.

Nom	Type	Description
state	EnvironmentPublishState	État de publication. Des types d’état supplémentaires peuvent être ajoutés au fil du temps.

SparkSettings

Objet

Paramètres Spark.

Nom	Type	Description
state	EnvironmentPublishState	État de publication. Des types d’état supplémentaires peuvent être ajoutés au fil du temps.

Partager via

Items - Publish Environment (preview)

Avis de dépréciation

Permissions

Étendues déléguées requises

Identités prises en charge par Microsoft Entra

Interface

Paramètres URI

Réponses

Exemples

Publish environment example

Exemple de requête

Exemple de réponse

Définitions

ComponentPublishInfo

EnvironmentProperties

EnvironmentPublishState

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

PublishDetails

SparkLibraries

SparkSettings