Edit

Share via


Staging - Remove External Library

Delete a spark external library from an environment.

This API allows one library deletion at a time.

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

URI Parameters

Name In Required Type Description
environmentId
path True

string (uuid)

The environment ID.

workspaceId
path True

string (uuid)

The workspace ID.

Request Body

Name Required Type Description
name True

string

The name of library.

version True

string

The version of external library.

Responses

Name Type Description
200 OK

Request completed successfully.

Other Status Codes

ErrorResponse

Common error codes:

  • EnvironmentValidationFailed - Provide a valid request

Examples

Delete an external library from environment example

Sample request

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

{
  "name": "fuzzywuzzy",
  "version": "0.0.1"
}

Sample response

Definitions

Name Description
ErrorRelatedResource

The error related resource details object.

ErrorResponse

The error response.

ErrorResponseDetails

The error response details.

RemoveExternalLibrariesRequest

Request to delete an external library.

ErrorRelatedResource

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

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

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.

RemoveExternalLibrariesRequest

Request to delete an external library.

Name Type Description
name

string

The name of library.

version

string

The version of external library.