Items - Update Environment

Service:: Environment

Version d'API:: v1

Met à jour les propriétés de l’environnement spécifié.

Autorisations

L’appelant doit disposer d’autorisations de lecture et d’écriture pour l’environnement.

Étendues déléguées requises

Environment.ReadWrite.All ou Item.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é	Soutien
Utilisateur	Oui
principal de service et identités managées	Oui

Interface

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
environmentId	path	True	string (uuid)	ID d’environnement.
workspaceId	path	True	string (uuid)	ID de l’espace de travail.

Corps de la demande

Nom	Type	Description
description	string	Description de l’environnement. La longueur maximale est de 256 caractères.
displayName	string	Nom complet de l’environnement.

Réponses

Nom	Type	Description
200 OK	Environment	La demande s’est terminée avec succès.
Other Status Codes	ErrorResponse	Codes d’erreur courants : ItemNotFound : l’élément demandé n’a pas été trouvé. InvalidRequest - Demande de mise à jour non valide

Nom

Type

Description

200 OK

Environment

La demande s’est terminée avec succès.

Other Status Codes

ErrorResponse

Codes d’erreur courants :

ItemNotFound : l’élément demandé n’a pas été trouvé.
InvalidRequest - Demande de mise à jour non valide

Exemples

Update a environment example

Exemple de requête

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

Exemple de réponse

Code d’état:: 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"
}

Définitions

Nom	Description
ComponentPublishInfo	Publier des informations pour chaque composant dans l’environnement.
Environment	Élément 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.
ItemTag	Représente une balise appliquée à un élément.
ItemType	Type de l’élément. Des types d’éléments supplémentaires peuvent être ajoutés au fil du temps.
PublishDetails	Détails de l’opération de publication.
SparkLibraries	Bibliothèques Spark.
SparkSettings	Paramètres Spark.
UpdateEnvironmentRequest	Mettre à jour la demande d’environnement.

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.

Environment

Objet

Élément Environnement.

Nom	Type	Description
description	string	Description de l’élément.
displayName	string	Nom complet de l’élément.
folderId	string (uuid)	ID du dossier.
id	string (uuid)	ID d’élément.
properties	EnvironmentProperties	Propriétés de l’environnement.
tags	ItemTag[]	Liste des balises appliquées.
type	ItemType	Type d’élément.
workspaceId	string (uuid)	ID de l’espace de travail.

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.

ItemTag

Objet

Représente une balise appliquée à un élément.

Nom	Type	Description
displayName	string	Nom de la balise.
id	string (uuid)	ID de balise.

ItemType

Énumération

Type de l’élément. Des types d’éléments supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
Dashboard	Tableau de bord PowerBI.
Report	Rapport PowerBI.
SemanticModel	Modèle sémantique PowerBI.
PaginatedReport	Rapport paginé PowerBI.
Datamart	Datamart PowerBI.
Lakehouse	Un lac.
Eventhouse	Un eventhouse.
Environment	Environnement.
KQLDatabase	Base de données KQL.
KQLQueryset	Ensemble de requêtes KQL.
KQLDashboard	Tableau de bord KQL.
DataPipeline	Un pipeline de données.
Notebook	Un bloc-notes.
SparkJobDefinition	Définition d’un travail Spark.
MLExperiment	Une expérience de Machine Learning.
MLModel	Modèle Machine Learning.
Warehouse	Un entrepôt.
Eventstream	Flux d’événements.
SQLEndpoint	Point de terminaison SQL.
MirroredWarehouse	Un entrepôt mis en miroir.
MirroredDatabase	Une base de données mise en miroir.
Reflex	Un réflexe.
GraphQLApi	API pour l’élément GraphQL.
MountedDataFactory	Un MountedDataFactory.
SQLDatabase	A SQLDatabase.
CopyJob	Tâche de copie.
VariableLibrary	A VariableLibrary.
Dataflow	Flux de données.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Capture instantanée de l’entrepôt.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Flux de générateur de jumeaux numériques.
MirroredAzureDatabricksCatalog	Catalogue Azure databricks mis en miroir.
Map	Carte.
AnomalyDetector	Détecteur d’anomalies.
UserDataFunction	Fonction de données utilisateur.
GraphModel	A GraphModel.
GraphQuerySet	Ensemble de requêtes Graph.
SnowflakeDatabase	Une base de données Snowflake pour stocker les tables Iceberg créées à partir du compte Snowflake.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	Base de données Cosmos DB.
Ontology	Une ontologie.
EventSchemaSet	An EventSchemaSet.

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.

UpdateEnvironmentRequest

Objet

Mettre à jour la demande d’environnement.

Nom	Type	Description
description	string	Description de l’environnement. La longueur maximale est de 256 caractères.
displayName	string	Nom complet de l’environnement.

Partager via

Items - Update Environment

Autorisations

Étendues déléguées requises

Identités prises en charge par Microsoft Entra

Interface

Paramètres URI

Corps de la demande

Réponses

Exemples

Update a environment example

Exemple de requête

Exemple de réponse

Définitions

ComponentPublishInfo

Environment

EnvironmentProperties

EnvironmentPublishState

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

PublishDetails

SparkLibraries

SparkSettings

UpdateEnvironmentRequest