Edit

Share via

Staging - Upload Custom Library (preview)

Service:
Environment
API Version:
v1

Upload spark library into environment.

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.**

Deprecation Notice

It is recommended to migrate your integration to use the Release version.

The following incompatible changes were introduced in the Release version:

  • The request URL structure has changed: the library name to be added is now specified directly in the URL path.
  • The request now supports application/octet-stream as Content-Type instead of multipart/form-data.

This API allows one file upload at a time. The supported file formats are .jar, .py, .whl, .tar.gz, or environment.yml.

Limitations

The maximum request size allowed is 100MB.

Network issues may impact the upload size and may result in timeouts.

Content-Type

The library file needs to be upload using Content-Type as multipart/form-data.

Permissions

Write permission for the environment item.

Required Delegated Scopes

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

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

Request completed successfully.
Other Status Codes

ErrorResponse

Common error codes:

  • EnvironmentValidationFailed - Provide a library with a valid format such as .jar, .py, .whl, .tar.gz, or environment.yml.

Examples

Upload environment staging libraries example

Sample request

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

Sample response

Status code:
200

Definitions

Name Description
ErrorRelatedResource

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.

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.