batchservice

name	batchservice
description	BatchService API skill. Use when working with BatchService for applications, poolusagemetrics, supportedimages. Covers 76 endpoints.
version	1.0.0
generator	lapsh

BatchService

API version: 2019-08-01.10.0

Auth

OAuth2 | ApiKey Authorization in header

Base URL

Not specified.

Setup

1. Set your API key in the appropriate header
2. GET /applications -- verify access
3. POST /certificates -- create first certificates

Endpoints

76 endpoints across 11 groups. See references/api-spec.lap for full details.

applications

Method	Path	Description
GET	/applications	Lists all of the applications available in the specified Account.
GET	/applications/{applicationId}	Gets information about the specified Application.

poolusagemetrics

Method	Path	Description
GET	/poolusagemetrics	Lists the usage metrics, aggregated by Pool across individual time intervals, for the specified Account.

supportedimages

Method	Path	Description
GET	/supportedimages	Lists all Virtual Machine Images supported by the Azure Batch service.

nodecounts

Method	Path	Description
GET	/nodecounts	Gets the number of Compute Nodes in each state, grouped by Pool.

lifetimepoolstats

Method	Path	Description
GET	/lifetimepoolstats	Gets lifetime summary statistics for all of the Pools in the specified Account.

lifetimejobstats

Method	Path	Description
GET	/lifetimejobstats	Gets lifetime summary statistics for all of the Jobs in the specified Account.

certificates

Method	Path	Description
POST	/certificates	Adds a Certificate to the specified Account.
GET	/certificates	Lists all of the Certificates that have been added to the specified Account.

certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})

Method	Path	Description
POST	/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})/canceldelete	Cancels a failed deletion of a Certificate from the specified Account.
DELETE	/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})	Deletes a Certificate from the specified Account.
GET	/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})	Gets information about the specified Certificate.

jobs

Method	Path	Description
DELETE	/jobs/{jobId}/tasks/{taskId}/files/{filePath}	Deletes the specified Task file from the Compute Node where the Task ran.
GET	/jobs/{jobId}/tasks/{taskId}/files/{filePath}	Returns the content of the specified Task file.
HEAD	/jobs/{jobId}/tasks/{taskId}/files/{filePath}	Gets the properties of the specified Task file.
GET	/jobs/{jobId}/tasks/{taskId}/files	Lists the files in a Task's directory on its Compute Node.
DELETE	/jobs/{jobId}	Deletes a Job.
GET	/jobs/{jobId}	Gets information about the specified Job.
PATCH	/jobs/{jobId}	Updates the properties of the specified Job.
PUT	/jobs/{jobId}	Updates the properties of the specified Job.
POST	/jobs/{jobId}/disable	Disables the specified Job, preventing new Tasks from running.
POST	/jobs/{jobId}/enable	Enables the specified Job, allowing new Tasks to run.
POST	/jobs/{jobId}/terminate	Terminates the specified Job, marking it as completed.
POST	/jobs	Adds a Job to the specified Account.
GET	/jobs	Lists all of the Jobs in the specified Account.
GET	/jobs/{jobId}/jobpreparationandreleasetaskstatus	Lists the execution status of the Job Preparation and Job Release Task for the specified Job across the Compute Nodes where the Job has run.
GET	/jobs/{jobId}/taskcounts	Gets the Task counts for the specified Job.
POST	/jobs/{jobId}/tasks	Adds a Task to the specified Job.
GET	/jobs/{jobId}/tasks	Lists all of the Tasks that are associated with the specified Job.
POST	/jobs/{jobId}/addtaskcollection	Adds a collection of Tasks to the specified Job.
DELETE	/jobs/{jobId}/tasks/{taskId}	Deletes a Task from the specified Job.
GET

pools

Method	Path	Description
DELETE	/pools/{poolId}/nodes/{nodeId}/files/{filePath}	Deletes the specified file from the Compute Node.
GET	/pools/{poolId}/nodes/{nodeId}/files/{filePath}	Returns the content of the specified Compute Node file.
HEAD	/pools/{poolId}/nodes/{nodeId}/files/{filePath}	Gets the properties of the specified Compute Node file.
GET	/pools/{poolId}/nodes/{nodeId}/files	Lists all of the files in Task directories on the specified Compute Node.
POST	/pools	Adds a Pool to the specified Account.
GET	/pools	Lists all of the Pools in the specified Account.
DELETE	/pools/{poolId}	Deletes a Pool from the specified Account.
HEAD	/pools/{poolId}	Gets basic properties of a Pool.
GET	/pools/{poolId}	Gets information about the specified Pool.
PATCH	/pools/{poolId}	Updates the properties of the specified Pool.
POST	/pools/{poolId}/disableautoscale	Disables automatic scaling for a Pool.
POST	/pools/{poolId}/enableautoscale	Enables automatic scaling for a Pool.
POST	/pools/{poolId}/evaluateautoscale	Gets the result of evaluating an automatic scaling formula on the Pool.
POST	/pools/{poolId}/resize	Changes the number of Compute Nodes that are assigned to a Pool.
POST	/pools/{poolId}/stopresize	Stops an ongoing resize operation on the Pool.
POST	/pools/{poolId}/updateproperties	Updates the properties of the specified Pool.
POST	/pools/{poolId}/removenodes	Removes Compute Nodes from the specified Pool.
POST	/pools/{poolId}/nodes/{nodeId}/users	Adds a user Account to the specified Compute Node.
DELETE	/pools/{poolId}/nodes/{nodeId}/users/{userName}	Deletes a user Account from the specified Compute Node.
PUT

jobschedules

Method	Path	Description
HEAD	/jobschedules/{jobScheduleId}	Checks the specified Job Schedule exists.
DELETE	/jobschedules/{jobScheduleId}	Deletes a Job Schedule from the specified Account.
GET	/jobschedules/{jobScheduleId}	Gets information about the specified Job Schedule.
PATCH	/jobschedules/{jobScheduleId}	Updates the properties of the specified Job Schedule.
PUT	/jobschedules/{jobScheduleId}	Updates the properties of the specified Job Schedule.
POST	/jobschedules/{jobScheduleId}/disable	Disables a Job Schedule.
POST	/jobschedules/{jobScheduleId}/enable	Enables a Job Schedule.
POST	/jobschedules/{jobScheduleId}/terminate	Terminates a Job Schedule.
POST	/jobschedules	Adds a Job Schedule to the specified Account.
GET	/jobschedules	Lists all of the Job Schedules in the specified Account.
GET	/jobschedules/{jobScheduleId}/jobs	Lists the Jobs that have been created under the specified Job Schedule.

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "List all applications?" -> GET /applications
• "Get application details?" -> GET /applications/{applicationId}
• "List all poolusagemetrics?" -> GET /poolusagemetrics
• "List all supportedimages?" -> GET /supportedimages
• "List all nodecounts?" -> GET /nodecounts
• "List all lifetimepoolstats?" -> GET /lifetimepoolstats
• "List all lifetimejobstats?" -> GET /lifetimejobstats
• "Create a certificate?" -> POST /certificates
• "List all certificates?" -> GET /certificates
• "Create a canceldelete?" -> POST /certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})/canceldelete
• "Delete a certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})?" -> DELETE /certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})
• "Get certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint}) details?" -> GET /certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})
• "Delete a file?" -> DELETE /jobs/{jobId}/tasks/{taskId}/files/{filePath}
• "Get file details?" -> GET /jobs/{jobId}/tasks/{taskId}/files/{filePath}
• "Delete a file?" -> DELETE /pools/{poolId}/nodes/{nodeId}/files/{filePath}
• "Get file details?" -> GET /pools/{poolId}/nodes/{nodeId}/files/{filePath}
• "List all files?" -> GET /jobs/{jobId}/tasks/{taskId}/files
• "List all files?" -> GET /pools/{poolId}/nodes/{nodeId}/files
• "Delete a jobschedule?" -> DELETE /jobschedules/{jobScheduleId}
• "Get jobschedule details?" -> GET /jobschedules/{jobScheduleId}
• "Partially update a jobschedule?" -> PATCH /jobschedules/{jobScheduleId}
• "Update a jobschedule?" -> PUT /jobschedules/{jobScheduleId}
• "Create a disable?" -> POST /jobschedules/{jobScheduleId}/disable
• "Create a enable?" -> POST /jobschedules/{jobScheduleId}/enable
• "Create a terminate?" -> POST /jobschedules/{jobScheduleId}/terminate
• "Create a jobschedule?" -> POST /jobschedules
• "List all jobschedules?" -> GET /jobschedules
• "Delete a job?" -> DELETE /jobs/{jobId}
• "Get job details?" -> GET /jobs/{jobId}
• "Partially update a job?" -> PATCH /jobs/{jobId}
• "Update a job?" -> PUT /jobs/{jobId}
• "Create a disable?" -> POST /jobs/{jobId}/disable
• "Create a enable?" -> POST /jobs/{jobId}/enable
• "Create a terminate?" -> POST /jobs/{jobId}/terminate
• "Create a job?" -> POST /jobs
• "List all jobs?" -> GET /jobs
• "List all jobs?" -> GET /jobschedules/{jobScheduleId}/jobs

Response Tips

• Check response schemas in references/api-spec.lap for field details
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP