Items - Publish Environment (preview)
Trigger an environment publish operation.
Note
This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use. This preview API will be deprecated on March 1, 2026, and replaced by a stable version, available here. The new version introduces breaking changes and is not backward compatible.
When calling this API, callers must specify true as the value for the query parameter preview.
Deprecation Notice
A new query parameter preview has been introduced to facilitate this transition:
- The
previewquery parameter currently defaults totrue. - Set the value of the
previewquery parameter tofalseto use the stable Release version of this API. - Starting March 1, 2026, the default value for
previewwill change tofalse.
It is recommended to migrate your integration to use the Release version as soon as possible by specifying false for the preview query parameter (the default value for the preview query parameter will be set to false on API's deprecation date).
The following incompatible changes were introduced in the Release version:
- Response is following long running operations (LRO) pattern and HTTP response code 202 may be returned.
Permissions
Write permission for the environment item.
Required Delegated Scopes
Item.ReadWrite.All or Environment.ReadWrite.All
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/{environmentId}/staging/publish?preview={preview}URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
environment
|
path | True |
string (uuid) |
The environment ID. |
|
workspace
|
path | True |
string (uuid) |
The workspace ID. |
|
preview
|
query | True |
boolean |
This parameter specifies which version of the API to use. Set to |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
Publish operation request has been submitted successfully. |
|
| Other Status Codes |
Common error codes:
|
Examples
Publish environment example
Sample request
POST https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/environments/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/staging/publish?preview=True
Sample response
{
"publishDetails": {
"state": "Running",
"targetVersion": "46838a80-5450-4414-bea0-40fb6f3e0c0d",
"startTime": "2024-03-29T14:17:09.0697022Z",
"componentPublishInfo": {
"sparkLibraries": {
"state": "Running"
},
"sparkSettings": {
"state": "Running"
}
}
}
}Definitions
| Name | Description |
|---|---|
|
Component |
Publish info for each components in environment. |
|
Environment |
Environment properties. |
|
Environment |
Publish state. Additional state types may be added over time. |
|
Error |
The error related resource details object. |
|
Error |
The error response. |
|
Error |
The error response details. |
|
Publish |
Details of publish operation. |
|
Spark |
Spark libraries. |
|
Spark |
Spark settings. |
ComponentPublishInfo
Publish info for each components in environment.
| Name | Type | Description |
|---|---|---|
| sparkLibraries |
Spark libraries publish information. |
|
| sparkSettings |
Spark settings publish information. |
EnvironmentProperties
Environment properties.
| Name | Type | Description |
|---|---|---|
| publishDetails |
Environment publish operation details. |
EnvironmentPublishState
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
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 |
List of additional error details. |
|
| relatedResource |
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 |
The error related resource details. |
PublishDetails
Details of publish operation.
| Name | Type | Description |
|---|---|---|
| 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 |
Publish state. Additional state types may be added over time. |
|
| targetVersion |
string (uuid) |
Target verion to be published. |
SparkLibraries
Spark libraries.
| Name | Type | Description |
|---|---|---|
| state |
Publish state. Additional state types may be added over time. |
SparkSettings
Spark settings.
| Name | Type | Description |
|---|---|---|
| state |
Publish state. Additional state types may be added over time. |