Edit

Share via

Published - List Libraries (preview)

Service:
Environment
API Version:
v1

Get environment published libraries.

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 preview query parameter currently defaults to true.
  • Set the value of the preview query parameter to false to use the stable Release version of this API.
  • Starting March 1, 2026, the default value for preview will change to false.

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:

  • Different response format and schema structure
  • Enhanced library properties in the response
  • Updated field names and data types
  • Improved error handling and messages

This API supports pagination.

Permissions

Read permission for the environment item.

Required Delegated Scopes

Item.Read.All or Item.ReadWrite.All or Environment.Read.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

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/libraries?preview={preview}

URI Parameters

Name In Required Type Description
environmentId
 path True

string (uuid)

The environment ID.
workspaceId
 path True

string (uuid)

The workspace ID.
preview
 query True

boolean

This parameter specifies which version of the API to use. Set to true to use the preview version described on this page, or to false to use the Release version detailed here. Starting March 1, 2026, the default value for preview will change to false.

Responses

Name Type Description
200 OK

LibrariesPreview

Request completed successfully.
Other Status Codes

ErrorResponse

Common error codes:

  • EnvironmentLibrariesNotFound - This environment does not have any published libraries.

Examples

Get environment published libraries example

Sample request

GET https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/environments/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/libraries?preview=True

Sample response

Status code:
200 
{
  "customLibraries": {
    "wheelFiles": [
      "samplewheel-0.18.0-py2.py3-none-any.whl"
    ],
    "pyFiles": [
      "samplepython.py"
    ],
    "jarFiles": [
      "samplejar.jar"
    ],
    "rTarFiles": [
      "sampleR.tar.gz"
    ]
  },
  "environmentYml": "name: sample-environment\ndependencies:\n  - fuzzywuzzy==0.0.1\n  - matplotlib==0.0.1"
}

Definitions

Name Description
CustomLibraries

Custom libraries.
ErrorRelatedResource

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.
LibrariesPreview

Environment libraries.

CustomLibraries

Object

Custom libraries.

Name Type Description
jarFiles

string[]

A list of Jar files.
pyFiles

string[]

A list of Python files.
rTarFiles

string[]

A list of R files.
wheelFiles

string[]

A list of Wheel files.

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.

LibrariesPreview

Object

Environment libraries.

Name Type Description
customLibraries

CustomLibraries

Custom libraries (.py, .whl, .jar, .tar.gz).
environmentYml

string

Feed libraries.