Azure Synapse Analytics Libraries API

The Libraries API from Azure Synapse Analytics — 2 operation(s) for libraries.

GitHub OpenAPI

Operations 2

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/libraries/{libraryName} Get library by name #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/libraries List the libraries in a workspace #

Documentation

📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/sqlpools
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/pipeline
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/monitoring
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/role-assignments
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/notebook
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/dataset
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/linked-service
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/data-flow
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/sql-script
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/trigger
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/spark-job-definition
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/managed-private-endpoints
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/integration-runtimes
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/library
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/ip-firewall-rules
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/keys
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/private-endpoint-connections
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/private-link-hubs
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/azure-ad-only-authentications
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/spark-configuration
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/data-flow-debug-session
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/credential
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/kql-script
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/link-connection

Specifications

Schemas & Data

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/microsoft-azure-synapse-analytics:microsoft-azure-synapse-analytics-libraries-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

microsoft-azure-synapse-analytics-libraries-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: '2021-06-01'
  title: SynapseManagementClient Libraries API
  description: Azure Synapse Analytics APIs
servers:
- url: https://management.azure.com
tags:
- name: Libraries
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/libraries/{libraryName}
  : get:
      operationId: Library_Get
      summary: Get library by name
      description: Get library by name in a workspace.
      tags:
      - Libraries
      deprecated: false
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/LibraryNameParameter'
      - $ref: '#/components/parameters/WorkspaceNameParameter'
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LibraryResource'
        default:
          description: An error response received from the Azure Synapse service.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/libraries
  : get:
      operationId: Libraries_ListByWorkspace
      summary: List the libraries in a workspace
      description: List libraries in a workspace.
      tags:
      - Libraries
      deprecated: false
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/WorkspaceNameParameter'
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LibraryListResponse'
        default:
          description: An error response received from the Azure Synapse service.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
components:
  schemas:
    ErrorResponse:
      title: Error response
      description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
      type: object
      properties:
        error:
          description: The error object.
          $ref: '#/components/schemas/ErrorDetail'
    LibraryResource:
      description: Library response details
      allOf:
      - $ref: '#/components/schemas/SubResource'
      properties:
        properties:
          $ref: '#/components/schemas/LibraryInfo'
          description: Library/package properties.
          x-ms-client-flatten: true
      required:
      - properties
    SubResource:
      description: Azure Synapse nested resource, which belongs to a workspace.
      allOf:
      - $ref: '#/components/schemas/AzureEntityResource'
    LibraryListResponse:
      description: A list of Library resources.
      type: object
      required:
      - value
      properties:
        value:
          type: array
          description: List of Library.
          items:
            $ref: '#/components/schemas/LibraryResource'
        nextLink:
          description: The link to the next page of results, if any remaining results exist.
          type: string
    AzureEntityResource:
      x-ms-client-name: AzureEntityResource
      title: Entity Resource
      description: The resource model definition for an Azure Resource Manager resource with an etag.
      type: object
      properties:
        etag:
          type: string
          readOnly: true
          description: Resource Etag.
      allOf:
      - $ref: '#/components/schemas/Resource'
    LibraryInfo:
      type: object
      description: Library/package information of a Big Data pool powered by Apache Spark
      title: Information about a library/package created at the workspace level.
      properties:
        name:
          type: string
          description: Name of the library.
        path:
          type: string
          description: Storage blob path of library.
        containerName:
          type: string
          description: Storage blob container name.
        uploadedTimestamp:
          type: string
          format: date-time
          description: The last update time of the library.
          readOnly: true
        type:
          type: string
          description: Type of the library.
        provisioningStatus:
          readOnly: true
          type: string
          description: Provisioning status of the library/package.
        creatorId:
          readOnly: true
          type: string
          description: Creator Id of the library/package.
  parameters:
    WorkspaceNameParameter:
      name: workspaceName
      in: path
      description: The name of the workspace.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      required: true
      description: The ID of the target subscription.
      schema:
        type: string
        minLength: 1
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      description: The API version to use for this operation.
      schema:
        type: string
        minLength: 1
    LibraryNameParameter:
      name: libraryName
      in: path
      required: true
      description: Library name
      x-ms-parameter-location: method
      schema:
        type: string
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      required: true
      description: The name of the resource group. The name is case insensitive.
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 90
        minLength: 1
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow