Items - Create Environment

Služba:: Environment

Verze rozhraní API:: v1

Vytvoří prostředí v zadaném pracovním prostoru.
Toto rozhraní API podporuje dlouhotrvajících operací (LRO).

Dovolení

Volající musí mít roli pracovního prostoru přispěvatele .

Požadované delegovaná rozsahy

Environment.ReadWrite.All nebo Item.ReadWrite.All

Omezení

Pokud chcete vytvořit prostředí, musí být pracovní prostor v podporované kapacitě Fabric.

Podporované identity Microsoft Entra

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

Identita	Podpora
Uživatel	Ano
instančního objektu a spravované identity	Ano

Rozhraní

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

Parametry identifikátoru URI

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

Text požadavku

Name	Vyžadováno	Typ	Description
displayName	True	string	Zobrazovaný název prostředí.
definition		EnvironmentDefinition	Veřejná definice prostředí.
description		string	Popis prostředí. Maximální délka je 256 znaků.
folderId		string (uuid)	ID složky. Pokud není zadána hodnota null, prostředí se vytvoří s pracovním prostorem jako jeho složkou.

Odpovědi

Name	Typ	Description
201 Created	Environment	Úspěšně vytvořeno
202 Accepted		Žádost byla přijata, probíhá zřizování prostředí Hlavičky Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Běžné kódy chyb: InvalidItemType – Typ položky je neplatný. ItemDisplayNameAlreadyInUse – Zobrazovaný název položky se už používá. Poškozená částPayload – zadanou datovou část je poškozena. WorkspaceItemsLimitExceededed – Došlo k překročení limitu položek pracovního prostoru.

Name

Typ

Description

201 Created

Environment

Úspěšně vytvořeno

202 Accepted

Žádost byla přijata, probíhá zřizování prostředí

Hlavičky

Location: string
x-ms-operation-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

Běžné kódy chyb:

InvalidItemType – Typ položky je neplatný.
ItemDisplayNameAlreadyInUse – Zobrazovaný název položky se už používá.
Poškozená částPayload – zadanou datovou část je poškozena.
WorkspaceItemsLimitExceededed – Došlo k překročení limitu položek pracovního prostoru.

Příklady

Create an environment example

Create an environment with public definition example

Create an environment example

Ukázkový požadavek

HTTP

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

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

Ukázková odpověď

Stavový kód:: 201

{
  "displayName": "Environment_1",
  "description": "An environment description.",
  "type": "Environment",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 201

{
  "displayName": "Environment_1",
  "description": "An environment description.",
  "type": "Environment",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

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

Definice

Name	Description
ComponentPublishInfo	Publikování informací pro jednotlivé komponenty v prostředí
CreateEnvironmentRequest	Vytvořte datovou část požadavku na prostředí.
Environment	Položka prostředí.
EnvironmentDefinition	Objekt veřejné definice prostředí. Další podrobnosti o vytvoření veřejné definice prostředí najdete v tomto článku .
EnvironmentDefinitionPart	Objekt části definice 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.
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.
PayloadType	Typ datové části definice. V průběhu času je možné přidat další typy datových částí.
PublishDetails	Podrobnosti o operaci publikování
SparkLibraries	Knihovny Sparku
SparkSettings	Nastavení Sparku

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.

CreateEnvironmentRequest

Objekt

Vytvořte datovou část požadavku na prostředí.

Name	Typ	Description
definition	EnvironmentDefinition	Veřejná definice prostředí.
description	string	Popis prostředí. Maximální délka je 256 znaků.
displayName	string	Zobrazovaný název prostředí.
folderId	string (uuid)	ID složky. Pokud není zadána hodnota null, prostředí se vytvoří s pracovním prostorem jako jeho složkou.

Environment

Objekt

Položka prostředí.

Name	Typ	Description
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í.
tags	ItemTag[]	Seznam použitých značek
type	ItemType	Typ položky.
workspaceId	string (uuid)	ID pracovního prostoru.

EnvironmentDefinition

Objekt

Objekt veřejné definice prostředí. Další podrobnosti o vytvoření veřejné definice prostředí najdete v tomto článku .

Name	Typ	Description
format	string	Formát definice prostředí.
parts	EnvironmentDefinitionPart[]	Seznam částí definice.

EnvironmentDefinitionPart

Objekt

Objekt části definice prostředí

Name	Typ	Description
path	string	Cesta části prostředí.
payload	string	Datová část prostředí.
payloadType	PayloadType	Typ datové části.

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

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.

PayloadType

Výčet

Typ datové části definice. V průběhu času je možné přidat další typy datových částí.

Hodnota	Description
InlineBase64	Vložená základna 64.

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.

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ů.

Sdílet prostřednictvím

Items - Create Environment

Dovolení

Požadované delegovaná rozsahy

Omezení

Podporované identity Microsoft Entra

Rozhraní

Parametry identifikátoru URI

Text požadavku

Odpovědi

Příklady

Create an environment example

Ukázkový požadavek

Ukázková odpověď

Create an environment with public definition example

Ukázkový požadavek

Ukázková odpověď

Definice

ComponentPublishInfo

CreateEnvironmentRequest

Environment

EnvironmentDefinition

EnvironmentDefinitionPart

EnvironmentProperties

EnvironmentPublishState

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

PayloadType

PublishDetails

SparkLibraries

SparkSettings