# 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 Jobs API
  version: 1.0.0
extends: openapi/microsoft-azure-jobs-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: 60
- target: $.paths['/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List all Batch jobs in an account
      effect: read
      questions:
      - What Batch jobs exist in my Azure Batch account right now?
      - Can I filter the list of Batch jobs in my account with an OData expression?
      instructions:
      - text: List every job in my Batch account.
      - text: List Batch jobs in my account matching the filter {filter}, at most {maxresults} per page.
        slots:
          filter: query.$filter
          maxresults: query.maxresults
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Batch job on a pool
      effect: write
      questions:
      - How do I add a new job to my Azure Batch account and point it at a pool?
      - Can a new Batch job start with a Job Manager task that controls its other tasks?
      - Is it possible to set a priority and a max parallel task count when I create a Batch job?
      instructions:
      - text: Create Batch job {id} that runs on pool {poolInfo}.
        slots:
          id: requestBody.id
          poolInfo: requestBody.poolInfo
      - text: Create Batch job {id} on pool {poolInfo} with priority {priority} and at most {maxParallelTasks} tasks in parallel.
        slots:
          id: requestBody.id
          poolInfo: requestBody.poolInfo
          priority: requestBody.priority
          maxParallelTasks: requestBody.maxParallelTasks
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one Batch job
      effect: read
      questions:
      - What state is my Batch job in and which pool is it bound to?
      - Where can I see the constraints and execution info of a single Batch job?
      instructions:
      - text: Show me the details of Batch job {jobId}.
        slots:
          jobId: path.jobId
      - text: Get the current state of Batch job {jobId}.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Fully replace a Batch job's properties
      effect: write
      questions:
      - Can I overwrite all updatable properties of a Batch job so unspecified ones reset to defaults?
      - What happens to a Batch job's constraints if I replace the job without specifying them?
      instructions:
      - text: Replace all properties of Batch job {jobId}, keeping it on pool {poolInfo}.
        slots:
          jobId: path.jobId
          poolInfo: requestBody.poolInfo
      - text: Fully replace Batch job {jobId} with priority {priority} on pool {poolInfo}, clearing anything I leave out.
        slots:
          jobId: path.jobId
          priority: requestBody.priority
          poolInfo: requestBody.poolInfo
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Batch job and its tasks
      effect: destructive
      questions:
      - Does deleting a Batch job also remove all its tasks and statistics?
      - How can I get rid of a finished Batch job entirely?
      instructions:
      - text: Delete Batch job {jobId} along with all of its tasks.
        slots:
          jobId: path.jobId
      - text: Remove Batch job {jobId} from my account.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch selected properties of a Batch job
      effect: write
      questions:
      - Can I change only the priority of a Batch job without touching its other settings?
      - Is there a way to move a running Batch job to a different pool or set what happens when all tasks complete?
      instructions:
      - text: Change the priority of Batch job {jobId} to {priority}, leaving everything else as is.
        slots:
          jobId: path.jobId
          priority: requestBody.priority
      - text: Set Batch job {jobId} to take action {onAllTasksComplete} once all its tasks finish.
        slots:
          jobId: path.jobId
          onAllTasksComplete: requestBody.onAllTasksComplete
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobId}/addtaskcollection'].post
  update:
    x-apievangelist-phrasing:
      intent: Add many tasks to a Batch job at once
      effect: write
      questions:
      - Can I submit a whole collection of tasks to a Batch job in one request?
      - Do tasks added in bulk to a Batch job each need a unique ID?
      instructions:
      - text: Add the tasks {value} to Batch job {jobId} in a single bulk call.
        slots:
          value: requestBody.value
          jobId: path.jobId
      - text: Bulk-submit this list of tasks {value} into job {jobId}.
        slots:
          value: requestBody.value
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobId}/disable'].post
  update:
    x-apievangelist-phrasing:
      intent: Disable a Batch job to stop new tasks
      effect: write
      questions:
      - How do I pause a Batch job so no new tasks start?
      - When I disable a Batch job, can I choose whether running tasks are requeued, terminated or left to finish?
      instructions:
      - text: Disable Batch job {jobId} and handle its running tasks with {disableTasks}.
        slots:
          jobId: path.jobId
          disableTasks: requestBody.disableTasks
      - text: Disable job {jobId}, requeuing its active tasks ({disableTasks}).
        slots:
          jobId: path.jobId
          disableTasks: requestBody.disableTasks
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobId}/enable'].post
  update:
    x-apievangelist-phrasing:
      intent: Re-enable a disabled Batch job
      effect: write
      questions:
      - How can I let a disabled Batch job start running new tasks again?
      - What state does a Batch job pass through after I re-enable it?
      instructions:
      - text: Enable Batch job {jobId} so its tasks can run again.
        slots:
          jobId: path.jobId
      - text: Turn disabled job {jobId} back on.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobId}/jobpreparationandreleasetaskstatus'].get
  update:
    x-apievangelist-phrasing:
      intent: Check job preparation and release task status
      effect: read
      questions:
      - Did the job preparation task succeed on every compute node my Batch job ran on?
      - Where can I see job release task results per node for a Batch job?
      instructions:
      - text: Show the job preparation and release task status on each node for job {jobId}.
        slots:
          jobId: path.jobId
      - text: List preparation and release task results for job {jobId} filtered by {filter}.
        slots:
          jobId: path.jobId
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobId}/taskcounts'].get
  update:
    x-apievangelist-phrasing:
      intent: Count a Batch job's tasks by state
      effect: read
      questions:
      - How many tasks in my Batch job are active, running or completed?
      - Can I quickly see how many tasks in a Batch job succeeded versus failed?
      instructions:
      - text: Give me the task counts by state for Batch job {jobId}.
        slots:
          jobId: path.jobId
      - text: Count succeeded and failed tasks in job {jobId}.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobId}/tasks'].get
  update:
    x-apievangelist-phrasing:
      intent: List the tasks in a Batch job
      effect: read
      questions:
      - Which tasks belong to my Batch job and what state is each in?
      - Can I filter the tasks of a Batch job, for example to only failed ones?
      instructions:
      - text: List all tasks in Batch job {jobId}.
        slots:
          jobId: path.jobId
      - text: List tasks in job {jobId} matching {filter}.
        slots:
          jobId: path.jobId
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobId}/tasks'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a single task to a Batch job
      effect: write
      questions:
      - How do I add one task with a command line to an existing Batch job?
      - How long can a Batch task live before it is automatically terminated?
      instructions:
      - text: Add task {id} to job {jobId} running the command {commandLine}.
        slots:
          id: requestBody.id
          jobId: path.jobId
          commandLine: requestBody.commandLine
      - text: Create task {id} in Batch job {jobId} that runs {commandLine} and needs {requiredSlots} slots.
        slots:
          id: requestBody.id
          jobId: path.jobId
          commandLine: requestBody.commandLine
          requiredSlots: requestBody.requiredSlots
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobId}/tasks/{taskId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one Batch task
      effect: read
      questions:
      - What is the exit code and execution info of a specific Batch task?
      - Which compute node did a particular Batch task run on?
      instructions:
      - text: Show me task {taskId} in Batch job {jobId}.
        slots:
          taskId: path.taskId
          jobId: path.jobId
      - text: Get the state and node info of task {taskId} in job {jobId}.
        slots:
          taskId: path.taskId
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobId}/tasks/{taskId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update the properties of a Batch task
      effect: write
      questions:
      - Can I change the constraints, like max retry count, of a Batch task that already exists?
      - Is there a way to update a single task in a Batch job after it was added?
      instructions:
      - text: Update task {taskId} in job {jobId} with the constraints {constraints}.
        slots:
          taskId: path.taskId
          jobId: path.jobId
          constraints: requestBody.constraints
      - text: Change the properties of existing task {taskId} in Batch job {jobId}.
        slots:
          taskId: path.taskId
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobId}/tasks/{taskId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a task from a Batch job
      effect: destructive
      questions:
      - Does deleting a Batch task also delete the files in its directory on the node?
      - Can I remove one task from a job without deleting the whole Batch job?
      instructions:
      - text: Delete task {taskId} from Batch job {jobId}.
        slots:
          taskId: path.taskId
          jobId: path.jobId
      - text: Remove task {taskId} and its node files from job {jobId}.
        slots:
          taskId: path.taskId
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobId}/tasks/{taskId}/files'].get
  update:
    x-apievangelist-phrasing:
      intent: List files in a Batch task's directory
      effect: read
      questions:
      - What files did my Batch task leave in its working directory on the node?
      - Can I list a Batch task's files recursively including subfolders?
      instructions:
      - text: List the files in the directory of task {taskId} in job {jobId}.
        slots:
          taskId: path.taskId
          jobId: path.jobId
      - text: Recursively list files for task {taskId} in job {jobId} (recursive={recursive}).
        slots:
          taskId: path.taskId
          jobId: path.jobId
          recursive: query.recursive
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobId}/tasks/{taskId}/files/{filePath}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the content of a Batch task file
      effect: read
      questions:
      - How do I read the stdout.txt file a Batch task wrote on its compute node?
      - Can I fetch only a byte range of a Batch task's output file?
      instructions:
      - text: Download file {filePath} from task {taskId} in job {jobId}.
        slots:
          filePath: path.filePath
          taskId: path.taskId
          jobId: path.jobId
      - text: Read bytes {range} of file {filePath} from task {taskId} in job {jobId}.
        slots:
          range: header.ocp-range
          filePath: path.filePath
          taskId: path.taskId
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobId}/tasks/{taskId}/files/{filePath}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a file from a Batch task's node
      effect: destructive
      questions:
      - Can I delete a single output file a Batch task left on its compute node?
      - Is it possible to delete a whole task directory and its contents on the node?
      instructions:
      - text: Delete file {filePath} of task {taskId} in job {jobId} from the node.
        slots:
          filePath: path.filePath
          taskId: path.taskId
          jobId: path.jobId
      - text: Delete directory {filePath} recursively ({recursive}) for task {taskId} in job {jobId}.
        slots:
          filePath: path.filePath
          recursive: query.recursive
          taskId: path.taskId
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobId}/tasks/{taskId}/files/{filePath}'].head
  update:
    x-apievangelist-phrasing:
      intent: Get size and metadata of a Batch task file
      effect: read
      questions:
      - How big is a Batch task's output file before I download it?
      - Can I check when a task file was last modified without fetching its content?
      instructions:
      - text: Get the properties of file {filePath} for task {taskId} in job {jobId} without downloading it.
        slots:
          filePath: path.filePath
          taskId: path.taskId
          jobId: path.jobId
      - text: Check the size of task file {filePath} in task {taskId} of job {jobId}.
        slots:
          filePath: path.filePath
          taskId: path.taskId
          jobId: 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:
      - Can a Batch task that exhausted its retries be made eligible to run again?
      - What happens to a Batch task's state when I reactivate it?
      instructions:
      - text: Reactivate task {taskId} in job {jobId} so it can retry.
        slots:
          taskId: path.taskId
          jobId: path.jobId
      - text: Give failed task {taskId} in Batch job {jobId} another round of retries.
        slots:
          taskId: path.taskId
          jobId: 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:
      - Where can I see the subtasks of a multi-instance (MPI) Batch task?
      - Why does listing subtasks return nothing for a normal Batch task?
      instructions:
      - text: List the subtasks of multi-instance task {taskId} in job {jobId}.
        slots:
          taskId: path.taskId
          jobId: path.jobId
      - text: Show subtask status for MPI task {taskId} in job {jobId}.
        slots:
          taskId: path.taskId
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobId}/tasks/{taskId}/terminate'].post
  update:
    x-apievangelist-phrasing:
      intent: Terminate a running Batch task
      effect: destructive
      questions:
      - How can I kill a Batch task that is stuck running?
      - Does terminating a multi-instance task stop all its subtasks too?
      instructions:
      - text: Terminate task {taskId} in job {jobId}.
        slots:
          taskId: path.taskId
          jobId: path.jobId
      - text: Stop running Batch task {taskId} of job {jobId} and mark it completed.
        slots:
          taskId: path.taskId
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobId}/terminate'].post
  update:
    x-apievangelist-phrasing:
      intent: Terminate a Batch job and mark it completed
      effect: destructive
      questions:
      - How do I end a Batch job early and terminate all its running tasks?
      - Can I record a reason when terminating a Batch job?
      instructions:
      - text: Terminate Batch job {jobId}.
        slots:
          jobId: path.jobId
      - text: Terminate job {jobId} with the reason {terminateReason}.
        slots:
          jobId: path.jobId
          terminateReason: requestBody.terminateReason
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobId}/devices'].get
  update:
    x-apievangelist-phrasing:
      intent: Get per-device statuses for a device job
      effect: read
      questions:
      - Which devices succeeded or failed in a device job I ran?
      - Can I see the individual device statuses for a job by its ID?
      instructions:
      - text: List the device statuses for device job {jobId}.
        slots:
          jobId: path.jobId
      - text: Show which devices failed in job {jobId}.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobId}/rerun/{rerunId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rerun a device job on its failed devices
      effect: write
      questions:
      - Can I retry a device job only on the devices where it failed?
      - How do I trigger a rerun of an existing device job?
      instructions:
      - text: Rerun device job {jobId} on its failed devices as rerun {rerunId}.
        slots:
          jobId: path.jobId
          rerunId: path.rerunId
      - text: Start rerun {rerunId} for the failed devices of job {jobId}.
        slots:
          rerunId: path.rerunId
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobId}/resume'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume a stopped device job
      effect: write
      questions:
      - How can I continue a device job that I stopped earlier?
      - Is it possible to resume execution of a stopped job across my devices?
      instructions:
      - text: Resume stopped device job {jobId}.
        slots:
          jobId: path.jobId
      - text: Restart execution of the device job {jobId} that I paused.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobId}/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop a running device job
      effect: write
      questions:
      - Can I halt a device job that is currently running?
      - What stops a device job mid-execution so I can resume it later?
      instructions:
      - text: Stop running device job {jobId}.
        slots:
          jobId: path.jobId
      - text: Halt execution of job {jobId} on my devices for now.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lifetimejobstats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get lifetime statistics for all Batch jobs
      effect: read
      questions:
      - What are the aggregate statistics across every job that has ever run in my Batch account?
      - Can I see total CPU time and task counts for all Batch jobs since the account was created?
      instructions:
      - text: Get lifetime summary statistics for all jobs in my Batch account.
      - text: Show account-wide job stats since creation, waiting at most {timeout} seconds.
        slots:
          timeout: query.timeout
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobschedules/{jobScheduleId}/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List jobs created by a Batch job schedule
      effect: read
      questions:
      - Which jobs has my Batch job schedule created so far?
      - Can I filter the jobs spawned by a recurring job schedule?
      instructions:
      - text: List the jobs created under job schedule {jobScheduleId}.
        slots:
          jobScheduleId: path.jobScheduleId
      - text: List jobs from schedule {jobScheduleId} matching {filter}.
        slots:
          jobScheduleId: path.jobScheduleId
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/jobs/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a job on a Data Box Edge or Gateway device
      effect: read
      questions:
      - What is the status of a job running on my Data Box Edge device?
      - Can I look up a specific job on a Data Box Gateway device by name?
      instructions:
      - text: Get job {name} on Data Box Edge device {deviceName} in resource group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          name: path.name
          deviceName: path.deviceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show the details of edge device job {name} on {deviceName}.
        slots:
          name: path.name
          deviceName: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.DataBox/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List all Data Box orders in a subscription
      effect: read
      questions:
      - What Data Box jobs do I have across my whole subscription?
      - Can I see every Data Box order I've placed regardless of resource group?
      instructions:
      - text: List all Data Box jobs in subscription {subscriptionId}.
        slots:
          subscriptionId: path.subscriptionId
      - text: Get the next page of subscription Data Box jobs using skip token {skipToken}.
        slots:
          skipToken: query.$skipToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/mitigate'].post
  update:
    x-apievangelist-phrasing:
      intent: Request mitigation for a Data Box job
      effect: write
      questions:
      - How do I tell Azure how to resolve a problem with my Data Box order?
      - Can I give a customer resolution code for specific device serial numbers on a Data Box job?
      instructions:
      - text: Mitigate Data Box job {jobName} in {resourceGroupName} (subscription {subscriptionId}) with resolution code {customerResolutionCode}.
        slots:
          jobName: path.jobName
          resourceGroupName: path.resourceGroupName
          customerResolutionCode: requestBody.customerResolutionCode
          subscriptionId: path.subscriptionId
      - text: Apply per-device resolutions {serialNumberCustomerResolutionMap} to Data Box job {jobName}.
        slots:
          serialNumberCustomerResolutionMap: requestBody.serialNumberCustomerResolutionMap
          jobName: path.jobName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/markDevicesShipped'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark Data Box devices as shipped
      effect: write
      questions:
      - How do I let Azure know I've shipped my Data Box devices back to the datacenter?
      - What package details do I provide when marking Data Box devices as shipped?
      instructions:
      - text: Mark Data Box job {jobName} in {resourceGroupName}, subscription {subscriptionId}, as shipped with package details {deliverToDcPackageDetails}.
        slots:
          jobName: path.jobName
          resourceGroupName: path.resourceGroupName
          deliverToDcPackageDetails: requestBody.deliverToDcPackageDetails
          subscriptionId: path.subscriptionId
      - text: Record that I shipped the Data Box for job {jobName} using {deliverToDcPackageDetails}.
        slots:
          jobName: path.jobName
          deliverToDcPackageDetails: requestBody.deliverToDcPackageDetails
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List Data Box orders in a resource group
      effect: read
      questions:
      - Which Data Box jobs are in a particular resource group?
      - Can I page through Data Box orders scoped to one resource group?
      instructions:
      - text: List Data Box jobs in resource group {resourceGroupName} of subscription {subscriptionId}.
        slots:
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Continue listing Data Box jobs in {resourceGroupName} from token {skipToken}.
        slots:
          resourceGroupName: path.resourceGroupName
          skipToken: query.$skipToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Data Box order's details
      effect: read
      questions:
      - Where is my Data Box order in its lifecycle right now?
      - Can I check the shipping and status details of one Data Box job?
      instructions:
      - text: Get Data Box job {jobName} in resource group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          jobName: path.jobName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show the current status of my Data Box order {jobName}.
        slots:
          jobName: path.jobName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Order a new Data Box job
      effect: write
      questions:
      - How do I order a Data Box to move data into Azure?
      - Which SKU and location do I need to specify when creating a Data Box job?
      - Can I update an existing Data Box job with the create call?
      instructions:
      - text: Create Data Box job {jobName} in {resourceGroupName}, subscription {subscriptionId}, at {location} with SKU {sku}.
        slots:
          jobName: path.jobName
          resourceGroupName: path.resourceGroupName
          location: requestBody.location
          sku: requestBody.sku
          subscriptionId: path.subscriptionId
      - text: Order a Data Box as job {jobName} using the job details {properties}, SKU {sku} and location {location}.
        slots:
          jobName: path.jobName
          properties: requestBody.properties
          sku: requestBody.sku
          location: requestBody.location
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Data Box order
      effect: destructive
      questions:
      - Can I delete a Data Box job record I no longer need?
      - How do I remove a completed Data Box order from my resource group?
      instructions:
      - text: Delete Data Box job {jobName} in resource group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          jobName: path.jobName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Remove my Data Box order {jobName}.
        slots:
          jobName: path.jobName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an existing Data Box order
      effect: write
      questions:
      - Can I change the details or tags on a Data Box job after I've ordered it?
      - Is there a way to update the managed identity on a Data Box order?
      instructions:
      - text: Update Data Box job {jobName} in {resourceGroupName}, subscription {subscriptionId}, with the new details {properties}.
        slots:
          jobName: path.jobName
          resourceGroupName: path.resourceGroupName
          properties: requestBody.properties
          subscriptionId: path.subscriptionId
      - text: Set tags {tags} on existing Data Box order {jobName}.
        slots:
          tags: requestBody.tags
          jobName: path.jobName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/bookShipmentPickUp'].post
  update:
    x-apievangelist-phrasing:
      intent: Book a courier pickup for a Data Box
      effect: write
      questions:
      - How do I schedule a courier to pick up my Data Box for return?
      - Can I pick a time window and location for the Data Box return pickup?
      instructions:
      - text: Book a pickup for Data Box job {jobName} ({resourceGroupName}, {subscriptionId}) between {startTime} and {endTime} at {shipmentLocation}.
        slots:
          jobName: path.jobName
          resourceGroupName: path.resourceGroupName
          startTime: requestBody.startTime
          endTime: requestBody.endTime
          shipmentLocation: requestBody.shipmentLocation
          subscriptionId: path.subscriptionId
      - text: Schedule the return shipment of Data Box {jobName} from {shipmentLocation}, window {startTime} to {endTime}.
        slots:
          jobName: path.jobName
          shipmentLocation: requestBody.shipmentLocation
          startTime: requestBody.startTime
          endTime: requestBody.endTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a Data Box order
      effect: destructive
      questions:
      - Can I cancel a Data Box order I placed by mistake?
      - Do I have to give a reason when cancelling a Data Box job?
      instructions:
      - text: Cancel Data Box job {jobName} in {resourceGroupName}, subscription {subscriptionId}, because {reason}.
        slots:
          jobName: path.jobName
          resourceGroupName: path.resourceGroupName
          reason: requestBody.reason
          subscriptionId: path.subscriptionId
      - text: Cancel my Data Box order {jobName} with the reason {reason}.
        slots:
          jobName: path.jobName
          reason: requestBody.reason
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/listCredentials'].post
  update:
    x-apievangelist-phrasing:
      intent: Get unlock credentials for a Data Box
      effect: read
      questions:
      - Where do I get the password to unlock my Data Box device?
      - Can I retrieve the unencrypted secrets for a Data Box job?
      instructions:
      - text: Get the credentials for Data Box job {jobName} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          jobName: path.jobName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show the device unlock secrets for Data Box order {jobName}.
        slots:
          jobName: path.jobName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobDefinitions/{jobDefinitionName}/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List data manager jobs for a job definition
      effect: read
      questions:
      - Which runs have happened for a particular hybrid data job definition?
      - Can I filter the jobs of a data manager job definition by status?
      instructions:
      - text: List jobs of definition {jobDefinitionName} in data service {dataServiceName} of data manager {dataManagerName} ({resourceGroupName}, {subscriptionId}).
        slots:
          jobDefinitionName: path.jobDefinitionName
          dataServiceName: path.dataServiceName
          dataManagerName: path.dataManagerName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: List runs of job definition {jobDefinitionName} on {dataServiceName} in {dataManagerName} matching {filter}.
        slots:
          jobDefinitionName: path.jobDefinitionName
          dataServiceName: path.dataServiceName
          dataManagerName: path.dataManagerName
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobDefinitions/{jobDefinitionName}/jobs/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one hybrid data manager job run
      effect: read
      questions:
      - What happened in a specific run of my hybrid data manager job?
      - Can I look up a data manager job by its job ID?
      instructions:
      - text: Get data manager job {jobId} of definition {jobDefinitionName} on {dataServiceName} in {dataManagerName} ({resourceGroupName}, {subscriptionId}).
        slots:
          jobId: path.jobId
          jobDefinitionName: path.jobDefinitionName
          dataServiceName: path.dataServiceName
          dataManagerName: path.dataManagerName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show hybrid data job run {jobId} under definition {jobDefinitionName}.
        slots:
          jobId: path.jobId
          jobDefinitionName: path.jobDefinitionName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobDefinitions/{jobDefinitionName}/jobs/{jobId}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a hybrid data manager job run
      effect: destructive
      questions:
      - Can I cancel a data manager job run that's in progress?
      - How do I stop a hybrid data transfer job for good?
      instructions:
      - text: Cancel data manager job {jobId} of definition {jobDefinitionName} on {dataServiceName} in {dataManagerName} ({resourceGroupName}, {subscriptionId}).
        slots:
          jobId: path.jobId
          jobDefinitionName: path.jobDefinitionName
          dataServiceName: path.dataServiceName
          dataManagerName: path.dataManagerName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Cancel hybrid data job run {jobId} under definition {jobDefinitionName}.
        slots:
          jobId: path.jobId
          jobDefinitionName: path.jobDefinitionName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobDefinitions/{jobDefinitionName}/jobs/{jobId}/resume'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume a hybrid data manager job run
      effect: write
      questions:
      - Can a paused data manager job run be resumed?
      - Is there a way to continue a hybrid data transfer job from where it stopped?
      instructions:
      - text: Resume data manager job {jobId} of definition {jobDefinitionName} on {dataServiceName} in {dataManagerName} ({resourceGroupName}, {subscriptionId}).
        slots:
          jobId: path.jobId
          jobDefinitionName: path.jobDefinitionName
          dataServiceName: path.dataServiceName
          dataManagerName: path.dataManagerName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Resume hybrid data job run {jobId} under definition {jobDefinitionName}.
        slots:
          jobId: path.jobId
          jobDefinitionName: path.jobDefinitionName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List data manager jobs for a data service
      effect: read
      questions:
      - What jobs have run for a given data service in my hybrid data manager?
      - Can I see all jobs of one data service type regardless of job definition?
      instructions:
      - text: List jobs for data service {dataServiceName} in data manager {dataManagerName}, group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          dataServiceName: path.dataServiceName
          dataManagerName: path.dataManagerName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: List data service {dataServiceName} jobs in {dataManagerName} matching {filter}.
        slots:
          dataServiceName: path.dataServiceName
          dataManagerName: path.dataManagerName
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List all jobs in a hybrid data manager
      effect: read
      questions:
      - Which jobs exist across my entire hybrid data manager resource?
      - Can I filter every job at the data manager level in one call?
      instructions:
      - text: List all jobs in data manager {dataManagerName} in resource group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          dataManagerName: path.dataManagerName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: List data manager {dataManagerName} jobs matching {filter}.
        slots:
          dataManagerName: path.dataManagerName
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobsExport'].post
  update:
    x-apievangelist-phrasing:
      intent: Export backup jobs from a Recovery Services vault
      effect: read
      questions:
      - Can I export the backup jobs of my Recovery Services vault to a file?
      - How do I track an export of vault backup jobs that match a filter?
      instructions:
      - text: Export backup jobs from vault {vaultName} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          vaultName: path.vaultName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Export the backup jobs in vault {vaultName} matching {filter} and give me the operation ID.
        slots:
          vaultName: path.vaultName
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Scheduler job in a job collection
      effect: read
      questions:
      - What is the recurrence and action of a Scheduler job in my job collection?
      - Can I view one scheduled job's configuration by name?
      instructions:
      - text: Get Scheduler job {jobName} in job collection {jobCollectionName}, group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          jobName: path.jobName
          jobCollectionName: path.jobCollectionName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show scheduled job {jobName} from collection {jobCollectionName}.
        slots:
          jobName: path.jobName
          jobCollectionName: path.jobCollectionName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a Scheduler job
      effect: write
      questions:
      - How do I provision a new scheduled job inside a Scheduler job collection?
      - Can the same call both create and overwrite a Scheduler job?
      instructions:
      - text: Create Scheduler job {jobName} in {jobCollectionName} ({resourceGroupName}, {subscriptionId}) with settings {properties}.
        slots:
          jobName: path.jobName
          jobCollectionName: path.jobCollectionName
          resourceGroupName: path.resourceGroupName
          properties: requestBody.properties
          subscriptionId: path.subscriptionId
      - text: Provision or overwrite scheduled job {jobName} in {jobCollectionName}.
        slots:
          jobName: path.jobName
          jobCollectionName: path.jobCollectionName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Scheduler job
      effect: destructive
      questions:
      - How can I remove a scheduled job from my job collection?
      - Can I delete a single Scheduler job without deleting the collection?
      instructions:
      - text: Delete Scheduler job {jobName} from collection {jobCollectionName} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          jobName: path.jobName
          jobCollectionName: path.jobCollectionName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Remove scheduled job {jobName} from {jobCollectionName}.
        slots:
          jobName: path.jobName
          jobCollectionName: path.jobCollectionName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch an existing Scheduler job
      effect: write
      questions:
      - Can I change just part of a Scheduler job, like its state, without redefining it?
      - What lets me disable a scheduled job in place?
      instructions:
      - text: Patch Scheduler job {jobName} in {jobCollectionName} ({resourceGroupName}, {subscriptionId}) with {properties}.
        slots:
          jobName: path.jobName
          jobCollectionName: path.jobCollectionName
          resourceGroupName: path.resourceGroupName
          properties: requestBody.properties
          subscriptionId: path.subscriptionId
      - text: Partially update scheduled job {jobName} in {jobCollectionName}.
        slots:
          jobName: path.jobName
          jobCollectionName: path.jobCollectionName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a Scheduler job immediately
      effect: write
      questions:
      - Can I trigger a scheduled job right now instead of waiting for its next occurrence?
      - How do I manually fire a Scheduler job?
      instructions:
      - text: Run Scheduler job {jobName} in collection {jobCollectionName}, group {resourceGroupName}, subscription {subscriptionId}, now.
        slots:
          jobName: path.jobName
          jobCollectionName: path.jobCollectionName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Fire scheduled job {jobName} from {jobCollectionName} immediately.
        slots:
          jobName: path.jobName
          jobCollectionName: path.jobCollectionName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List jobs in a Scheduler job collection
      effect: read
      questions:
      - Which scheduled jobs are defined in my Scheduler job collection?
      - Can I page through Scheduler jobs with top and skip?
      instructions:
      - text: List all jobs in Scheduler collection {jobCollectionName}, group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          jobCollectionName: path.jobCollectionName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: List the first {top} jobs in collection {jobCollectionName} matching {filter}.
        slots:
          top: query.$top
          jobCollectionName: path.jobCollectionName
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}/history'].get
  update:
    x-apievangelist-phrasing:
      intent: List execution history of a Scheduler job
      effect: read
      questions:
      - When did my scheduled job last run and did it succeed?
      - Can I filter a Scheduler job's run history to failures only?
      instructions:
      - text: Show the history of Scheduler job {jobName} in {jobCollectionName}, group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          jobName: path.jobName
          jobCollectionName: path.jobCollectionName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: List the last {top} runs of scheduled job {jobName} in {jobCollectionName} matching {filter}.
        slots:
          top: query.$top
          jobName: path.jobName
          jobCollectionName: path.jobCollectionName
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List jobs on a StorSimple device
      effect: read
      questions:
      - What jobs have run on one of my StorSimple devices?
      - Can I filter StorSimple device jobs with OData, for example by status?
      instructions:
      - text: List jobs on StorSimple device {deviceName} under manager {managerName} ({resourceGroupName}, {subscriptionId}).
        slots:
          deviceName: path.deviceName
          managerName: path.managerName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: List StorSimple jobs on device {deviceName} in {managerName} matching {filter}.
        slots:
          deviceName: path.deviceName
          managerName: path.managerName
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/jobs/{jobName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a job on a StorSimple device
      effect: read
      questions:
      - What are the details of a specific job on my StorSimple device?
      - Can I check progress of one StorSimple backup job by name?
      instructions:
      - text: Get job {jobName} on StorSimple device {deviceName} under manager {managerName} ({resourceGroupName}, {subscriptionId}).
        slots:
          jobName: path.jobName
          deviceName: path.deviceName
          managerName: path.managerName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show StorSimple job {jobName} on device {deviceName}.
        slots:
          jobName: path.jobName
          deviceName: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/jobs/{jobName}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a job on a StorSimple device
      effect: destructive
      questions:
      - Can I cancel a job that is running on my StorSimple device?
      - What do I call to abort a StorSimple device job?
      instructions:
      - text: Cancel job {jobName} on StorSimple device {deviceName} under manager {managerName} ({resourceGroupName}, {subscriptionId}).
        slots:
          jobName: path.jobName
          deviceName: path.deviceName
          managerName: path.managerName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Abort StorSimple job {jobName} on device {deviceName}.
        slots:
          jobName: path.jobName
          deviceName: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List all jobs under a StorSimple manager
      effect: read
      questions:
      - Which jobs have run across all devices in my StorSimple manager?
      - Can I filter every job of a StorSimple manager in a single query?
      instructions:
      - text: List all jobs for StorSimple manager {managerName} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          managerName: path.managerName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: List StorSimple manager {managerName} jobs matching {filter}.
        slots:
          managerName: path.managerName
          filter: query.$filter
      method: generated
      generated: '2026-09-26'