Microsoft Azure · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Azure Job API

26 actions 26 updates phrasing extends openapi/microsoft-azure-job-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Microsoft Azure's API. It is a proposal applied on top of the contract, not a document Microsoft Azure publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 26 · first 16 shown; the file carries all of them

$.info
$.paths['/jobs'].get
$.paths['/jobs/{jobIdentity}'].get
$.paths['/jobs/{jobIdentity}'].put
$.paths['/jobs/{jobIdentity}'].patch
$.paths['/jobs/{jobIdentity}/GetStatistics'].get
$.paths['/jobs/{jobIdentity}/GetDebugDataPath'].get
$.paths['/jobs/{jobIdentity}/CancelJob'].post
$.paths['/jobs/{jobIdentity}/YieldJob'].post
$.paths['/buildJob'].post
$.paths['/livy/batches'].get
$.paths['/livy/batches'].post
$.paths['/livy/batches/{batchId}'].get
$.paths['/livy/batches/{batchId}'].delete
$.paths['/livy/batches/{batchId}/log'].get
$.paths['/livy/batches/{batchId}/state'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Azure Job API
  version: 1.0.0
extends: openapi/microsoft-azure-job-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 25
- target: $.paths['/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List Data Lake Analytics jobs in an account
      effect: read
      questions:
      - Which Data Lake Analytics jobs have been submitted in my account?
      - Can I sort or filter my Data Lake Analytics job list with OData?
      instructions:
      - text: List every job in my Data Lake Analytics account.
      - text: List Data Lake Analytics jobs matching {filter}, top {top}, ordered by {orderby}.
        slots:
          filter: query.$filter
          top: query.$top
          orderby: query.$orderby
      method: generated
      generated: '2026-10-01'
- target: $.paths['/jobs/{jobIdentity}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a Data Lake Analytics job
      effect: read
      questions:
      - What is the current state and result of a specific Data Lake Analytics job?
      - Can I look up who submitted a given analytics job and when?
      instructions:
      - text: Get the job information for Data Lake Analytics job {job_id}.
        slots:
          job_id: path.jobIdentity
      - text: Show me whether analytics job {job_id} succeeded or failed.
        slots:
          job_id: path.jobIdentity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobIdentity}'].put
  update:
    x-apievangelist-phrasing:
      intent: Submit a Data Lake Analytics job
      effect: write
      questions:
      - How do I submit a U-SQL script as a new Data Lake Analytics job?
      - Can I set the priority and degree of parallelism when submitting an analytics job?
      - What does a job submission need besides a name, a type and its properties?
      instructions:
      - text: Submit Data Lake Analytics job {job_id} named {name} of type {type}.
        slots:
          job_id: path.jobIdentity
          name: requestBody.name
          type: requestBody.type
      - text: Submit job {job_id} called {name} with priority {priority} and parallelism {parallelism}.
        slots:
          job_id: path.jobIdentity
          name: requestBody.name
          priority: requestBody.priority
          parallelism: requestBody.degreeOfParallelism
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobIdentity}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a running Scope job's priority or parallelism
      effect: write
      questions:
      - Can I change the priority of a job that is already submitted to Data Lake Analytics?
      - Is it possible to raise the parallelism of an existing Scope job?
      instructions:
      - text: Update the priority of existing job {job_id} to {priority}.
        slots:
          job_id: path.jobIdentity
          priority: requestBody.priority
      - text: Change the degree of parallelism on already-submitted job {job_id} to {parallelism}.
        slots:
          job_id: path.jobIdentity
          parallelism: requestBody.degreeOfParallelism
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobIdentity}/GetStatistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get statistics for a Data Lake Analytics job
      effect: read
      questions:
      - Where can I see the execution statistics of a finished analytics job?
      - What stage-level stats does Data Lake Analytics keep for a job?
      instructions:
      - text: Get the statistics for analytics job {job_id}.
        slots:
          job_id: path.jobIdentity
      - text: Pull the performance stats of job {job_id} so I can see where time went.
        slots:
          job_id: path.jobIdentity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobIdentity}/GetDebugDataPath'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the debug data location for a job
      effect: read
      questions:
      - Where is the debug data stored for a failed Data Lake Analytics job?
      - Can I find the path to a job's debug files so I can download them?
      instructions:
      - text: Get the debug data path for job {job_id}.
        slots:
          job_id: path.jobIdentity
      - text: Tell me where the debugging output for analytics job {job_id} lives.
        slots:
          job_id: path.jobIdentity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobIdentity}/CancelJob'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a running Data Lake Analytics job
      effect: destructive
      questions:
      - How do I stop a Data Lake Analytics job that is still running?
      - Can I cancel an analytics job that is taking too long?
      instructions:
      - text: Cancel running Data Lake Analytics job {job_id}.
        slots:
          job_id: path.jobIdentity
      - text: Kill analytics job {job_id} now.
        slots:
          job_id: path.jobIdentity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobIdentity}/YieldJob'].post
  update:
    x-apievangelist-phrasing:
      intent: Pause a Scope job and requeue it
      effect: write
      questions:
      - Can I pause a Scope job and put it back in the queue behind higher-priority work?
      - What happens when a Data Lake Analytics job yields?
      instructions:
      - text: Yield job {job_id} back to the job queue.
        slots:
          job_id: path.jobIdentity
      - text: Pause Scope job {job_id} and let equal or higher priority jobs run first.
        slots:
          job_id: path.jobIdentity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/buildJob'].post
  update:
    x-apievangelist-phrasing:
      intent: Compile a job to validate it before submitting
      effect: read
      questions:
      - Can I check a U-SQL script compiles before I actually submit the job?
      - Is there a way to validate a Data Lake Analytics job for correctness without running it?
      instructions:
      - text: Build (compile only) a {type} job with properties {properties} to check for errors.
        slots:
          type: requestBody.type
          properties: requestBody.properties
      - text: Validate job {name} by compiling it without running.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/livy/batches'].get
  update:
    x-apievangelist-phrasing:
      intent: List Spark batch jobs
      effect: read
      questions:
      - Which Spark batch jobs are submitted through Livy right now?
      - Can I page through Spark batches starting from a given offset?
      instructions:
      - text: List all Spark batch jobs.
      - text: List {size} Spark batches starting at index {from}.
        slots:
          size: query.size
          from: query.from
      method: generated
      generated: '2026-09-26'
- target: $.paths['/livy/batches'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a Spark batch job
      effect: write
      questions:
      - How do I submit a jar or Python file as a Spark batch job through Livy?
      - Can I set executor memory and number of executors on a Spark batch?
      instructions:
      - text: Submit a Spark batch running {file} with main class {class_name}.
        slots:
          file: requestBody.file
          class_name: requestBody.className
      - text: Start Spark batch {name} from {file} with {executors} executors.
        slots:
          name: requestBody.name
          file: requestBody.file
          executors: requestBody.numExecutors
      method: generated
      generated: '2026-09-26'
- target: $.paths['/livy/batches/{batchId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Spark batch job
      effect: read
      questions:
      - What are the details of one Spark batch job I submitted?
      - Can I look up a single Livy batch by its id?
      instructions:
      - text: Get Spark batch job {batch_id}.
        slots:
          batch_id: path.batchId
      - text: Show me the details of Livy batch {batch_id}.
        slots:
          batch_id: path.batchId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/livy/batches/{batchId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a running Spark batch job
      effect: destructive
      questions:
      - How do I cancel a Spark batch job that is still running?
      - Can I kill a Livy batch before it finishes?
      instructions:
      - text: Cancel Spark batch {batch_id}.
        slots:
          batch_id: path.batchId
      - text: Stop the running Livy batch job {batch_id}.
        slots:
          batch_id: path.batchId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/livy/batches/{batchId}/log'].get
  update:
    x-apievangelist-phrasing:
      intent: Read the logs of a Spark batch job
      effect: read
      questions:
      - Where can I read the driver log output of a Spark batch job?
      - Can I fetch only part of a Spark batch's log lines?
      instructions:
      - text: Get the logs for Spark batch {batch_id}.
        slots:
          batch_id: path.batchId
      - text: Show {size} log lines of batch {batch_id} starting at line {from}.
        slots:
          size: query.size
          batch_id: path.batchId
          from: query.from
      method: generated
      generated: '2026-09-26'
- target: $.paths['/livy/batches/{batchId}/state'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the state of a Spark batch job
      effect: read
      questions:
      - Is my Spark batch job still running, or did it finish?
      - What state is a given Livy batch in right now?
      instructions:
      - text: Check the state of Spark batch {batch_id}.
        slots:
          batch_id: path.batchId
      - text: Tell me whether batch {batch_id} is running, dead or successful.
        slots:
          batch_id: path.batchId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/livy/sessions'].get
  update:
    x-apievangelist-phrasing:
      intent: List Spark sessions
      effect: read
      questions:
      - Which interactive Spark sessions are open through Livy?
      - Can I page through Spark sessions a few at a time?
      instructions:
      - text: List all interactive Spark sessions.
      - text: List {size} Spark sessions starting from index {from}.
        slots:
          size: query.size
          from: query.from
      method: generated
      generated: '2026-09-26'
- target: $.paths['/livy/sessions'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an interactive Spark session
      effect: write
      questions:
      - How do I open a new interactive Spark session for running code?
      - Can I choose the session kind, like pyspark or scala, when starting a Spark session?
      instructions:
      - text: Start a new {kind} Spark session.
        slots:
          kind: requestBody.kind
      - text: Create Spark session {name} with {executors} executors and a {timeout} second heartbeat timeout.
        slots:
          name: requestBody.name
          executors: requestBody.numExecutors
          timeout: requestBody.heartbeatTimeoutInSecond
      method: generated
      generated: '2026-09-26'
- target: $.paths['/livy/sessions/{sessionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Spark session
      effect: read
      questions:
      - What are the details of one interactive Spark session?
      - Can I look up a Livy session by its id?
      instructions:
      - text: Get Spark session {session_id}.
        slots:
          session_id: path.sessionId
      - text: Show the configuration of interactive session {session_id}.
        slots:
          session_id: path.sessionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/livy/sessions/{sessionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Close a Spark session
      effect: destructive
      questions:
      - How do I shut down an interactive Spark session I no longer need?
      - Can I cancel a Spark session that is still running?
      instructions:
      - text: Close Spark session {session_id}.
        slots:
          session_id: path.sessionId
      - text: Cancel the running interactive session {session_id}.
        slots:
          session_id: path.sessionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/livy/sessions/{sessionId}/log'].get
  update:
    x-apievangelist-phrasing:
      intent: Read the logs of a Spark session
      effect: read
      questions:
      - Where can I see the log output of an interactive Spark session?
      - Can I fetch a window of lines from a Spark session's log?
      instructions:
      - text: Get the logs for Spark session {session_id}.
        slots:
          session_id: path.sessionId
      - text: Show {size} log lines of session {session_id} from line {from}.
        slots:
          size: query.size
          session_id: path.sessionId
          from: query.from
      method: generated
      generated: '2026-09-26'
- target: $.paths['/livy/sessions/{sessionId}/state'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the state of a Spark session
      effect: read
      questions:
      - Is my interactive Spark session idle, busy or dead?
      - What state is a given Livy session in?
      instructions:
      - text: Check the state of Spark session {session_id}.
        slots:
          session_id: path.sessionId
      - text: Tell me whether session {session_id} is ready for statements.
        slots:
          session_id: path.sessionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/livy/sessions/{sessionId}/statements'].get
  update:
    x-apievangelist-phrasing:
      intent: List statements run in a Spark session
      effect: read
      questions:
      - Which code statements have been run inside a Spark session?
      - Can I see the history of statements for one interactive session?
      instructions:
      - text: List the statements in Spark session {session_id}.
        slots:
          session_id: path.sessionId
      - text: Show every code snippet executed in session {session_id}.
        slots:
          session_id: path.sessionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/livy/sessions/{sessionId}/statements'].post
  update:
    x-apievangelist-phrasing:
      intent: Run code as a statement in a Spark session
      effect: write
      questions:
      - How do I run a snippet of code inside an open Spark session?
      - Can I send SQL or Python code to an existing interactive session?
      instructions:
      - text: Run {code} in Spark session {session_id}.
        slots:
          code: requestBody.code
          session_id: path.sessionId
      - text: 'Submit this {kind} statement to session {session_id}: {code}'
        slots:
          kind: requestBody.kind
          session_id: path.sessionId
          code: requestBody.code
      method: generated
      generated: '2026-09-26'
- target: $.paths['/livy/sessions/{sessionId}/statements/{statementId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a statement's result in a Spark session
      effect: read
      questions:
      - What was the output of a statement I ran in a Spark session?
      - Has a particular Spark statement finished executing?
      instructions:
      - text: Get statement {statement_id} in Spark session {session_id}.
        slots:
          statement_id: path.statementId
          session_id: path.sessionId
      - text: Show the output of statement {statement_id} from session {session_id}.
        slots:
          statement_id: path.statementId
          session_id: path.sessionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/livy/sessions/{sessionId}/statements/{statementId}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Kill a statement in a Spark session
      effect: destructive
      questions:
      - How do I stop a long-running statement without closing the whole Spark session?
      - Can I cancel just one statement inside an interactive session?
      instructions:
      - text: Cancel statement {statement_id} in Spark session {session_id}.
        slots:
          statement_id: path.statementId
          session_id: path.sessionId
      - text: Kill the running statement {statement_id} but keep session {session_id} open.
        slots:
          statement_id: path.statementId
          session_id: path.sessionId
      method: generated
      generated: '2026-09-26'

Work with this as data

Every overlay 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 openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • 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 overlay
curl "https://apis.io/api/v1/overlays/microsoft-azure-job-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.