openapi: 3.1.0
info:
  title: Azure Synapse Analytics - Linked Service API
  description: >-
    Create and manage linked services that define connection information to
    external data sources. Linked services act as connection strings for
    integrating with databases, storage, and other services.
  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:
        default: myworkspace
security:
  - azure_auth:
      - user_impersonation
paths:
  /linkedservices:
    get:
      operationId: LinkedService_GetLinkedServicesByWorkspace
      summary: Azure Synapse Analytics List linked services
      description: Lists linked services in the workspace.
      tags:
        - LinkedService
      parameters:
        - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully retrieved the list of linked services.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkedServiceListResponse'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /linkedservices/{linkedServiceName}:
    get:
      operationId: LinkedService_GetLinkedService
      summary: Azure Synapse Analytics Get a linked service
      description: Gets a linked service.
      tags:
        - LinkedService
      parameters:
        - $ref: '#/components/parameters/ApiVersionParameter'
        - $ref: '#/components/parameters/LinkedServiceNameParameter'
        - name: If-None-Match
          in: header
          schema:
            type: string
      responses:
        '200':
          description: Successfully retrieved the linked service.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkedServiceResource'
        '304':
          description: Not modified.
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    put:
      operationId: LinkedService_CreateOrUpdateLinkedService
      summary: Azure Synapse Analytics Create or update a linked service
      description: Creates or updates a linked service.
      tags:
        - LinkedService
      parameters:
        - $ref: '#/components/parameters/ApiVersionParameter'
        - $ref: '#/components/parameters/LinkedServiceNameParameter'
        - name: If-Match
          in: header
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinkedServiceResource'
      responses:
        '200':
          description: Successfully updated the linked service.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkedServiceResource'
        '202':
          description: Linked service creation accepted.
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      operationId: LinkedService_DeleteLinkedService
      summary: Azure Synapse Analytics Delete a linked service
      description: Deletes a linked service.
      tags:
        - LinkedService
      parameters:
        - $ref: '#/components/parameters/ApiVersionParameter'
        - $ref: '#/components/parameters/LinkedServiceNameParameter'
      responses:
        '200':
          description: Successfully deleted the linked service.
        '202':
          description: Linked service deletion accepted.
        '204':
          description: Linked service not found.
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /linkedservices/{linkedServiceName}/rename:
    post:
      operationId: LinkedService_RenameLinkedService
      summary: Azure Synapse Analytics Rename a linked service
      description: Renames a linked service.
      tags:
        - LinkedService
      parameters:
        - $ref: '#/components/parameters/ApiVersionParameter'
        - $ref: '#/components/parameters/LinkedServiceNameParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ArtifactRenameRequest'
      responses:
        '200':
          description: Successfully renamed.
        '202':
          description: Rename accepted.
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
          scopes:
            user_impersonation: impersonate your user account
  parameters:
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      schema:
        type: string
        default: '2020-12-01'
    LinkedServiceNameParameter:
      name: linkedServiceName
      in: path
      required: true
      description: The linked service name.
      schema:
        type: string
  schemas:
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
    LinkedServiceListResponse:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/LinkedServiceResource'
        nextLink:
          type: string
    LinkedServiceResource:
      type: object
      properties:
        id:
          type: string
          readOnly: true
        name:
          type: string
          readOnly: true
        type:
          type: string
          readOnly: true
        etag:
          type: string
          readOnly: true
        properties:
          $ref: '#/components/schemas/LinkedService'
    LinkedService:
      type: object
      required:
        - type
      properties:
        type:
          type: string
          description: Type of linked service.
        description:
          type: string
        connectVia:
          type: object
          properties:
            referenceName:
              type: string
            type:
              type: string
        parameters:
          type: object
          additionalProperties:
            type: object
        annotations:
          type: array
          items:
            type: string
        typeProperties:
          type: object
          description: Type specific properties of the linked service.
    ArtifactRenameRequest:
      type: object
      properties:
        newName:
          type: string
tags:
  - name: LinkedService