Azure Synapse Analytics - Spark Job API — SparkSession

naftiko: 1.0.0-alpha2
info:
  label: Azure Synapse Analytics - Spark Job API — SparkSession
  description: 'Azure Synapse Analytics - Spark Job API — SparkSession. 7 operations. Lead operation: Azure Synapse Analytics
    List Spark sessions. Self-contained Naftiko capability covering one Microsoft Azure Synapse Analytics business surface.'
  tags:
  - Microsoft Azure Synapse Analytics
  - SparkSession
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    MICROSOFT_AZURE_SYNAPSE_ANALYTICS_API_KEY: MICROSOFT_AZURE_SYNAPSE_ANALYTICS_API_KEY
capability:
  consumes:
  - type: http
    namespace: azure-synapse-analytics-spark-job-sparksession
    baseUri: https://{workspaceName}.dev.azuresynapse.net
    description: Azure Synapse Analytics - Spark Job API — SparkSession business capability. Self-contained, no shared references.
    resources:
    - name: livyApi-versions-sparkPoolName-sessions
      path: /livyApi/versions/{sparkPoolName}/sessions
      operations:
      - name: sparksessiongetsparksessions
        method: GET
        description: Azure Synapse Analytics List Spark sessions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: from
          in: query
          type: integer
        - name: size
          in: query
          type: integer
        - name: detailed
          in: query
          type: boolean
      - name: sparksessioncreatesparksession
        method: POST
        description: Azure Synapse Analytics Create a Spark session
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: detailed
          in: query
          type: boolean
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: livyApi-versions-sparkPoolName-sessions-sessionId
      path: /livyApi/versions/{sparkPoolName}/sessions/{sessionId}
      operations:
      - name: sparksessiongetsparksession
        method: GET
        description: Azure Synapse Analytics Get a Spark session
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: sessionId
          in: path
          type: integer
          required: true
        - name: detailed
          in: query
          type: boolean
      - name: sparksessioncancelsparksession
        method: DELETE
        description: Azure Synapse Analytics Cancel a Spark session
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: sessionId
          in: path
          type: integer
          required: true
    - name: livyApi-versions-sparkPoolName-sessions-sessionId-statements
      path: /livyApi/versions/{sparkPoolName}/sessions/{sessionId}/statements
      operations:
      - name: sparksessiongetsparkstatements
        method: GET
        description: Azure Synapse Analytics List Spark session statements
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: sessionId
          in: path
          type: integer
          required: true
      - name: sparksessioncreatesparkstatement
        method: POST
        description: Azure Synapse Analytics Create a Spark statement
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: sessionId
          in: path
          type: integer
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: livyApi-versions-sparkPoolName-sessions-sessionId-statements-statementId-cancel
      path: /livyApi/versions/{sparkPoolName}/sessions/{sessionId}/statements/{statementId}/cancel
      operations:
      - name: sparksessioncancelsparkstatement
        method: POST
        description: Azure Synapse Analytics Cancel a Spark statement
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: sessionId
          in: path
          type: integer
          required: true
        - name: statementId
          in: path
          type: integer
          required: true
    authentication:
      type: bearer
      token: '{{env.MICROSOFT_AZURE_SYNAPSE_ANALYTICS_API_KEY}}'
  exposes:
  - type: rest
    namespace: azure-synapse-analytics-spark-job-sparksession-rest
    port: 8080
    description: REST adapter for Azure Synapse Analytics - Spark Job API — SparkSession. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/livyapi/versions/{sparkpoolname}/sessions
      name: livyapi-versions-sparkpoolname-sessions
      description: REST surface for livyApi-versions-sparkPoolName-sessions.
      operations:
      - method: GET
        name: sparksessiongetsparksessions
        description: Azure Synapse Analytics List Spark sessions
        call: azure-synapse-analytics-spark-job-sparksession.sparksessiongetsparksessions
        with:
          from: rest.from
          size: rest.size
          detailed: rest.detailed
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: sparksessioncreatesparksession
        description: Azure Synapse Analytics Create a Spark session
        call: azure-synapse-analytics-spark-job-sparksession.sparksessioncreatesparksession
        with:
          detailed: rest.detailed
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/livyapi/versions/{sparkpoolname}/sessions/{sessionid}
      name: livyapi-versions-sparkpoolname-sessions-sessionid
      description: REST surface for livyApi-versions-sparkPoolName-sessions-sessionId.
      operations:
      - method: GET
        name: sparksessiongetsparksession
        description: Azure Synapse Analytics Get a Spark session
        call: azure-synapse-analytics-spark-job-sparksession.sparksessiongetsparksession
        with:
          sessionId: rest.sessionId
          detailed: rest.detailed
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: sparksessioncancelsparksession
        description: Azure Synapse Analytics Cancel a Spark session
        call: azure-synapse-analytics-spark-job-sparksession.sparksessioncancelsparksession
        with:
          sessionId: rest.sessionId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/livyapi/versions/{sparkpoolname}/sessions/{sessionid}/statements
      name: livyapi-versions-sparkpoolname-sessions-sessionid-statements
      description: REST surface for livyApi-versions-sparkPoolName-sessions-sessionId-statements.
      operations:
      - method: GET
        name: sparksessiongetsparkstatements
        description: Azure Synapse Analytics List Spark session statements
        call: azure-synapse-analytics-spark-job-sparksession.sparksessiongetsparkstatements
        with:
          sessionId: rest.sessionId
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: sparksessioncreatesparkstatement
        description: Azure Synapse Analytics Create a Spark statement
        call: azure-synapse-analytics-spark-job-sparksession.sparksessioncreatesparkstatement
        with:
          sessionId: rest.sessionId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/livyapi/versions/{sparkpoolname}/sessions/{sessionid}/statements/{statementid}/cancel
      name: livyapi-versions-sparkpoolname-sessions-sessionid-statements-statementid-cancel
      description: REST surface for livyApi-versions-sparkPoolName-sessions-sessionId-statements-statementId-cancel.
      operations:
      - method: POST
        name: sparksessioncancelsparkstatement
        description: Azure Synapse Analytics Cancel a Spark statement
        call: azure-synapse-analytics-spark-job-sparksession.sparksessioncancelsparkstatement
        with:
          sessionId: rest.sessionId
          statementId: rest.statementId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: azure-synapse-analytics-spark-job-sparksession-mcp
    port: 9090
    transport: http
    description: MCP adapter for Azure Synapse Analytics - Spark Job API — SparkSession. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: azure-synapse-analytics-list-spark
      description: Azure Synapse Analytics List Spark sessions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: azure-synapse-analytics-spark-job-sparksession.sparksessiongetsparksessions
      with:
        from: tools.from
        size: tools.size
        detailed: tools.detailed
      outputParameters:
      - type: object
        mapping: $.
    - name: azure-synapse-analytics-create-spark
      description: Azure Synapse Analytics Create a Spark session
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: azure-synapse-analytics-spark-job-sparksession.sparksessioncreatesparksession
      with:
        detailed: tools.detailed
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: azure-synapse-analytics-get-spark
      description: Azure Synapse Analytics Get a Spark session
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: azure-synapse-analytics-spark-job-sparksession.sparksessiongetsparksession
      with:
        sessionId: tools.sessionId
        detailed: tools.detailed
      outputParameters:
      - type: object
        mapping: $.
    - name: azure-synapse-analytics-cancel-spark
      description: Azure Synapse Analytics Cancel a Spark session
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: azure-synapse-analytics-spark-job-sparksession.sparksessioncancelsparksession
      with:
        sessionId: tools.sessionId
      outputParameters:
      - type: object
        mapping: $.
    - name: azure-synapse-analytics-list-spark-2
      description: Azure Synapse Analytics List Spark session statements
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: azure-synapse-analytics-spark-job-sparksession.sparksessiongetsparkstatements
      with:
        sessionId: tools.sessionId
      outputParameters:
      - type: object
        mapping: $.
    - name: azure-synapse-analytics-create-spark-2
      description: Azure Synapse Analytics Create a Spark statement
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: azure-synapse-analytics-spark-job-sparksession.sparksessioncreatesparkstatement
      with:
        sessionId: tools.sessionId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: azure-synapse-analytics-cancel-spark-2
      description: Azure Synapse Analytics Cancel a Spark statement
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: azure-synapse-analytics-spark-job-sparksession.sparksessioncancelsparkstatement
      with:
        sessionId: tools.sessionId
        statementId: tools.statementId
      outputParameters:
      - type: object
        mapping: $.