Edit

Share via

Items - Update Environment

  • Reference
Service:
Environment
API Version:
v1

Updates the properties of the specified environment.

Permissions

The caller must have contributor or higher workspace role.

Required Delegated Scopes

Environment.ReadWrite.All or Item.ReadWrite.All

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity Support
User Yes
Service principal Yes
Managed identities Yes

Interface

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

URI Parameters

Name In Required Type Description
environmentId
 path True

string

uuid

The environment ID.
workspaceId
 path True

string

uuid

The workspace ID.

Request Body

Name Type Description
description

string

The environment description. Maximum length is 256 characters.
displayName

string

The environment display name.

Responses

Name Type Description
200 OK

Environment

Request completed successfully.
Other Status Codes

ErrorResponse

Common error codes:

  • ItemNotFound - The requested item was not found.

  • InvalidRequest - Invalid update request

Examples

Update a environment example

Sample request

PATCH https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/environments/5b218778-e7a5-4d73-8187-f10824047715

{
  "displayName": "Environment_New_Name",
  "description": "A new description for environment."
}

Sample response

Status code:
200 
{
  "displayName": "Environment_New_Name",
  "description": "A new description for environment.",
  "type": "Environment",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Definitions

Name Description
ComponentPublishInfo

Publish info for each components in environment.
Environment

An Environment item.
EnvironmentPublishInfo

Environment publish information.
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.
ItemType

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

Details of publish operation.
SparkLibraries

Spark libraries.
SparkSettings

Spark settings.
UpdateEnvironmentRequest

Update environment request.

ComponentPublishInfo

Publish info for each components in environment.

Name Type Description
sparkLibraries

SparkLibraries

Spark libraries publish information.
sparkSettings

SparkSettings

Spark settings publish information.

Environment

An Environment item.

Name Type Description
description

string

The item description.
displayName

string

The item display name.
id

string

The item ID.
properties

EnvironmentPublishInfo

The environment properties.
type

ItemType

The item type.
workspaceId

string

The workspace ID.

EnvironmentPublishInfo

Environment publish information.

Name Type Description
publishDetails

PublishDetails

Environment publish operation details.

EnvironmentPublishState

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

Name Type Description
Cancelled

string

Environment publish is in cancelled state.
Cancelling

string

Environment publish is in cancelling state.
Failed

string

Environment publish is in failed state.
Running

string

Environment publish is in running state.
Success

string

Environment publish is in success state.
Waiting

string

Environment publish is in waiting state.

ErrorRelatedResource

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

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

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.

ItemType

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

Name Type Description
Dashboard

string

PowerBI dashboard.
DataPipeline

string

A data pipeline.
Datamart

string

PowerBI datamart.
Environment

string

An environment.
Eventhouse

string

An eventhouse.
Eventstream

string

An eventstream.
KQLDashboard

string

A KQL dashboard.
KQLDatabase

string

A KQL database.
KQLQueryset

string

A KQL queryset.
Lakehouse

string

A lakehouse.
MLExperiment

string

A machine learning experiment.
MLModel

string

A machine learning model.
MirroredDatabase

string

A mirrored database.
MirroredWarehouse

string

A mirrored warehouse.
Notebook

string

A notebook.
PaginatedReport

string

PowerBI paginated report.
Report

string

PowerBI report.
SQLEndpoint

string

An SQL endpoint.
SemanticModel

string

PowerBI semantic model.
SparkJobDefinition

string

A spark job definition.
Warehouse

string

A warehouse.

PublishDetails

Details of publish operation.

Name Type Description
componentPublishInfo

ComponentPublishInfo

Environment component publish information.
endTime

string

End time of publish operation.
startTime

string

Start time of publish operation.
state

EnvironmentPublishState

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

string

Target verion to be published.

SparkLibraries

Spark libraries.

Name Type Description
state

EnvironmentPublishState

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

SparkSettings

Spark settings.

Name Type Description
state

EnvironmentPublishState

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

UpdateEnvironmentRequest

Update environment request.

Name Type Description
description

string

The environment description. Maximum length is 256 characters.
displayName

string

The environment display name.