Library - List

Service:

Synapse

API Version:

2020-12-01

Lists Library.

GET {endpoint}/libraries?api-version=2020-12-01

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string (uri)	The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.
api-version	query	True	string	The Synapse client API Version.

Responses

Name	Type	Description
200 OK	LibraryListResponse	OK.
Other Status Codes	CloudError	An error response received from the Azure Synapse service.

Examples

List Libraries

Sample request

HTTP

GET exampleWorkspace.dev.azuresynapse.net/libraries?api-version=2020-12-01

Sample response

Status code:

200

Date: Sat, 16 Jun 2018 00:37:36 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 14994
x-ms-request-id: 558d0fd8-dc1f-44b6-9ca9-59fcca8af9a5
x-ms-correlation-request-id: 558d0fd8-dc1f-44b6-9ca9-59fcca8af9a5

{
  "value": [
    {
      "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/libraries/exampleLibraryName.jar",
      "name": "exampleLibraryName.jar",
      "type": "Microsoft.Synapse/workspaces/libraries",
      "properties": {
        "name": "exampleLibraryName.jar",
        "path": "exampleWorkspace/libraries/exampleLibraryName.jar",
        "containerName": "exampleContainer",
        "type": "jar",
        "uploadedTimestamp": "2020-10-23T07:59:29.1573546+00:00",
        "provisioningStatus": "Succeeded",
        "creatorId": "2222222e-222d-222f-2222-22a2f222d2f2"
      },
      "etag": "1500474f-0000-0200-0000-5cbe090d0000"
    }
  ]
}

Definitions

Name	Description
CloudError	The object that defines the structure of an Azure Synapse error response.
LibraryListResponse	A list of Library resources.
LibraryResource	Library response details
LibraryResourceProperties	Library/package properties

CloudError

Object

The object that defines the structure of an Azure Synapse error response.

Name	Type	Description
error.code	string	Error code.
error.details	CloudError[]	Array with additional error details.
error.message	string	Error message.
error.target	string	Property name/path in request associated with error.

LibraryListResponse

Object

A list of Library resources.

Name	Type	Description
nextLink	string	The link to the next page of results, if any remaining results exist.
value	LibraryResource[]	List of Library.

LibraryResource

Object

Library response details

Name	Type	Description
etag	string	Resource Etag.
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	LibraryResourceProperties	Library/package properties.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

LibraryResourceProperties

Object

Library/package properties

Name	Type	Description
containerName	string	Container name of the library/package.
creatorId	string	Creator Id of the library/package.
name	string	Name of the library/package.
path	string	Location of library/package in storage account.
provisioningStatus	string	Provisioning status of the library/package.
type	string	Type of the library/package.
uploadedTimestamp	string	The last update time of the library/package.