Edit

Share via

Items - Create Environment

Service:
Environment
API Version:
v1

Creates an environment in the specified workspace.
This API supports long running operations (LRO).

Permissions

The caller must have a contributor workspace role.

Required Delegated Scopes

Environment.ReadWrite.All or Item.ReadWrite.All

Limitations

  • To create an environment, the workspace must be on a supported Fabric capacity.

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity Support
User Yes
Service principal and Managed identities Yes

Interface

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

URI Parameters

Name In Required Type Description
workspaceId
 path True

string (uuid)

The workspace ID.

Request Body

Name Required Type Description
displayName True

string

The environment display name.
definition

EnvironmentDefinition

The environment public definition.
description

string

The environment description. Maximum length is 256 characters.
folderId

string (uuid)

The folder ID. If not specified or null, the environment is created with the workspace as its folder.

Responses

Name Type Description
201 Created

Environment

Successfully created
202 Accepted

Request accepted, environment provisioning in progress

Headers

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Common error codes:

  • InvalidItemType - Item type is invalid

  • ItemDisplayNameAlreadyInUse - Item display name is already used

  • CorruptedPayload - The provided payload is corrupted.

  • WorkspaceItemsLimitExceeded - Workspace item limit exceeded.

Examples

Create an environment example
Create an environment with public definition example

Create an environment example

Sample request

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

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

Sample response

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

Sample request

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

Sample response

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

Definitions

Name Description
ComponentPublishInfo

Publish info for each components in environment.
CreateEnvironmentRequest

Create environment request payload.
Environment

An Environment item.
EnvironmentDefinition

Environment public definition object. Refer to this article for more details on how to craft a environment public definition.
EnvironmentDefinitionPart

Environment definition part object.
EnvironmentProperties

Environment properties.
EnvironmentPublishState

Publish state. Additional state types may be added over time.
ErrorRelatedResource

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.
ItemTag

Represents a tag applied on an item.
ItemType

The type of the item. Additional item types may be added over time.
PayloadType

The type of the definition part payload. Additional payload types may be added over time.
PublishDetails

Details of publish operation.
SparkLibraries

Spark libraries.
SparkSettings

Spark settings.

ComponentPublishInfo

Object

Publish info for each components in environment.

Name Type Description
sparkLibraries

SparkLibraries

Spark libraries publish information.
sparkSettings

SparkSettings

Spark settings publish information.

CreateEnvironmentRequest

Object

Create environment request payload.

Name Type Description
definition

EnvironmentDefinition

The environment public definition.
description

string

The environment description. Maximum length is 256 characters.
displayName

string

The environment display name.
folderId

string (uuid)

The folder ID. If not specified or null, the environment is created with the workspace as its folder.

Environment

Object

An Environment item.

Name Type Description
description

string

The item description.
displayName

string

The item display name.
folderId

string (uuid)

The folder ID.
id

string (uuid)

The item ID.
properties

EnvironmentProperties

The environment properties.
tags

ItemTag[]

List of applied tags.
type

ItemType

The item type.
workspaceId

string (uuid)

The workspace ID.

EnvironmentDefinition

Object

Environment public definition object. Refer to this article for more details on how to craft a environment public definition.

Name Type Description
format

string

The format of the Environment definition.
parts

EnvironmentDefinitionPart[]

A list of definition parts.

EnvironmentDefinitionPart

Object

Environment definition part object.

Name Type Description
path

string

The environment part path.
payload

string

The environment part payload.
payloadType

PayloadType

The payload type.

EnvironmentProperties

Object

Environment properties.

Name Type Description
publishDetails

PublishDetails

Environment publish operation details.

EnvironmentPublishState

Enumeration

Publish state. Additional state types may be added over time.

Value Description
Success

Environment publish is in success state.
Cancelled

Environment publish is in cancelled state.
Failed

Environment publish is in failed state.
Cancelling

Environment publish is in cancelling state.
Running

Environment publish is in running state.
Waiting

Environment publish is in waiting state.

ErrorRelatedResource

Object

The error related resource details object.

Name Type Description
resourceId

string

The resource ID that's involved in the error.
resourceType

string

The type of the resource that's involved in the error.

ErrorResponse

Object

The error response.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message

string

A human readable representation of the error.
moreDetails

ErrorResponseDetails[]

List of additional error details.
relatedResource

ErrorRelatedResource

The error related resource details.
requestId

string

ID of the request associated with the error.

ErrorResponseDetails

Object

The error response details.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message

string

A human readable representation of the error.
relatedResource

ErrorRelatedResource

The error related resource details.

ItemTag

Object

Represents a tag applied on an item.

Name Type Description
displayName

string

The name of the tag.
id

string (uuid)

The tag ID.

ItemType

Enumeration

The type of the item. Additional item types may be added over time.

Value Description
Dashboard

PowerBI dashboard.
Report

PowerBI report.
SemanticModel

PowerBI semantic model.
PaginatedReport

PowerBI paginated report.
Datamart

PowerBI datamart.
Lakehouse

A lakehouse.
Eventhouse

An eventhouse.
Environment

An environment.
KQLDatabase

A KQL database.
KQLQueryset

A KQL queryset.
KQLDashboard

A KQL dashboard.
DataPipeline

A data pipeline.
Notebook

A notebook.
SparkJobDefinition

A spark job definition.
MLExperiment

A machine learning experiment.
MLModel

A machine learning model.
Warehouse

A warehouse.
Eventstream

An eventstream.
SQLEndpoint

An SQL endpoint.
MirroredWarehouse

A mirrored warehouse.
MirroredDatabase

A mirrored database.
Reflex

A Reflex.
GraphQLApi

An API for GraphQL item.
MountedDataFactory

A MountedDataFactory.
SQLDatabase

A SQLDatabase.
CopyJob

A Copy job.
VariableLibrary

A VariableLibrary.
Dataflow

A Dataflow.
ApacheAirflowJob

An ApacheAirflowJob.
WarehouseSnapshot

A Warehouse snapshot.
DigitalTwinBuilder

A DigitalTwinBuilder.
DigitalTwinBuilderFlow

A Digital Twin Builder Flow.
MirroredAzureDatabricksCatalog

A mirrored azure databricks catalog.
Map

A Map.
AnomalyDetector

An Anomaly Detector.
UserDataFunction

A User Data Function.

PayloadType

Enumeration

The type of the definition part payload. Additional payload types may be added over time.

Value Description
InlineBase64

Inline Base 64.

PublishDetails

Object

Details of publish operation.

Name Type Description
componentPublishInfo

ComponentPublishInfo

Environment component publish information.
endTime

string (date-time)

End time of publish operation in UTC, using the YYYY-MM-DDTHH:mm:ss.sssssssZ format.
startTime

string (date-time)

Start time of publish operation in UTC, using the YYYY-MM-DDTHH:mm:ss.sssssssZ format.
state

EnvironmentPublishState

Publish state. Additional state types may be added over time.
targetVersion

string (uuid)

Target verion to be published.

SparkLibraries

Object

Spark libraries.

Name Type Description
state

EnvironmentPublishState

Publish state. Additional state types may be added over time.

SparkSettings

Object

Spark settings.

Name Type Description
state

EnvironmentPublishState

Publish state. Additional state types may be added over time.