Dela via


Items - Create Environment

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

Det här API:et stöder inte att skapa en miljö med definition.

Behörigheter

Anroparen måste ha deltagare eller högre arbetsyteroll.

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.

Identiteter som stöds av Microsoft Entra

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

Identitet Stöd
Användare Ja
Tjänstens huvudnamn 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.

description

string

Miljöbeskrivningen. Maximal längd är 256 tecken.

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
Other Status Codes

ErrorResponse

Vanliga felkoder:

  • InvalidItemType – Objekttypen är ogiltig

  • ItemDisplayNameAlreadyInUse – Objektets visningsnamn används redan

  • CorruptedPayload – den angivna nyttolasten är skadad

Exempel

Create a environment example

Exempelbegäran

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

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

Exempelsvar

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

EnvironmentPublishInfo

Information om miljöpublicering.

EnvironmentPublishState

Publiceringstillstånd. Ytterligare tillståndstyper kan läggas till över tid.

ErrorRelatedResource

Det felrelaterade resursinformationsobjektet.

ErrorResponse

Felsvaret.

ErrorResponseDetails

Information om felsvar.

ItemType

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

PublishDetails

Information om publiceringsåtgärden.

SparkLibraries

Spark-bibliotek.

SparkSettings

Spark-inställningar.

ComponentPublishInfo

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

Skapa nyttolast för miljöbegäran.

Name Typ Description
description

string

Miljöbeskrivningen. Maximal längd är 256 tecken.

displayName

string

Miljövisningsnamnet.

Environment

Ett miljöobjekt.

Name Typ Description
description

string

Objektbeskrivningen.

displayName

string

Objektets visningsnamn.

id

string

uuid

Objekt-ID:t.

properties

EnvironmentPublishInfo

Miljöegenskaperna.

type

ItemType

Objekttypen.

workspaceId

string

uuid

Arbetsytans ID.

EnvironmentPublishInfo

Information om miljöpublicering.

Name Typ Description
publishDetails

PublishDetails

Information om miljöpubliceringsåtgärder.

EnvironmentPublishState

Publiceringstillstånd. Ytterligare tillståndstyper kan läggas till över tid.

Värde Description
Cancelled

Publiceringen av miljön är i avbrutet tillstånd.

Cancelling

Miljöpublicering är i avbrutet tillstånd.

Failed

Miljöpublicering är i fel tillstånd.

Running

Miljöpublicer är i körningstillstånd.

Success

Miljöpublicering har slutförts.

Waiting

Publiceringen av miljön är i vänteläge.

ErrorRelatedResource

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

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

ID för den begäran som är associerad med felet.

ErrorResponseDetails

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.

ItemType

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

Värde Description
Dashboard

PowerBI-instrumentpanel.

DataPipeline

En datapipeline.

Datamart

PowerBI-datamart.

Environment

En miljö.

Eventhouse

Ett eventhouse.

Eventstream

En händelseström.

GraphQLApi

Ett API för GraphQL-objekt.

KQLDashboard

En KQL-instrumentpanel.

KQLDatabase

En KQL-databas.

KQLQueryset

En KQL-frågeuppsättning.

Lakehouse

Ett sjöhus.

MLExperiment

Ett maskininlärningsexperiment.

MLModel

En maskininlärningsmodell.

MirroredDatabase

En speglad databas.

MirroredWarehouse

Ett speglat lager.

MountedDataFactory

En MountedDataFactory.

Notebook

En notebook-fil.

PaginatedReport

Sidnumrerad PowerBI-rapport.

Reflex

En reflex.

Report

PowerBI-rapport.

SQLDatabase

En SQLDatabase.

SQLEndpoint

En SQL-slutpunkt.

SemanticModel

PowerBI-semantisk modell.

SparkJobDefinition

En definition för Spark-jobb.

Warehouse

Ett lager.

PublishDetails

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.

startTime

string

date-time

Starttid för publiceringsåtgärden.

state

EnvironmentPublishState

Publiceringstillstånd. Ytterligare tillståndstyper kan läggas till över tid.

targetVersion

string

uuid

Målverion som ska publiceras.

SparkLibraries

Spark-bibliotek.

Name Typ Description
state

EnvironmentPublishState

Publiceringstillstånd. Ytterligare tillståndstyper kan läggas till över tid.

SparkSettings

Spark-inställningar.

Name Typ Description
state

EnvironmentPublishState

Publiceringstillstånd. Ytterligare tillståndstyper kan läggas till över tid.