Staging - Upload Custom Library

Service:

Environment

API Version:

v1

Upload spark library into environment.
This API allows one file upload at a time. The supported file formats are .jar, .py, .whl, and .tar.gz.

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 application/octet-stream.

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/libraries/{libraryName}

URI Parameters

Name	In	Required	Type	Description
environmentId	path	True	string (uuid)	The environment ID.
libraryName	path	True	string	The library name to be uploaded. The library name needs to include its extension, for example samplefile.jar.
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.

Examples

Upload environment staging libraries example

Sample request

HTTP

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

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.