Items - Update Environment

Tjeneste:

Environment

API-versjon:

v1

Oppdaterer egenskapene for det angitte miljøet.

Tillatelser

Innringeren må ha lese- og skrivetillatelser for miljøet.

Nødvendige delegerte omfang

Environment.ReadWrite.All eller Item.ReadWrite.All

Microsoft Entra-støttede identiteter

Denne API-en støtter Microsoft -identiteter oppført i denne delen.

Identitet	Støtte
Bruker	Ja
tjenestekontohaver og administrerte identiteter	Ja

Grensesnitt

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

URI-parametere

Navn	I	Obligatorisk	Type	Beskrivelse
environmentId	path	True	string (uuid)	Miljø-ID-en.
workspaceId	path	True	string (uuid)	Arbeidsområde-ID-en.

Brødtekst for forespørsel

Navn	Type	Beskrivelse
description	string	Miljøbeskrivelsen. Maksimal lengde er 256 tegn.
displayName	string	Visningsnavnet for miljøet.

Svar

Navn	Type	Beskrivelse
200 OK	Environment	Forespørselen er fullført.
Other Status Codes	ErrorResponse	Vanlige feilkoder: ItemNotFound – Finner ikke det forespurte elementet. InvalidRequest – ugyldig oppdateringsforespørsel

Eksempler

Update a environment example

Eksempelforespørsel

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

Eksempelsvar

Statuskode:

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

Definisjoner

Navn	Beskrivelse
ComponentPublishInfo	Publiser informasjon for hver komponent i miljøet.
Environment	Et miljøelement.
EnvironmentProperties	Miljøegenskaper.
EnvironmentPublishState	Publiser tilstand. Flere tilstandstyper kan legges til over tid.
ErrorRelatedResource	Objektet for feilrelaterte ressursdetaljer.
ErrorResponse	Feilsvaret.
ErrorResponseDetails	Feilsvardetaljene.
ItemTag	Representerer en kode som brukes på et element.
ItemType	Typen element. Flere elementtyper kan legges til over tid.
PublishDetails	Detaljer om publiseringsoperasjon.
SparkLibraries	Spark-biblioteker.
SparkSettings	Spark-innstillinger.
UpdateEnvironmentRequest	Oppdater miljøforespørsel.

ComponentPublishInfo

Objekt

Publiser informasjon for hver komponent i miljøet.

Navn	Type	Beskrivelse
sparkLibraries	SparkLibraries	Spark-biblioteker publiserer informasjon.
sparkSettings	SparkSettings	Spark-innstillinger publiserer informasjon.

Environment

Objekt

Et miljøelement.

Navn	Type	Beskrivelse
description	string	Elementbeskrivelsen.
displayName	string	Visningsnavnet for elementet.
folderId	string (uuid)	Mappe-ID-en.
id	string (uuid)	Element-ID-en.
properties	EnvironmentProperties	Miljøegenskapene.
tags	ItemTag[]	Liste over brukte merker.
type	ItemType	Elementtypen.
workspaceId	string (uuid)	Arbeidsområde-ID-en.

EnvironmentProperties

Objekt

Miljøegenskaper.

Navn	Type	Beskrivelse
publishDetails	PublishDetails	Detaljer for publisering av miljø.

EnvironmentPublishState

Opplisting

Publiser tilstand. Flere tilstandstyper kan legges til over tid.

Verdi	Beskrivelse
Success	Publisering av miljø er i vellykket tilstand.
Cancelled	Publisering av miljø er i avbrutt tilstand.
Failed	Publisering av miljø er i mislykket tilstand.
Cancelling	Publisering av miljø er i avbrytertilstand.
Running	Publisering av miljø er i kjørende tilstand.
Waiting	Publisering av miljø er i ventetilstand.

ErrorRelatedResource

Objekt

Objektet for feilrelaterte ressursdetaljer.

Navn	Type	Beskrivelse
resourceId	string	Ressurs-ID-en som er involvert i feilen.
resourceType	string	Typen ressurs som er involvert i feilen.

ErrorResponse

Objekt

Feilsvaret.

Navn	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
moreDetails	ErrorResponseDetails[]	Liste over flere feildetaljer.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.
requestId	string	ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Objekt

Feilsvardetaljene.

Navn	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.

ItemTag

Objekt

Representerer en kode som brukes på et element.

Navn	Type	Beskrivelse
displayName	string	Navnet på koden.
id	string (uuid)	Kode-ID-en.

ItemType

Opplisting

Typen element. Flere elementtyper kan legges til over tid.

Verdi	Beskrivelse
Dashboard	PowerBI-instrumentbord.
Report	PowerBI-rapport.
SemanticModel	Semantisk PowerBI-modell.
PaginatedReport	Paginert powerbi-rapport.
Datamart	PowerBI-datamart.
Lakehouse	Et innsjøhus.
Eventhouse	Et arrangementshus.
Environment	Et miljø.
KQLDatabase	En KQL-database.
KQLQueryset	Et KQL-spørringssett.
KQLDashboard	Et KQL-instrumentbord.
DataPipeline	Et datasamlebånd.
Notebook	En notatblokk.
SparkJobDefinition	En spark-jobbdefinisjon.
MLExperiment	Et maskinlæringseksperiment.
MLModel	En maskinlæringsmodell.
Warehouse	Et lager.
Eventstream	En hendelsesstrøm.
SQLEndpoint	Et SQL-endepunkt.
MirroredWarehouse	Et speilvendt lager.
MirroredDatabase	En speilvendt database.
Reflex	En refleks.
GraphQLApi	En API for GraphQL-element.
MountedDataFactory	En MountedDataFactory.
SQLDatabase	En SQLDatabase.
CopyJob	En kopieringsjobb.
VariableLibrary	En VariableLibrary.
Dataflow	En dataflyt.
ApacheAirflowJob	En ApacheAirflowJob.
WarehouseSnapshot	Et øyeblikksbilde av lageret.
DigitalTwinBuilder	En DigitalTwinBuilder.
DigitalTwinBuilderFlow	En digital Twin Builder-flyt.
MirroredAzureDatabricksCatalog	En speilet azure databricks-katalog.
Map	Et kart.
AnomalyDetector	En avviksdetektor.
UserDataFunction	En brukerdatafunksjon.
GraphModel	En GraphModel.
GraphQuerySet	Et graph QuerySet.
SnowflakeDatabase	En Snowflake Database for å lagre Iceberg-tabeller opprettet fra Snowflake-kontoen.
OperationsAgent	En OperationsAgent.
CosmosDBDatabase	En Cosmos DB-database.
Ontology	En ontologi.
EventSchemaSet	En EventSchemaset.

PublishDetails

Objekt

Detaljer om publiseringsoperasjon.

Navn	Type	Beskrivelse
componentPublishInfo	ComponentPublishInfo	Informasjon om miljøkomponenten publiserer.
endTime	string (date-time)	Sluttidspunktet for publiseringsoperasjonen i UTC ved hjelp av formatet ÅÅÅÅÅ-MM-DDTHH:mm:ss.sssssssZ.
startTime	string (date-time)	Starttidspunktet for publiseringsoperasjonen i UTC ved hjelp av YYYY-MM-DDTHH:mm:ss.ssssssssZ-formatet.
state	EnvironmentPublishState	Publiser tilstand. Flere tilstandstyper kan legges til over tid.
targetVersion	string (uuid)	Mål-verion som skal publiseres.

SparkLibraries

Objekt

Spark-biblioteker.

Navn	Type	Beskrivelse
state	EnvironmentPublishState	Publiser tilstand. Flere tilstandstyper kan legges til over tid.

SparkSettings

Objekt

Spark-innstillinger.

Navn	Type	Beskrivelse
state	EnvironmentPublishState	Publiser tilstand. Flere tilstandstyper kan legges til over tid.

UpdateEnvironmentRequest

Objekt

Oppdater miljøforespørsel.

Navn	Type	Beskrivelse
description	string	Miljøbeskrivelsen. Maksimal lengde er 256 tegn.
displayName	string	Visningsnavnet for miljøet.