Edit

Share via

Published - List Libraries

Service:
Environment
API Version:
v1

Get environment published libraries.

Note

This API is a release version of a preview version due to be deprecated on March 1, 2026. When calling this API - callers must set the query parameter preview to the value false

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}
With optional parameters: 
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/libraries?continuationToken={continuationToken}&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 false to use the release version.
continuationToken
 query

string

Token to retrieve the next page of results, if available.

Responses

Name Type Description
200 OK

Libraries

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=false

Sample response

Status code:
200 
{
  "libraries": [
    {
      "name": "samplewheel-0.18.0-py2.py3-none-any.whl",
      "libraryType": "Custom"
    },
    {
      "name": "samplepython.py",
      "libraryType": "Custom"
    },
    {
      "name": "samplejar.jar",
      "libraryType": "Custom"
    },
    {
      "name": "sampleR.tar.gz",
      "libraryType": "Custom"
    },
    {
      "name": "fuzzywuzzy",
      "libraryType": "External",
      "version": "0.0.1"
    },
    {
      "name": "matplotlib",
      "libraryType": "External",
      "version": "0.0.1"
    }
  ],
  "continuationToken": "null",
  "continuationUri": "null"
}

Definitions

Name Description
CustomLibrary

Custom library.
ErrorRelatedResource

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.
ExternalLibrary

External library.
Libraries

Environment libraries.
LibraryType

A library type. Additional types may be added over time.

CustomLibrary

Object

Custom library.

Name Type Description
libraryType string:

Custom

A library type. Additional types may be added over time.
name

string

The name of library.

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.

ExternalLibrary

Object

External library.

Name Type Description
libraryType string:

External

A library type. Additional types may be added over time.
name

string

The name of library.
version

string

The version of external library.

Libraries

Object

Environment libraries.

Name Type Description
continuationToken

string

The token for the next result set batch. If there are no more records, it's removed from the response.
continuationUri

string

The URI of the next result set batch. If there are no more records, it's removed from the response.
libraries Library[]:

All custom and external libraries (.py, .whl, .jar, .tar.gz and external).

LibraryType

Enumeration

A library type. Additional types may be added over time.

Value Description
Custom

Custom libraries
External

External libraries