Edit

Share via

Items - Cancel Publish Environment

Service:
Environment
API Version:
v1

Trigger an environment publish cancellation.

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/cancelPublish

URI Parameters

Name In Required Type Description
environmentId
 path True

string (uuid)

The environment ID.
workspaceId
 path True

string (uuid)

The workspace ID.

Responses

Name Type Description
200 OK

EnvironmentProperties

Request completed successfully.
Other Status Codes

ErrorResponse

Common error codes:

  • InvalidEnvironmentCancel - Environment cancel operation for version <GUID of the failed publish cancellation> failed due to error: Code = EnvironmentUpsupportedStateForCancel.

Examples

Publish environment cancellation example

Sample request

POST https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/environments/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/staging/cancelPublish

Sample response

Status code:
200 
{
  "publishDetails": {
    "state": "Cancelled",
    "targetVersion": "d9d95b01-248f-4ef4-bd7e-9d3f1f6447be",
    "startTime": "2024-03-29T14:17:09.0697022Z",
    "endTime": "2024-03-29T14:48:18.0697022Z",
    "componentPublishInfo": {
      "sparkLibraries": {
        "state": "Cancelled"
      },
      "sparkSettings": {
        "state": "Cancelled"
      }
    }
  }
}

Definitions

Name Description
ComponentPublishInfo

Publish info for each components in environment.
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.
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.

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.

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.