Items - Update Environment

Référence

Service:: Environment

Version d'API:: v1

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

Autorisations

L’appelant doit avoir rôle de contributeur ou supérieur.

É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.
EnvironmentPublishInfo	Informations de publication 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.
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

Object

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

Object

Élément Environnement.

Nom	Type	Description
description	string	Description de l’élément.
displayName	string	Nom complet de l’élément.
id	string uuid	ID d’élément.
properties	EnvironmentPublishInfo	Propriétés de l’environnement.
type	ItemType	Type d’élément.
workspaceId	string uuid	ID de l’espace de travail.

EnvironmentPublishInfo

Object

Informations de publication 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
Cancelled	La publication de l’environnement est à l’état annulé.
Cancelling	La publication de l’environnement est en état d’annulation.
Failed	La publication de l’environnement est en état d’échec.
Running	La publication de l’environnement est en cours d’exécution.
Success	La publication de l’environnement est en état de réussite.
Waiting	La publication de l’environnement est en attente.

ErrorRelatedResource

Object

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

Object

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

Object

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.

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.
DataPipeline	Un pipeline de données.
Datamart	Datamart PowerBI.
Environment	Environnement.
Eventhouse	Un eventhouse.
Eventstream	Flux d’événements.
GraphQLApi	API pour l’élément GraphQL.
KQLDashboard	Tableau de bord KQL.
KQLDatabase	Base de données KQL.
KQLQueryset	Ensemble de requêtes KQL.
Lakehouse	Un lac.
MLExperiment	Une expérience de Machine Learning.
MLModel	Modèle Machine Learning.
MirroredDatabase	Une base de données mise en miroir.
MirroredWarehouse	Un entrepôt mis en miroir.
MountedDataFactory	Un MountedDataFactory.
Notebook	Un bloc-notes.
PaginatedReport	Rapport paginé PowerBI.
Reflex	Un réflexe.
Report	Rapport PowerBI.
SQLDatabase	A SQLDatabase.
SQLEndpoint	Point de terminaison SQL.
SemanticModel	Modèle sémantique PowerBI.
SparkJobDefinition	Définition d’un travail Spark.
Warehouse	Un entrepôt.

PublishDetails

Object

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.
startTime	string date-time	Heure de début de l’opération de publication.
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

Object

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

Object

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

Object

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

EnvironmentPublishInfo

EnvironmentPublishState

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemType

PublishDetails

SparkLibraries

SparkSettings

UpdateEnvironmentRequest

Ressources supplémentaires