# 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 Tasks API
  version: 1.0.0
extends: openapi/microsoft-azure-tasks-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 17
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}/tasks'].get
  update:
    x-apievangelist-phrasing:
      intent: List tasks in a workspace
      effect: read
      questions:
      - Which tasks are running or finished in a particular workspace?
      - Can I page through a workspace's tasks with a filter?
      instructions:
      - text: List the tasks in workspace {workspace}.
        slots:
          workspace: path.workspaceName
      - text: List tasks in workspace {workspace} matching {filter}.
        slots:
          workspace: path.workspaceName
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}/tasks/{taskId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workspace task
      effect: read
      questions:
      - How do I check the status of a task in a workspace on the data plane?
      - What details does a single workspace task return?
      instructions:
      - text: Get task {task} in workspace {workspace}.
        slots:
          task: path.taskId
          workspace: path.workspaceName
      - text: Check the progress of workspace task {task} in {workspace}.
        slots:
          task: path.taskId
          workspace: path.workspaceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}/tasks/{taskId}:cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a workspace task
      effect: destructive
      questions:
      - Can I stop a task that is still running in my workspace?
      - How do I cancel a workspace task I started by mistake?
      instructions:
      - text: Cancel task {task} in workspace {workspace}.
        slots:
          task: path.taskId
          workspace: path.workspaceName
      - text: Stop the running workspace task {task} in {workspace}.
        slots:
          task: path.taskId
          workspace: path.workspaceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}/tasks/{taskId}:download'].post
  update:
    x-apievangelist-phrasing:
      intent: Download a workspace task's data
      effect: read
      questions:
      - How do I download the output data of a finished workspace task?
      - Can I get the data a workspace task produced as a download?
      instructions:
      - text: Download the data for task {task} in workspace {workspace}.
        slots:
          task: path.taskId
          workspace: path.workspaceName
      - text: Export the results of workspace task {task} from {workspace}.
        slots:
          task: path.taskId
          workspace: path.workspaceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobId}/tasks'].get
  update:
    x-apievangelist-phrasing:
      intent: List tasks in a Batch job
      effect: read
      questions:
      - Which tasks belong to an Azure Batch job and what state are they in?
      - Can I filter a Batch job's task list and select only certain properties?
      instructions:
      - text: List the tasks in Batch job {job}.
        slots:
          job: path.jobId
      - text: List tasks in job {job} that match {filter}.
        slots:
          job: path.jobId
          filter: query.$filter
      - text: List up to {max} tasks in Batch job {job}.
        slots:
          job: path.jobId
          max: query.maxresults
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobId}/tasks'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a task to a Batch job
      effect: write
      questions:
      - How do I submit a new command-line task to a Batch job?
      - Is there a maximum lifetime for a task once it is added to a job?
      instructions:
      - text: Add task {id} to job {job} running {command}.
        slots:
          id: requestBody.id
          job: path.jobId
          command: requestBody.commandLine
      - text: Create task {id} in job {job} with command line {command} and display name {name}.
        slots:
          id: requestBody.id
          job: path.jobId
          command: requestBody.commandLine
          name: requestBody.displayName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobId}/addtaskcollection'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a collection of tasks to a Batch job
      effect: write
      questions:
      - Can I add many tasks to a Batch job in one request?
      - What happens if a bulk task submission times out partway through?
      instructions:
      - text: Add the tasks {tasks} to job {job} in one batch.
        slots:
          tasks: requestBody.value
          job: path.jobId
      - text: Submit this list of tasks {tasks} to Batch job {job} together.
        slots:
          tasks: requestBody.value
          job: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobId}/tasks/{taskId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Batch task
      effect: read
      questions:
      - How do I check the execution info and state of one Batch task?
      - Can I fetch a Batch task only if it changed since a given time?
      instructions:
      - text: Get task {task} in job {job}.
        slots:
          task: path.taskId
          job: path.jobId
      - text: Get task {task} in job {job} if modified since {since}.
        slots:
          task: path.taskId
          job: path.jobId
          since: header.If-Modified-Since
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobId}/tasks/{taskId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Batch task's constraints
      effect: write
      questions:
      - Can I change the retry count or max wall-clock time of an existing Batch task?
      - Which properties of a Batch task can be updated after it is added?
      instructions:
      - text: Update the constraints of task {task} in job {job} to {constraints}.
        slots:
          task: path.taskId
          job: path.jobId
          constraints: requestBody.constraints
      - text: Change the retry and time limits of task {task} in job {job} to {constraints}.
        slots:
          task: path.taskId
          job: path.jobId
          constraints: requestBody.constraints
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobId}/tasks/{taskId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Batch task
      effect: destructive
      questions:
      - Does deleting a Batch task also remove its files from the compute node?
      - How do I remove a task from a Batch job?
      instructions:
      - text: Delete task {task} from job {job}.
        slots:
          task: path.taskId
          job: path.jobId
      - text: Remove Batch task {task} and its node files from job {job}.
        slots:
          task: path.taskId
          job: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobId}/tasks/{taskId}/subtasksinfo'].get
  update:
    x-apievangelist-phrasing:
      intent: List subtasks of a multi-instance Batch task
      effect: read
      questions:
      - How do I see the subtasks of a multi-instance Batch task?
      - Why would a task's subtask list come back empty?
      instructions:
      - text: List the subtasks of task {task} in job {job}.
        slots:
          task: path.taskId
          job: path.jobId
      - text: Show subtask info for multi-instance task {task} in job {job}.
        slots:
          task: path.taskId
          job: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobId}/tasks/{taskId}/terminate'].post
  update:
    x-apievangelist-phrasing:
      intent: Terminate a Batch task
      effect: destructive
      questions:
      - Can I force a running Batch task to stop and move to completed?
      - What happens to subtasks when I terminate a multi-instance task?
      instructions:
      - text: Terminate task {task} in job {job}.
        slots:
          task: path.taskId
          job: path.jobId
      - text: Force Batch task {task} in job {job} to end now.
        slots:
          task: path.taskId
          job: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobId}/tasks/{taskId}/reactivate'].post
  update:
    x-apievangelist-phrasing:
      intent: Reactivate a failed Batch task
      effect: write
      questions:
      - How do I retry a Batch task that already failed?
      - Does reactivating a task clear its previous exit code?
      instructions:
      - text: Reactivate task {task} in job {job} so it can run again.
        slots:
          task: path.taskId
          job: path.jobId
      - text: Make failed Batch task {task} in job {job} eligible for retry.
        slots:
          task: path.taskId
          job: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tasks'].get
  update:
    x-apievangelist-phrasing:
      intent: List tasks without naming a workspace
      effect: read
      questions:
      - Can I search all tasks on the service with a filter and sort order?
      - Which tasks match my search when I am not scoping to a workspace?
      instructions:
      - text: List tasks ordered by {orderby}.
        slots:
          orderby: query.orderby
      - text: Search the service-level tasks for {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tasks/{taskId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a task by ID at the service root
      effect: read
      questions:
      - How do I look up a task by its ID alone, with no workspace in the path?
      - What does the root-level task lookup return?
      instructions:
      - text: Look up task {task} by ID at the service root.
        slots:
          task: path.taskId
      - text: Show the status of root-level task {task}.
        slots:
          task: path.taskId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tasks/{taskId}:cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a task by ID at the service root
      effect: destructive
      questions:
      - Can I cancel a task using only its task ID, outside any workspace path?
      - How do I stop a root-level task that is still in progress?
      instructions:
      - text: Cancel root-level task {task}.
        slots:
          task: path.taskId
      - text: Stop task {task} by its ID without a workspace.
        slots:
          task: path.taskId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Easm/workspaces/{workspaceName}/tasks/{taskId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an EASM workspace task via the resource provider
      effect: read
      questions:
      - How do I read a task through the Microsoft.Easm management plane?
      - Can I check a Defender EASM workspace task from its resource group?
      instructions:
      - text: Get task {task} in EASM workspace {workspace} through the Microsoft.Easm provider.
        slots:
          task: path.taskId
          workspace: path.workspaceName
      - text: Show EASM management-plane task {task} for workspace {workspace}.
        slots:
          task: path.taskId
          workspace: path.workspaceName
      method: generated
      generated: '2026-09-26'