Items - Create Environment

Tjänst:: Environment

API-version:: v1

Skapar en miljö på den angivna arbetsytan.
Det här API:et stöder tidskrävande åtgärder (LRO).

Behörigheter

Anroparen måste ha rollen deltagare i arbetsytan.

Obligatoriska delegerade omfång

Environment.ReadWrite.All eller Item.ReadWrite.All

Begränsningar

Om du vill skapa en miljö måste arbetsytan ha en infrastrukturkapacitet som stöds.

Microsoft Entra identiteter som stöds

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

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

Gränssnitt

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
workspaceId	path	True	string (uuid)	Arbetsytans ID.

Begärandetext

Name	Obligatorisk	Typ	Description
displayName	True	string	Miljövisningsnamnet.
definition		EnvironmentDefinition	Den offentliga miljödefinitionen.
description		string	Miljöbeskrivningen. Maximal längd är 256 tecken.
folderId		string (uuid)	Mapp-ID:t. Om den inte anges eller är null skapas miljön med arbetsytan som mapp.
sensitivityLabelSettings		SensitivityLabelSettings	Inställningar för känslighetsetiketter för miljön.

Svar

Name	Typ	Description
201 Created	Environment	Har skapats
202 Accepted		Begäran accepterad, miljöetablering pågår Sidhuvuden Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Gränsen för tjänstfrekvens överskreds. Servern returnerar ett `Retry-After` huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas. Sidhuvuden Retry-After: integer
Other Status Codes	ErrorResponse	Vanliga felkoder: InvalidItemType – Objekttypen är ogiltig ItemDisplayNameAlreadyInUse – Objektets visningsnamn används redan CorruptedPayload – den angivna nyttolasten är skadad. WorkspaceItemsLimitExceeded – Gränsen för arbetsyteobjekt har överskridits.

Exempel

Create an environment example

Create an environment with public definition example

Create an environment example

Exempelbegäran

HTTP

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

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

Exempelsvar

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

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

Exempelbegäran

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

Exempelsvar

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

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

Definitioner

Name	Description
ComponentPublishInfo	Publicera information för varje komponenter i miljön.
CreateEnvironmentRequest	Skapa nyttolast för miljöbegäran.
Environment	Ett miljöobjekt.
EnvironmentDefinition	Miljöobjekt för offentlig definition. Mer information om miljödefinitionens struktur finns i den här artikeln .
EnvironmentDefinitionPart	Miljödefinitionsdelsobjekt.
EnvironmentProperties	Miljöegenskaper.
EnvironmentPublishState	Publiceringstillstånd. Ytterligare tillståndstyper kan läggas till över tid.
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Information om felsvar.
ItemTag	Representerar en tagg som tillämpas på ett objekt.
ItemType	Typ av objekt. Ytterligare objekttyper kan läggas till över tid.
PayloadType	Typ av definitionsdelens nyttolast. Ytterligare nyttolasttyper kan läggas till över tid.
PublishDetails	Information om publiceringsåtgärden.
SensitivityLabel	Representerar en känslighetsetikett som tillämpas på ett objekt.
SensitivityLabelApplyStrategy	Strategin för att tillämpa känslighetsetiketten. Standardvärdet är ApplyOrFail. Ytterligare typer kan läggas till över tid.
SensitivityLabelSettings	Inställningar för känslighetsetiketter.
SparkLibraries	Spark-bibliotek.
SparkSettings	Spark-inställningar.

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.

CreateEnvironmentRequest

Objekt

Skapa nyttolast för miljöbegäran.

Name	Typ	Description
definition	EnvironmentDefinition	Den offentliga miljödefinitionen.
description	string	Miljöbeskrivningen. Maximal längd är 256 tecken.
displayName	string	Miljövisningsnamnet.
folderId	string (uuid)	Mapp-ID:t. Om den inte anges eller är null skapas miljön med arbetsytan som mapp.
sensitivityLabelSettings	SensitivityLabelSettings	Inställningar för känslighetsetiketter för miljön.

Environment

Objekt

Ett miljöobjekt.

Name	Typ	Description
description	string	Objektbeskrivningen.
displayName	string	Objektets visningsnamn.
folderId	string (uuid)	Mapp-ID:t.
id	string (uuid)	Objekt-ID:t.
properties	EnvironmentProperties	Miljöegenskaperna.
sensitivityLabel	SensitivityLabel	Objektets känslighetsetikett.
tags	ItemTag[]	Lista över tillämpade taggar.
type	ItemType	Objekttypen.
workspaceId	string (uuid)	Arbetsytans ID.

EnvironmentDefinition

Objekt

Miljöobjekt för offentlig definition. Mer information om miljödefinitionens struktur finns i den här artikeln .

Name	Typ	Description
format	string	Formatet för miljödefinitionen.
parts	EnvironmentDefinitionPart[]	En lista över definitionsdelar.

EnvironmentDefinitionPart

Objekt

Miljödefinitionsdelsobjekt.

Name	Typ	Description
path	string	Miljödelssökvägen.
payload	string	Nyttolasten för miljödelen.
payloadType	PayloadType	Nyttolasttypen.

EnvironmentProperties

Objekt

Miljöegenskaper.

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
Success	Miljöpublicering har slutförts.
Cancelled	Publiceringen av miljön är i avbrutet tillstånd.
Failed	Miljöpublicering är i fel tillstånd.
Cancelling	Miljöpublicering är i avbrutet tillstånd.
Running	Miljöpublicer är i körningstillstånd.
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 (uuid)	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.

ItemTag

Objekt

Representerar en tagg som tillämpas på ett objekt.

Name	Typ	Description
displayName	string	Namnet på taggen.
id	string (uuid)	Tagg-ID:t.

ItemType

Uppräkning

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

Värde	Description
Dashboard	PowerBI-instrumentpanel.
Report	PowerBI-rapport.
SemanticModel	PowerBI-semantisk modell.
PaginatedReport	Sidnumrerad PowerBI-rapport.
Datamart	PowerBI-datamart.
Lakehouse	Ett sjöhus.
Eventhouse	Ett eventhouse.
Environment	En miljö.
KQLDatabase	En KQL-databas.
KQLQueryset	En KQL-frågeuppsättning.
KQLDashboard	En KQL-instrumentpanel.
DataPipeline	En datapipeline.
Notebook	En notebook-fil.
SparkJobDefinition	En definition för Spark-jobb.
MLExperiment	Ett maskininlärningsexperiment.
MLModel	En maskininlärningsmodell.
Warehouse	Ett lager.
Eventstream	En händelseström.
SQLEndpoint	En SQL-slutpunkt.
MirroredWarehouse	Ett speglat lager.
MirroredDatabase	En speglad databas.
Reflex	En reflex.
GraphQLApi	Ett API för GraphQL-objekt.
MountedDataFactory	En MountedDataFactory.
SQLDatabase	En SQLDatabase.
CopyJob	Ett kopieringsjobb.
VariableLibrary	En VariableLibrary.
Dataflow	Ett dataflöde.
ApacheAirflowJob	Ett ApacheAirflowJob.
WarehouseSnapshot	En ögonblicksbild av lagret.
DigitalTwinBuilder	En DigitalTwinBuilder.
DigitalTwinBuilderFlow	Ett Digital Twin Builder Flow.
MirroredAzureDatabricksCatalog	En speglad azure databricks-katalog.
Map	En karta.
AnomalyDetector	En avvikelseidentifiering.
UserDataFunction	En användardatafunktion.
GraphModel	En GraphModel.
GraphQuerySet	En Graph QuerySet.
SnowflakeDatabase	En Snowflake-databas för att lagra isbergstabeller som skapats från Snowflake-kontot.
OperationsAgent	En OperationsAgent.
CosmosDBDatabase	En Cosmos DB-databas.
Ontology	En ontologi.
EventSchemaSet	En EventSchemaSet.
DataAgent	En DataAgent.

PayloadType

Uppräkning

Typ av definitionsdelens nyttolast. Ytterligare nyttolasttyper kan läggas till över tid.

Värde	Description
InlineBase64	Infogad bas 64.

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 i UTC med formatet YYYY-MM-DDTHH:mm:ss.sssSZ.
startTime	string (date-time)	Starttid för publiceringsåtgärden i UTC med formatet YYYY-MM-DDTHH:mm:ss.ssssSZ.
state	EnvironmentPublishState	Publiceringstillstånd. Ytterligare tillståndstyper kan läggas till över tid.
targetVersion	string (uuid)	Målverion som ska publiceras.

SensitivityLabel

Objekt

Representerar en känslighetsetikett som tillämpas på ett objekt.

Name	Typ	Description
id	string (uuid)	Känslighetsetikettens ID.

SensitivityLabelApplyStrategy

Uppräkning

Strategin för att tillämpa känslighetsetiketten. Standardvärdet är ApplyOrFail. Ytterligare typer kan läggas till över tid.

Värde	Description
ApplyOrFail	Använd känslighetsetiketten eller misslyckas med åtgärden om den inte kan tillämpas.
Ignore	Ignorera känslighetsetiketten om den inte kan användas och fortsätt med åtgärden utan att använda etiketten.

SensitivityLabelSettings

Objekt

Inställningar för känslighetsetiketter.

Name	Typ	Description
labelId	string (uuid)	Känslighetsetikettens ID.
sensitivityLabelApplyStrategy	SensitivityLabelApplyStrategy	Strategin för att tillämpa känslighetsetiketten.

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.

Dela via

Items - Create Environment

Behörigheter

Obligatoriska delegerade omfång

Begränsningar

Microsoft Entra identiteter som stöds

Gränssnitt

URI-parametrar

Begärandetext

Svar

Exempel

Create an environment example

Exempelbegäran

Exempelsvar

Create an environment with public definition example

Exempelbegäran

Exempelsvar

Definitioner

ComponentPublishInfo

CreateEnvironmentRequest

Environment

EnvironmentDefinition

EnvironmentDefinitionPart

EnvironmentProperties

EnvironmentPublishState

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

PayloadType

PublishDetails

SensitivityLabel

SensitivityLabelApplyStrategy

SensitivityLabelSettings

SparkLibraries

SparkSettings