Items - Update Environment

Služba:: Environment

Verze rozhraní API:: v1

Aktualizuje vlastnosti zadaného prostředí.

Dovolení

Volající musí mít pro prostředí oprávnění ke čtení a zápisu .

Požadované delegovaná rozsahy

Environment.ReadWrite.All nebo Item.ReadWrite.All

Microsoft Entra podporované identity

Toto rozhraní API podporuje Microsoft identity uvedené v této části.

Identita	Podpora
Uživatel	Ano
Hlavní služba a Spravované identity	Ano

Rozhraní

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
environmentId	path	True	string (uuid)	ID prostředí.
workspaceId	path	True	string (uuid)	ID pracovního prostoru.

Text požadavku

Name	Typ	Description
description	string	Popis prostředí. Maximální délka je 256 znaků.
displayName	string	Zobrazovaný název prostředí.

Odpovědi

Name Typ Description

200 OK

Name	Typ	Description
200 OK	Environment	Žádost byla úspěšně dokončena.
429 Too Many Requests	ErrorResponse	Byl překročen limit přenosové rychlosti služby. Server vrátí hlavičku označující `Retry-After` , jak dlouho musí klient čekat před odesláním dalších požadavků. Hlavičky Retry-After: integer
Other Status Codes	ErrorResponse	Běžné kódy chyb: ItemNotFound – Požadovaná položka nebyla nalezena. InvalidRequest – Neplatný požadavek na aktualizaci

Environment

Žádost byla úspěšně dokončena.

429 Too Many Requests

ErrorResponse

Byl překročen limit přenosové rychlosti služby. Server vrátí hlavičku označující Retry-After , jak dlouho musí klient čekat před odesláním dalších požadavků.

Hlavičky

Retry-After: integer

Other Status Codes

ErrorResponse

Běžné kódy chyb:

ItemNotFound – Požadovaná položka nebyla nalezena.
InvalidRequest – Neplatný požadavek na aktualizaci

Příklady

Update a environment example

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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"
}

Definice

Name	Description
ComponentPublishInfo	Publikování informací pro jednotlivé komponenty v prostředí
EntireTenantPrincipal	Představuje objekt zabezpečení tenanta.
Environment	Položka prostředí.
EnvironmentProperties	Vlastnosti prostředí.
EnvironmentPublishState	Stav publikování V průběhu času mohou být přidány další typy stavů.
ErrorRelatedResource	Chyba související s objektem podrobností o prostředku.
ErrorResponse	Odpověď na chybu.
ErrorResponseDetails	Podrobnosti o odpovědi na chybu.
GroupDetails	Seskupte konkrétní podrobnosti. Použitelné, pokud je typ objektu zabezpečení `Group`.
GroupPrincipal	Představuje skupinu zabezpečení.
GroupType	Typ skupiny. V průběhu času je možné přidat další typy skupin.
ItemTag	Představuje značku použitou u položky.
ItemType	Typ položky. V průběhu času je možné přidat další typy položek.
PrincipalType	Typ objektu zabezpečení. V průběhu času je možné přidat další typy objektů zabezpečení.
PublishDetails	Podrobnosti o operaci publikování
SensitivityLabel	Představuje popisek citlivosti použitý u položky.
ServicePrincipalDetails	Podrobnosti specifické pro instanční objekt Použitelné, pokud je typ objektu zabezpečení `ServicePrincipal`.
ServicePrincipalPrincipal	Představuje Microsoft Entra instanční objekt.
ServicePrincipalProfileDetails	Podrobnosti profilu instančního objektu Použitelné, pokud je typ objektu zabezpečení `ServicePrincipalProfile`.
ServicePrincipalProfilePrincipal	Představuje profil instančního objektu.
SparkLibraries	Knihovny Sparku
SparkSettings	Nastavení Sparku
UpdateEnvironmentRequest	Aktualizujte požadavek na prostředí.
UserDetails	Podrobnosti specifické pro objekt zabezpečení uživatele. Použitelné, pokud je typ objektu zabezpečení `User`.
UserPrincipal	Představuje Microsoft Entra objekt zabezpečení uživatele.

ComponentPublishInfo

Objekt

Publikování informací pro jednotlivé komponenty v prostředí

Name	Typ	Description
sparkLibraries	SparkLibraries	Knihovny Spark publikují informace.
sparkSettings	SparkSettings	Nastavení Sparku publikuje informace.

EntireTenantPrincipal

Objekt

Představuje objekt zabezpečení tenanta.

Name	Typ	Description
displayName	string	Zobrazovaný název objektu zabezpečení.
id	string (uuid)	ID objektu zabezpečení.
type	string: EntireTenant	Typ objektu zabezpečení. V průběhu času je možné přidat další typy objektů zabezpečení.

Environment

Objekt

Položka prostředí.

Name	Typ	Description
defaultIdentity	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Výchozí identita položky
description	string	Popis položky.
displayName	string	Zobrazovaný název položky.
folderId	string (uuid)	ID složky.
id	string (uuid)	ID položky.
properties	EnvironmentProperties	Vlastnosti prostředí.
sensitivityLabel	SensitivityLabel	Popisek citlivosti položky.
tags	ItemTag[]	Seznam použitých značek
type	ItemType	Typ položky.
workspaceId	string (uuid)	ID pracovního prostoru.

EnvironmentProperties

Objekt

Vlastnosti prostředí.

Name	Typ	Description
publishDetails	PublishDetails	Podrobnosti o operaci publikování prostředí

EnvironmentPublishState

Výčet

Stav publikování V průběhu času mohou být přidány další typy stavů.

Hodnota	Description
Success	Publikování prostředí je ve stavu úspěchu.
Cancelled	Publikování prostředí je ve zrušeném stavu.
Failed	Publikování prostředí je ve stavu selhání.
Cancelling	Publikování prostředí je ve stavu zrušení.
Running	Publikování prostředí je ve spuštěném stavu.
Waiting	Publikování prostředí je ve stavu čekání.

ErrorRelatedResource

Objekt

Chyba související s objektem podrobností o prostředku.

Name	Typ	Description
resourceId	string	ID prostředku, které je součástí chyby.
resourceType	string	Typ prostředku, který je součástí chyby.

ErrorResponse

Objekt

Odpověď na chybu.

Name	Typ	Description
errorCode	string	Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message	string	Lidské čitelné vyjádření chyby.
moreDetails	ErrorResponseDetails[]	Seznam dalších podrobností o chybě
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou
requestId	string (uuid)	ID požadavku přidruženého k chybě.

ErrorResponseDetails

Objekt

Podrobnosti o odpovědi na chybu.

Name	Typ	Description
errorCode	string	Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message	string	Lidské čitelné vyjádření chyby.
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou

GroupDetails

Objekt

Seskupte konkrétní podrobnosti. Použitelné, pokud je typ objektu zabezpečení Group.

Name	Typ	Description
groupType	GroupType	Typ skupiny. V průběhu času je možné přidat další typy skupin.

GroupPrincipal

Objekt

Představuje skupinu zabezpečení.

Name	Typ	Description
displayName	string	Zobrazovaný název objektu zabezpečení.
groupDetails	GroupDetails	Seskupte konkrétní podrobnosti. Použitelné, pokud je typ objektu zabezpečení `Group`.
id	string (uuid)	ID objektu zabezpečení.
type	string: Group	Typ objektu zabezpečení. V průběhu času je možné přidat další typy objektů zabezpečení.

GroupType

Výčet

Typ skupiny. V průběhu času je možné přidat další typy skupin.

Hodnota	Description
Unknown	Typ hlavní skupiny je neznámý.
SecurityGroup	Objekt zabezpečení je skupina zabezpečení.
DistributionList	Objekt zabezpečení je distribuční seznam.

ItemTag

Objekt

Představuje značku použitou u položky.

Name	Typ	Description
displayName	string	Název značky.
id	string (uuid)	ID značky.

ItemType

Výčet

Typ položky. V průběhu času je možné přidat další typy položek.

Hodnota	Description
Dashboard	Řídicí panel PowerBI
Report	Sestava PowerBI
SemanticModel	Sémantický model PowerBI
PaginatedReport	Stránkovaná sestava PowerBI
Datamart	Datový diagram PowerBI
Lakehouse	Jezero.
Eventhouse	Eventhouse.
Environment	Prostředí.
KQLDatabase	Databáze KQL.
KQLQueryset	Sada dotazů KQL.
KQLDashboard	Řídicí panel KQL.
DataPipeline	Datový kanál.
Notebook	Poznámkový blok.
SparkJobDefinition	Definice úlohy Sparku.
MLExperiment	Experiment strojového učení.
MLModel	Model strojového učení.
Warehouse	Sklad.
Eventstream	Eventstream.
SQLEndpoint	Koncový bod SQL.
MirroredWarehouse	Zrcadlený sklad.
MirroredDatabase	Zrcadlené databáze.
Reflex	A Reflex.
GraphQLApi	Rozhraní API pro položku GraphQL
MountedDataFactory	A MountedDataFactory.
SQLDatabase	Databáze SQLDatabase.
CopyJob	Úloha kopírování.
VariableLibrary	ProměnnáLibrary.
Dataflow	Tok dat.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Snímek skladu.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Tok digitálního dvojčete.
MirroredAzureDatabricksCatalog	Zrcadlený katalog Azure Databricks.
Map	Mapa.
AnomalyDetector	Detektor anomálií.
UserDataFunction	Funkce uživatelských dat.
GraphModel	A GraphModel.
GraphQuerySet	Sada dotazů grafu.
SnowflakeDatabase	Snowflake Database pro ukládání tabulek Iceberg vytvořených z účtu Snowflake.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	Databáze Cosmos DB.
Ontology	Ontologie.
EventSchemaSet	An EventSchemaSet.
DataAgent	A DataAgent.
MirroredCatalog	ZrcadlenýCatalog.

PrincipalType

Výčet

Typ objektu zabezpečení. V průběhu času je možné přidat další typy objektů zabezpečení.

Hodnota	Description
User	Objekt zabezpečení je Microsoft Entra objekt zabezpečení uživatele.
ServicePrincipal	Instanční objekt je Microsoft Entra instanční objekt.
Group	Objekt zabezpečení je skupina zabezpečení.
ServicePrincipalProfile	Instanční objekt je profil instančního objektu.
EntireTenant	Objekt zabezpečení představuje všechny uživatele tenanta.

PublishDetails

Objekt

Podrobnosti o operaci publikování

Name	Typ	Description
componentPublishInfo	ComponentPublishInfo	Informace o publikování součásti prostředí
endTime	string (date-time)	Koncový čas operace publikování v UTC pomocí formátu RRRR-MM-DDTHH:mm:ss.sssssZ.
startTime	string (date-time)	Počáteční čas operace publikování v UTC pomocí formátu RRRR-MM-DDTHH:mm:ss.sssssZ.
state	EnvironmentPublishState	Stav publikování V průběhu času mohou být přidány další typy stavů.
targetVersion	string (uuid)	Cílová verze, která se má publikovat.

SensitivityLabel

Objekt

Představuje popisek citlivosti použitý u položky.

Name	Typ	Description
id	string (uuid)	ID popisku citlivosti.

ServicePrincipalDetails

Objekt

Podrobnosti specifické pro instanční objekt Použitelné, pokud je typ objektu zabezpečení ServicePrincipal.

Name	Typ	Description
aadAppId	string (uuid)	Instanční objekt Microsoft Entra AppId.

ServicePrincipalPrincipal

Objekt

Představuje Microsoft Entra instanční objekt.

Name	Typ	Description
displayName	string	Zobrazovaný název objektu zabezpečení.
id	string (uuid)	ID objektu zabezpečení.
servicePrincipalDetails	ServicePrincipalDetails	Podrobnosti specifické pro instanční objekt Použitelné, pokud je typ objektu zabezpečení `ServicePrincipal`.
type	string: ServicePrincipal	Typ objektu zabezpečení. V průběhu času je možné přidat další typy objektů zabezpečení.

ServicePrincipalProfileDetails

Objekt

Podrobnosti profilu instančního objektu Použitelné, pokud je typ objektu zabezpečení ServicePrincipalProfile.

Name	Typ	Description
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Nadřazený objekt profilu instančního objektu.

ServicePrincipalProfilePrincipal

Objekt

Představuje profil instančního objektu.

Name	Typ	Description
displayName	string	Zobrazovaný název objektu zabezpečení.
id	string (uuid)	ID objektu zabezpečení.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Podrobnosti profilu instančního objektu Použitelné, pokud je typ objektu zabezpečení `ServicePrincipalProfile`.
type	string: ServicePrincipalProfile	Typ objektu zabezpečení. V průběhu času je možné přidat další typy objektů zabezpečení.

SparkLibraries

Objekt

Knihovny Sparku

Name	Typ	Description
state	EnvironmentPublishState	Stav publikování V průběhu času mohou být přidány další typy stavů.

SparkSettings

Objekt

Nastavení Sparku

Name	Typ	Description
state	EnvironmentPublishState	Stav publikování V průběhu času mohou být přidány další typy stavů.

UpdateEnvironmentRequest

Objekt

Aktualizujte požadavek na prostředí.

Name	Typ	Description
description	string	Popis prostředí. Maximální délka je 256 znaků.
displayName	string	Zobrazovaný název prostředí.

UserDetails

Objekt

Podrobnosti specifické pro objekt zabezpečení uživatele. Použitelné, pokud je typ objektu zabezpečení User.

Name	Typ	Description
userPrincipalName	string	Jméno hlavního uživatele.

UserPrincipal

Objekt

Představuje Microsoft Entra objekt zabezpečení uživatele.

Name	Typ	Description
displayName	string	Zobrazovaný název objektu zabezpečení.
id	string (uuid)	ID objektu zabezpečení.
type	string: User	Typ objektu zabezpečení. V průběhu času je možné přidat další typy objektů zabezpečení.
userDetails	UserDetails	Podrobnosti specifické pro objekt zabezpečení uživatele. Použitelné, pokud je typ objektu zabezpečení `User`.