Items - Create Environment

Služba:: Environment

Verzia rozhrania API:: v1

Vytvorí prostredie v zadanom pracovnom priestore.
Toto rozhranie API podporuje dlhotrvajúce operácie (LRO).

Povolenia

Volajúci musí mať rolu pracovného priestoru prispievateľa .

Povinné delegované rozsahy

Environment.ReadWrite.All alebo Item.ReadWrite.All

Obmedzenia

Ak chcete vytvoriť prostredie, pracovný priestor musí byť v podporovanej Fabric kapacite.

podporované identity Microsoft Entra

Toto rozhranie API podporuje Microsoft identity uvedené v tejto časti.

Identita	Podpora
Používateľ	Áno
Objekt služby a spravované identity	Áno

Rozhranie

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

Parametre URI

Name	V	Povinné	Typ	Description
workspaceId	path	True	string (uuid)	ID pracovného priestoru.

Text požiadavky

Name	Povinné	Typ	Description
displayName	True	string	Zobrazovaný názov prostredia.
definition		EnvironmentDefinition	Verejná definícia prostredia.
description		string	Popis prostredia. Maximálna dĺžka je 256 znakov.
folderId		string (uuid)	ID priečinka. Ak parameter nie je zadaný alebo má hodnotu null, vytvorí sa prostredie s pracovným priestorom ako jeho priečinkom.
sensitivityLabelSettings		SensitivityLabelSettings	Nastavenia označenia citlivosti pre prostredie.

Odpovede

Name	Typ	Description
201 Created	Environment	Úspešne vytvorené
202 Accepted		Žiadosť prijatá, prebieha poskytovanie prostriedkov prostredia Hlavičky Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Prekročil sa limit rýchlosti služby. Server vráti hlavičku `Retry-After` v sekundách, ako dlho musí klient počkať, kým odošle ďalšie požiadavky. Hlavičky Retry-After: integer
Other Status Codes	ErrorResponse	Bežné kódy chýb: InvalidItemType – typ položky je neplatný ItemDisplayNameAlreadyInUse – zobrazovaný názov položky sa už používa CorruptedPayload – poskytnutá údajová časť je poškodená. Limit položiek pracovného priestoruItemsLimitExceeded – limit položiek pracovného priestoru bol prekročený.

Príklady

Create an environment example

Create an environment with public definition example

Create an environment example

Vzorová požiadavka

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/environments

{
  "displayName": "Environment_1",
  "description": "An environment description."
}

Vzorová odpoveď

Kód stavu:: 201

{
  "displayName": "Environment_1",
  "description": "An environment description.",
  "type": "Environment",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715",
  "sensitivityLabel": {
    "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
  }
}

Kód stavu:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Create an environment with public definition example

Vzorová požiadavka

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/environments

{
  "displayName": "Environment_1",
  "description": "An environment description.",
  "definition": {
    "parts": [
      {
        "path": "Libraries/CustomLibraries/samplelibrary.jar",
        "payload": "eyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/CustomLibraries/samplepython.py",
        "payload": "FyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/CustomLibraries/samplewheel-0.18.0-py2.py3-none-any.whl",
        "payload": "LyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/CustomLibraries/sampleR.tar.gz",
        "payload": "ZyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/PublicLibraries/environment.yml",
        "payload": "IyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Setting/Sparkcompute.yml",
        "payload": "GyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Vzorová odpoveď

Kód stavu:: 201

{
  "displayName": "Environment_1",
  "description": "An environment description.",
  "type": "Environment",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715",
  "sensitivityLabel": {
    "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
  }
}

Kód stavu:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Definície

Name	Description
ComponentPublishInfo	Publikujte informácie o jednotlivých súčastiach v prostredí.
CreateEnvironmentRequest	Vytvorenie údajovej časti požiadavky prostredia.
EntireTenantPrincipal	Predstavuje objekt nájomníka
Environment	Položka prostredia.
EnvironmentDefinition	Objekt verejnej definície prostredia. Ďalšie podrobnosti o štruktúre definície prostredia nájdete v tomto článku .
EnvironmentDefinitionPart	Časť objektu definície prostredia.
EnvironmentProperties	Vlastnosti prostredia.
EnvironmentPublishState	Stav publikovania. V priebehu času je možné pridať ďalšie typy stavov.
ErrorRelatedResource	Objekt s podrobnosťami o zdroji súvisiacej s chybou.
ErrorResponse	Odpoveď na chybu.
ErrorResponseDetails	Podrobnosti o chybovej odpovedi.
GroupDetails	Podrobnosti špecifické pre skupinu. Platí, ak je `Group`typ objektu .
GroupPrincipal	Predstavuje skupinu zabezpečenia.
GroupType	Typ skupiny. V priebehu času je možné pridať ďalšie typy skupín.
ItemTag	Predstavuje značku použitú na položke.
ItemType	Typ položky. V priebehu času je možné pridať ďalšie typy položiek.
PayloadType	Typ údajovej časti definície. V priebehu času je možné pridať ďalšie typy údajovej časti.
PrincipalType	Typ objektu. V priebehu času je možné pridať ďalšie typy objektov.
PublishDetails	Podrobnosti o operácii publikovania.
SensitivityLabel	Predstavuje označenie citlivosti použité na položku.
SensitivityLabelApplyStrategy	Stratégia používania označenia citlivosti. Predvolená hodnota je ApplyOrFail. V priebehu času je možné pridať ďalšie typy.
SensitivityLabelSettings	Nastavenia označenia citlivosti.
ServicePrincipalDetails	Konkrétne podrobnosti objektu služby. Platí, ak je `ServicePrincipal`typ objektu .
ServicePrincipalPrincipal	Predstavuje Microsoft Entra objekt služby.
ServicePrincipalProfileDetails	Podrobnosti o profile objektu služby. Platí, ak je `ServicePrincipalProfile`typ objektu .
ServicePrincipalProfilePrincipal	Predstavuje profil objektu služby.
SparkLibraries	Knižnice Spark.
SparkSettings	Nastavenia spark.
UserDetails	Konkrétne podrobnosti o objekte používateľa. Platí, ak je `User`typ objektu .
UserPrincipal	Predstavuje Microsoft Entra hlavného používateľa.

ComponentPublishInfo

Object

Publikujte informácie o jednotlivých súčastiach v prostredí.

Name	Typ	Description
sparkLibraries	SparkLibraries	Knižnice Spark publikuujú informácie.
sparkSettings	SparkSettings	Nastavenia Spark publikujte informácie.

CreateEnvironmentRequest

Object

Vytvorenie údajovej časti požiadavky prostredia.

Name	Typ	Description
definition	EnvironmentDefinition	Verejná definícia prostredia.
description	string	Popis prostredia. Maximálna dĺžka je 256 znakov.
displayName	string	Zobrazovaný názov prostredia.
folderId	string (uuid)	ID priečinka. Ak parameter nie je zadaný alebo má hodnotu null, vytvorí sa prostredie s pracovným priestorom ako jeho priečinkom.
sensitivityLabelSettings	SensitivityLabelSettings	Nastavenia označenia citlivosti pre prostredie.

EntireTenantPrincipal

Object

Predstavuje objekt nájomníka

Name	Typ	Description
displayName	string	Zobrazovaný názov objektu.
id	string (uuid)	ID objektu.
type	string: EntireTenant	Typ objektu. V priebehu času je možné pridať ďalšie typy objektov.

Environment

Object

Položka prostredia.

Name	Typ	Description
defaultIdentity	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Predvolená identita položky.
description	string	Popis položky.
displayName	string	Zobrazovaný názov položky.
folderId	string (uuid)	ID priečinka.
id	string (uuid)	ID položky.
properties	EnvironmentProperties	Vlastnosti prostredia.
sensitivityLabel	SensitivityLabel	Označenie citlivosti položky.
tags	ItemTag[]	Zoznam použitých značiek.
type	ItemType	Typ položky.
workspaceId	string (uuid)	ID pracovného priestoru.

EnvironmentDefinition

Object

Objekt verejnej definície prostredia. Ďalšie podrobnosti o štruktúre definície prostredia nájdete v tomto článku .

Name	Typ	Description
format	string	Formát definície prostredia.
parts	EnvironmentDefinitionPart[]	Zoznam častí definície.

EnvironmentDefinitionPart

Object

Časť objektu definície prostredia.

Name	Typ	Description
path	string	Cesta časti prostredia.
payload	string	Údajová časť prostredia.
payloadType	PayloadType	Typ údajovej časti.

EnvironmentProperties

Object

Vlastnosti prostredia.

Name	Typ	Description
publishDetails	PublishDetails	Podrobnosti o operácii publikovania prostredia.

EnvironmentPublishState

Enumerácia

Stav publikovania. V priebehu času je možné pridať ďalšie typy stavov.

Hodnota	Description
Success	Publikovanie prostredia je v stave úspechu.
Cancelled	Publikovanie prostredia je v stave zrušené.
Failed	Publikovanie prostredia je v stave neúspešných.
Cancelling	Publikovanie prostredia je v stave zrušenia.
Running	Publikovanie prostredia je v stave spustenia.
Waiting	Publikovanie prostredia čaká.

ErrorRelatedResource

Object

Objekt s podrobnosťami o zdroji súvisiacej s chybou.

Name	Typ	Description
resourceId	string	ID prostriedku, ktoré je súčasťou chyby.
resourceType	string	Typ prostriedku, ktorý je zapojený do chyby.

ErrorResponse

Object

Odpoveď na chybu.

Name	Typ	Description
errorCode	string	Konkrétny identifikátor, ktorý poskytuje informácie o chybovej podmienke a umožňuje štandardizovanú komunikáciu medzi našou službou a používateľmi.
isRetriable	boolean	Ak je hodnota true, žiadosť sa môže zopakovať. `Retry-After` Ak je k dispozícii, oneskorenie môžete určiť pomocou hlavičky odpovede.
message	string	Zobrazenie chyby čitateľné ľuďmi.
moreDetails	ErrorResponseDetails[]	Zoznam ďalších podrobností o chybe.
relatedResource	ErrorRelatedResource	Podrobnosti o zdrojoch súvisiacich s chybou.
requestId	string (uuid)	ID požiadavky súvisiacej s chybou.

ErrorResponseDetails

Object

Podrobnosti o chybovej odpovedi.

Name	Typ	Description
errorCode	string	Konkrétny identifikátor, ktorý poskytuje informácie o chybovej podmienke a umožňuje štandardizovanú komunikáciu medzi našou službou a používateľmi.
message	string	Zobrazenie chyby čitateľné ľuďmi.
relatedResource	ErrorRelatedResource	Podrobnosti o zdrojoch súvisiacich s chybou.

GroupDetails

Object

Podrobnosti špecifické pre skupinu. Platí, ak je Grouptyp objektu .

Name	Typ	Description
groupType	GroupType	Typ skupiny. V priebehu času je možné pridať ďalšie typy skupín.

GroupPrincipal

Object

Predstavuje skupinu zabezpečenia.

Name	Typ	Description
displayName	string	Zobrazovaný názov objektu.
groupDetails	GroupDetails	Podrobnosti špecifické pre skupinu. Platí, ak je `Group`typ objektu .
id	string (uuid)	ID objektu.
type	string: Group	Typ objektu. V priebehu času je možné pridať ďalšie typy objektov.

GroupType

Enumerácia

Typ skupiny. V priebehu času je možné pridať ďalšie typy skupín.

Hodnota	Description
Unknown	Typ hlavnej skupiny nie je známy.
SecurityGroup	Principal je skupina zabezpečenia.
DistributionList	Principal je distribučný zoznam.

ItemTag

Object

Predstavuje značku použitú na položke.

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

ItemType

Enumerácia

Typ položky. V priebehu času je možné pridať ďalšie typy položiek.

Hodnota	Description
Dashboard	Tabuľa služby PowerBI.
Report	Zostava PowerBI.
SemanticModel	Sémantický model PowerBI.
PaginatedReport	Stránkovaná zostava služby PowerBI.
Datamart	Údajový diagram služby PowerBI.
Lakehouse	Jazero.
Eventhouse	Eventhouse.
Environment	Prostredie.
KQLDatabase	Databáza KQL.
KQLQueryset	Množina dotazov KQL.
KQLDashboard	Tabuľa KQL.
DataPipeline	Kanál údajov.
Notebook	Poznámkový blok.
SparkJobDefinition	Definícia úlohy iskry.
MLExperiment	Experiment strojového učenia.
MLModel	Model strojového učenia.
Warehouse	Sklad.
Eventstream	Udalosť eventstream.
SQLEndpoint	Koncový bod SQL.
MirroredWarehouse	Zrkadlový sklad.
MirroredDatabase	Zrkadlová databáza.
Reflex	A Reflex.
GraphQLApi	Rozhranie API pre položku GraphQL.
MountedDataFactory	A MountedDataFactory.
SQLDatabase	Databáza SQLDatabase.
CopyJob	Kopírovať úlohu.
VariableLibrary	A VariableLibrary.
Dataflow	Tok údajov.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Snímka skladu.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Digitálny postup Twin Buildera.
MirroredAzureDatabricksCatalog	Zrkadlový katalóg Azure databricks.
Map	Mapa.
AnomalyDetector	Detektor anomálií.
UserDataFunction	Funkcia user data function.
GraphModel	A GraphModel.
GraphQuerySet	Množina dotazov Graphu.
SnowflakeDatabase	Databáza Snowflake na ukladanie tabuliek ľadovec vytvorených z konta Snowflake.
OperationsAgent	OperationsAgent (Operácia).
CosmosDBDatabase	Databáza Cosmos DB.
Ontology	Ontológia.
EventSchemaSet	Množina schém udalosti.
DataAgent	DataAgent (Údajovýgens).
MirroredCatalog	Zrkadlovýcatalog.
AppBackend	An AppBackend.
OrgApp	Aplikácia organizácie.
OrgAppAudience	Publikum aplikácií organizácie.
DataBuildToolJob	A DataBuildToolJob.
AzureDatabricksStorage	Úložný priestor podložený OneLakeom pre Azure Databricks.
Plan	Plán.

PayloadType

Enumerácia

Typ údajovej časti definície. V priebehu času je možné pridať ďalšie typy údajovej časti.

Hodnota	Description
InlineBase64	Inline Base 64.

PrincipalType

Enumerácia

Typ objektu. V priebehu času je možné pridať ďalšie typy objektov.

Hodnota	Description
User	Principal je Microsoft Entra objektom používateľa.
ServicePrincipal	Principal je Microsoft Entra objekt služby.
Group	Principal je skupina zabezpečenia.
ServicePrincipalProfile	Principal je profil objektu služby.
EntireTenant	Možnosť Principal predstavuje všetkých používateľov nájomníka.

PublishDetails

Object

Podrobnosti o operácii publikovania.

Name	Typ	Description
componentPublishInfo	ComponentPublishInfo	Súčasť prostredia publikuje informácie.
endTime	string (date-time)	Čas ukončenia operácie publikovania v UTC pomocou formátu RRRR-MM-DDTHH:mm:sssssZ.
startTime	string (date-time)	Čas začatia operácie publikovania v UTC pomocou formátu RRRR-MM-DDTHH:mm:sssssZ.
state	EnvironmentPublishState	Stav publikovania. V priebehu času je možné pridať ďalšie typy stavov.
targetVersion	string (uuid)	Cieľová verion, ktorá sa má publikovať.

SensitivityLabel

Object

Predstavuje označenie citlivosti použité na položku.

Name	Typ	Description
id	string (uuid)	ID označenia citlivosti.

SensitivityLabelApplyStrategy

Enumerácia

Stratégia používania označenia citlivosti. Predvolená hodnota je ApplyOrFail. V priebehu času je možné pridať ďalšie typy.

Hodnota	Description
ApplyOrFail	Použite označenie citlivosti alebo zlyhajte operáciu, ak sa nedá použiť.
Ignore	Ignorujte označenie citlivosti, ak ho nie je možné použiť a pokračovať s operáciou bez použitia označenia.

SensitivityLabelSettings

Object

Nastavenia označenia citlivosti.

Name	Typ	Description
labelId	string (uuid)	ID označenia citlivosti.
sensitivityLabelApplyStrategy	SensitivityLabelApplyStrategy	Stratégia používania označenia citlivosti.

ServicePrincipalDetails

Object

Konkrétne podrobnosti objektu služby. Platí, ak je ServicePrincipaltyp objektu .

Name	Typ	Description
aadAppId	string (uuid)	Microsoft Entra id objektu služby.

ServicePrincipalPrincipal

Object

Predstavuje Microsoft Entra objekt služby.

Name	Typ	Description
displayName	string	Zobrazovaný názov objektu.
id	string (uuid)	ID objektu.
servicePrincipalDetails	ServicePrincipalDetails	Konkrétne podrobnosti objektu služby. Platí, ak je `ServicePrincipal`typ objektu .
type	string: ServicePrincipal	Typ objektu. V priebehu času je možné pridať ďalšie typy objektov.

ServicePrincipalProfileDetails

Object

Podrobnosti o profile objektu služby. Platí, ak je ServicePrincipalProfiletyp objektu .

Name	Typ	Description
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Nadradený objekt profilu služby.

ServicePrincipalProfilePrincipal

Object

Predstavuje profil objektu služby.

Name	Typ	Description
displayName	string	Zobrazovaný názov objektu.
id	string (uuid)	ID objektu.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Podrobnosti o profile objektu služby. Platí, ak je `ServicePrincipalProfile`typ objektu .
type	string: ServicePrincipalProfile	Typ objektu. V priebehu času je možné pridať ďalšie typy objektov.

SparkLibraries

Object

Knižnice Spark.

Name	Typ	Description
state	EnvironmentPublishState	Stav publikovania. V priebehu času je možné pridať ďalšie typy stavov.

SparkSettings

Object

Nastavenia spark.

Name	Typ	Description
state	EnvironmentPublishState	Stav publikovania. V priebehu času je možné pridať ďalšie typy stavov.

UserDetails

Object

Konkrétne podrobnosti o objekte používateľa. Platí, ak je Usertyp objektu .

Name	Typ	Description
userPrincipalName	string	Hlavné meno používateľa.

UserPrincipal

Object

Predstavuje Microsoft Entra hlavného používateľa.

Name	Typ	Description
displayName	string	Zobrazovaný názov objektu.
id	string (uuid)	ID objektu.
type	string: User	Typ objektu. V priebehu času je možné pridať ďalšie typy objektov.
userDetails	UserDetails	Konkrétne podrobnosti o objekte používateľa. Platí, ak je `User`typ objektu .