Spark Libraries - Get Published Libraries

Service:

Environment

API Version:

v1

Note

This API is in preview.

Get environment published libraries.

Permissions

Read permission for the environment item.

Required Delegated Scopes

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

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	EnvironmentLibraries	Request completed successfully.
Other Status Codes	ErrorResponse	Common error codes: EnvironmentLibrariesNotFound - This environment does not have any staged libraries.

Examples

Get environment published libraries example

Sample request

HTTP

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

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": "dependencies:\r\n- pip:\r\n  - matplotlib==3.4.3"
}

Definitions

Name	Description
CustomLibraries	Custom libraries.
EnvironmentLibraries	Environment libraries.
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.

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.

EnvironmentLibraries

Object

Environment libraries.

Name	Type	Description
customLibraries	CustomLibraries	Custom libraries (.py, .whl, .jar, .tar.gz).
environmentYml	string	Feed libraries.

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.