Azure Synapse Analytics Library API

openapi: 3.1.0
info:
  title: Azure Synapse Analytics - Access Control AzureADOnlyAuthentications Library API
  description: Manage role assignments, role definitions, and access control for Synapse workspace resources. Supports Synapse role-based access control for fine-grained permissions.
  version: '2020-12-01'
  contact:
    name: Microsoft Azure Support
    url: https://azure.microsoft.com/en-us/support/
  license:
    name: Microsoft
    url: https://azure.microsoft.com/en-us/support/legal/
servers:
- url: https://{workspaceName}.dev.azuresynapse.net
  description: Synapse Data Plane
  variables:
    workspaceName:
      description: The workspace name.
      default: myworkspace
security:
- azure_auth:
  - user_impersonation
tags:
- name: Library
paths:
  /libraries:
    get:
      operationId: Library_List
      summary: Azure Synapse Analytics List libraries
      description: Lists library resources in the workspace.
      tags:
      - Library
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully retrieved the list.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LibraryListResponse'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /libraries/{libraryName}:
    get:
      operationId: Library_Get
      summary: Azure Synapse Analytics Get a library
      description: Get a library resource.
      tags:
      - Library
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/LibraryNameParameter'
      responses:
        '200':
          description: Successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LibraryResource'
        '304':
          description: Not modified.
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    put:
      operationId: Library_Append
      summary: Azure Synapse Analytics Upload a library
      description: Creates or appends to a library resource.
      tags:
      - Library
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/LibraryNameParameter'
      - name: x-ms-blob-condition-appendpos
        in: header
        description: Set this header to a byte offset at which the block is expected to be appended.
        schema:
          type: integer
          format: int64
      requestBody:
        required: true
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary
      responses:
        '201':
          description: Successfully uploaded.
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      operationId: Library_Delete
      summary: Azure Synapse Analytics Delete a library
      description: Delete a library resource.
      tags:
      - Library
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/LibraryNameParameter'
      responses:
        '200':
          description: Successfully deleted.
        '202':
          description: Deletion accepted.
        '409':
          description: Conflict.
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /libraries/{libraryName}/flush:
    post:
      operationId: Library_Flush
      summary: Azure Synapse Analytics Flush a library
      description: Flush a library resource.
      tags:
      - Library
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/LibraryNameParameter'
      responses:
        '200':
          description: Successfully flushed.
        '202':
          description: Flush accepted.
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  parameters:
    LibraryNameParameter:
      name: libraryName
      in: path
      required: true
      description: Library name (e.g., library.jar or library.whl).
      schema:
        type: string
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      schema:
        type: string
        default: '2020-12-01'
  schemas:
    LibraryResource:
      type: object
      properties:
        id:
          type: string
          readOnly: true
        name:
          type: string
          readOnly: true
        type:
          type: string
          readOnly: true
        etag:
          type: string
          readOnly: true
        properties:
          type: object
          properties:
            name:
              type: string
              readOnly: true
            path:
              type: string
              readOnly: true
            containerName:
              type: string
              readOnly: true
            uploadedTimestamp:
              type: string
              format: date-time
              readOnly: true
            type:
              type: string
              readOnly: true
            provisioningStatus:
              type: string
              readOnly: true
            creatorId:
              type: string
              readOnly: true
    LibraryListResponse:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/LibraryResource'
        nextLink:
          type: string
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
          scopes:
            user_impersonation: impersonate your user account