openapi: 3.1.0
info:
  title: Azure Synapse Analytics - KQL Script API
  description: >-
    Create and manage KQL (Kusto Query Language) scripts for querying Data
    Explorer pools. Supports authoring and storing KQL queries as workspace
    artifacts.
  version: '2021-11-01-preview'
  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:
  /kqlScripts:
    get:
      operationId: KqlScripts_GetAll
      summary: Azure Synapse Analytics List KQL scripts
      description: Get all KQL scripts in the workspace.
      tags:
        - KqlScripts
      parameters:
        - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully retrieved the list.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KqlScriptsResourceCollectionResponse'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /kqlScripts/{kqlScriptName}:
    get:
      operationId: KqlScript_GetByName
      summary: Azure Synapse Analytics Get a KQL script
      description: Get KQL script by name.
      tags:
        - KqlScripts
      parameters:
        - $ref: '#/components/parameters/ApiVersionParameter'
        - $ref: '#/components/parameters/KqlScriptNameParameter'
      responses:
        '200':
          description: Successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KqlScriptResource'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    put:
      operationId: KqlScript_CreateOrUpdate
      summary: Azure Synapse Analytics Create or update a KQL script
      description: Creates or updates a KQL Script.
      tags:
        - KqlScripts
      parameters:
        - $ref: '#/components/parameters/ApiVersionParameter'
        - $ref: '#/components/parameters/KqlScriptNameParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KqlScriptResource'
      responses:
        '200':
          description: Successfully updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KqlScriptResource'
        '202':
          description: Creation accepted.
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      operationId: KqlScript_DeleteByName
      summary: Azure Synapse Analytics Delete a KQL script
      description: Delete KQL script by name.
      tags:
        - KqlScripts
      parameters:
        - $ref: '#/components/parameters/ApiVersionParameter'
        - $ref: '#/components/parameters/KqlScriptNameParameter'
      responses:
        '200':
          description: Successfully deleted.
        '202':
          description: Deletion accepted.
        '204':
          description: Not found.
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /kqlScripts/{kqlScriptName}/rename:
    post:
      operationId: KqlScript_Rename
      summary: Azure Synapse Analytics Rename a KQL script
      description: Rename a KQL script.
      tags:
        - KqlScripts
      parameters:
        - $ref: '#/components/parameters/ApiVersionParameter'
        - $ref: '#/components/parameters/KqlScriptNameParameter'
      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: '2021-11-01-preview'
    KqlScriptNameParameter:
      name: kqlScriptName
      in: path
      required: true
      description: KQL script name.
      schema:
        type: string
  schemas:
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
    KqlScriptsResourceCollectionResponse:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/KqlScriptResource'
        nextLink:
          type: string
    KqlScriptResource:
      type: object
      properties:
        id:
          type: string
          readOnly: true
        name:
          type: string
          readOnly: true
        type:
          type: string
          readOnly: true
        properties:
          $ref: '#/components/schemas/KqlScript'
    KqlScript:
      type: object
      properties:
        description:
          type: string
        content:
          type: object
          properties:
            query:
              type: string
              description: The KQL query content.
            metadata:
              type: object
              properties:
                language:
                  type: string
            currentConnection:
              type: object
              properties:
                name:
                  type: string
                  description: Data Explorer pool name.
                databaseName:
                  type: string
                  description: Data Explorer database name.
                type:
                  type: string
        folder:
          type: object
          properties:
            name:
              type: string
    ArtifactRenameRequest:
      type: object
      properties:
        newName:
          type: string
tags:
  - name: KqlScripts