Items - Update Environment

Referens

Tjänst:: Environment

API-version:: v1

Uppdaterar egenskaperna för den angivna miljön.

Behörigheter

Anroparen måste ha deltagare eller högre arbetsyteroll.

Obligatoriska delegerade omfång

Environment.ReadWrite.All eller Item.ReadWrite.All

Identiteter som stöds av Microsoft Entra

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identitet	Stöd
Användare	Ja
Tjänstens huvudnamn och hanterade identiteter	Ja

Gränssnitt

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
environmentId	path	True	string uuid	Miljö-ID:t.
workspaceId	path	True	string uuid	Arbetsytans ID.

Begärandetext

Name	Typ	Description
description	string	Miljöbeskrivningen. Maximal längd är 256 tecken.
displayName	string	Miljövisningsnamnet.

Svar

Name	Typ	Description
200 OK	Environment	Begäran har slutförts.
Other Status Codes	ErrorResponse	Vanliga felkoder: ItemNotFound – Det begärda objektet hittades inte. InvalidRequest – Ogiltig uppdateringsbegäran

Name

Typ

Description

200 OK

Environment

Begäran har slutförts.

Other Status Codes

ErrorResponse

Vanliga felkoder:

ItemNotFound – Det begärda objektet hittades inte.
InvalidRequest – Ogiltig uppdateringsbegäran

Exempel

Update a environment example

Exempelbegäran

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

Exempelsvar

Statuskod:: 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"
}

Definitioner

Name	Description
ComponentPublishInfo	Publicera information för varje komponenter i miljön.
Environment	Ett miljöobjekt.
EnvironmentPublishInfo	Information om miljöpublicering.
EnvironmentPublishState	Publiceringstillstånd. Ytterligare tillståndstyper kan läggas till över tid.
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Information om felsvar.
ItemType	Typ av objekt. Ytterligare objekttyper kan läggas till över tid.
PublishDetails	Information om publiceringsåtgärden.
SparkLibraries	Spark-bibliotek.
SparkSettings	Spark-inställningar.
UpdateEnvironmentRequest	Uppdatera miljöbegäran.

ComponentPublishInfo

Objekt

Publicera information för varje komponenter i miljön.

Name	Typ	Description
sparkLibraries	SparkLibraries	Spark-bibliotek publicerar information.
sparkSettings	SparkSettings	Spark-inställningar publicerar information.

Environment

Objekt

Ett miljöobjekt.

Name	Typ	Description
description	string	Objektbeskrivningen.
displayName	string	Objektets visningsnamn.
id	string uuid	Objekt-ID:t.
properties	EnvironmentPublishInfo	Miljöegenskaperna.
type	ItemType	Objekttypen.
workspaceId	string uuid	Arbetsytans ID.

EnvironmentPublishInfo

Objekt

Information om miljöpublicering.

Name	Typ	Description
publishDetails	PublishDetails	Information om miljöpubliceringsåtgärder.

EnvironmentPublishState

Uppräkning

Publiceringstillstånd. Ytterligare tillståndstyper kan läggas till över tid.

Värde	Description
Cancelled	Publiceringen av miljön är i avbrutet tillstånd.
Cancelling	Miljöpublicering är i avbrutet tillstånd.
Failed	Miljöpublicering är i fel tillstånd.
Running	Miljöpublicer är i körningstillstånd.
Success	Miljöpublicering har slutförts.
Waiting	Publiceringen av miljön är i vänteläge.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name	Typ	Description
resourceId	string	Det resurs-ID som ingår i felet.
resourceType	string	Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
moreDetails	ErrorResponseDetails[]	Lista över ytterligare felinformation.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.
requestId	string	ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Information om felsvar.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.

ItemType

Uppräkning

Typ av objekt. Ytterligare objekttyper kan läggas till över tid.

Värde	Description
Dashboard	PowerBI-instrumentpanel.
DataPipeline	En datapipeline.
Datamart	PowerBI-datamart.
Environment	En miljö.
Eventhouse	Ett eventhouse.
Eventstream	En händelseström.
GraphQLApi	Ett API för GraphQL-objekt.
KQLDashboard	En KQL-instrumentpanel.
KQLDatabase	En KQL-databas.
KQLQueryset	En KQL-frågeuppsättning.
Lakehouse	Ett sjöhus.
MLExperiment	Ett maskininlärningsexperiment.
MLModel	En maskininlärningsmodell.
MirroredDatabase	En speglad databas.
MirroredWarehouse	Ett speglat lager.
MountedDataFactory	En MountedDataFactory.
Notebook	En notebook-fil.
PaginatedReport	Sidnumrerad PowerBI-rapport.
Reflex	En reflex.
Report	PowerBI-rapport.
SQLDatabase	En SQLDatabase.
SQLEndpoint	En SQL-slutpunkt.
SemanticModel	PowerBI-semantisk modell.
SparkJobDefinition	En definition för Spark-jobb.
Warehouse	Ett lager.

PublishDetails

Objekt

Information om publiceringsåtgärden.

Name	Typ	Description
componentPublishInfo	ComponentPublishInfo	Publicera information om miljökomponenten.
endTime	string date-time	Sluttid för publiceringsåtgärden.
startTime	string date-time	Starttid för publiceringsåtgärden.
state	EnvironmentPublishState	Publiceringstillstånd. Ytterligare tillståndstyper kan läggas till över tid.
targetVersion	string uuid	Målverion som ska publiceras.

SparkLibraries

Objekt

Spark-bibliotek.

Name	Typ	Description
state	EnvironmentPublishState	Publiceringstillstånd. Ytterligare tillståndstyper kan läggas till över tid.

SparkSettings

Objekt

Spark-inställningar.

Name	Typ	Description
state	EnvironmentPublishState	Publiceringstillstånd. Ytterligare tillståndstyper kan läggas till över tid.

UpdateEnvironmentRequest

Objekt

Uppdatera miljöbegäran.

Name	Typ	Description
description	string	Miljöbeskrivningen. Maximal längd är 256 tecken.
displayName	string	Miljövisningsnamnet.

Dela via

Items - Update Environment

Behörigheter

Obligatoriska delegerade omfång

Identiteter som stöds av Microsoft Entra

Gränssnitt

URI-parametrar

Begärandetext

Svar

Exempel

Update a environment example

Exempelbegäran

Exempelsvar

Definitioner

ComponentPublishInfo

Environment

EnvironmentPublishInfo

EnvironmentPublishState

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemType

PublishDetails

SparkLibraries

SparkSettings

UpdateEnvironmentRequest

Ytterligare resurser