@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api BatchService
@version 2019-08-01.10.0
@auth OAuth2 | ApiKey Authorization in header
@common_fields {api-version: any, timeout: any, client-request-id: any, return-client-request-id: any, ocp-date: any}
@endpoints 76
@hint download_for_search
@toc applications(2), poolusagemetrics(1), supportedimages(1), nodecounts(1), lifetimepoolstats(1), lifetimejobstats(1), certificates(2), certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})(3), jobs(24), pools(29), jobschedules(11)

@group applications
@endpoint GET /applications
@optional {maxresults: any}
@returns(200)

@endpoint GET /applications/{applicationId}
@required {applicationId: any}
@returns(200)

@endgroup

@group poolusagemetrics
@endpoint GET /poolusagemetrics
@optional {starttime: any, endtime: any, $filter: any, maxresults: any}
@returns(200)

@endgroup

@group supportedimages
@endpoint GET /supportedimages
@optional {$filter: any, maxresults: any}
@returns(200)

@endgroup

@group nodecounts
@endpoint GET /nodecounts
@optional {$filter: any, maxresults: any}
@returns(200)

@endgroup

@group lifetimepoolstats
@endpoint GET /lifetimepoolstats
@returns(200)

@endgroup

@group lifetimejobstats
@endpoint GET /lifetimejobstats
@returns(200)

@endgroup

@group certificates
@endpoint POST /certificates
@required {certificate: any}
@returns(201)

@endpoint GET /certificates
@optional {$filter: any, $select: any, maxresults: any}
@returns(200)

@endgroup

@group certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})
@endpoint POST /certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})/canceldelete
@required {thumbprintAlgorithm: any, thumbprint: any}
@returns(204)

@endpoint DELETE /certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})
@required {thumbprintAlgorithm: any, thumbprint: any}
@returns(202)

@endpoint GET /certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})
@required {thumbprintAlgorithm: any, thumbprint: any}
@optional {$select: any}
@returns(200)

@endgroup

@group jobs
@endpoint DELETE /jobs/{jobId}/tasks/{taskId}/files/{filePath}
@required {jobId: any, taskId: any, filePath: any}
@optional {recursive: any}
@returns(200)

@endpoint GET /jobs/{jobId}/tasks/{taskId}/files/{filePath}
@required {jobId: any, taskId: any, filePath: any}
@optional {ocp-range: any, If-Modified-Since: any, If-Unmodified-Since: any}
@returns(200)

@endpoint HEAD /jobs/{jobId}/tasks/{taskId}/files/{filePath}
@required {jobId: any, taskId: any, filePath: any}
@optional {If-Modified-Since: any, If-Unmodified-Since: any}
@returns(200)

@endgroup

@group pools
@endpoint DELETE /pools/{poolId}/nodes/{nodeId}/files/{filePath}
@required {poolId: any, nodeId: any, filePath: any}
@optional {recursive: any}
@returns(200)

@endpoint GET /pools/{poolId}/nodes/{nodeId}/files/{filePath}
@required {poolId: any, nodeId: any, filePath: any}
@optional {ocp-range: any, If-Modified-Since: any, If-Unmodified-Since: any}
@returns(200)

@endpoint HEAD /pools/{poolId}/nodes/{nodeId}/files/{filePath}
@required {poolId: any, nodeId: any, filePath: any}
@optional {If-Modified-Since: any, If-Unmodified-Since: any}
@returns(200)

@endgroup

@group jobs
@endpoint GET /jobs/{jobId}/tasks/{taskId}/files
@required {jobId: any, taskId: any}
@optional {$filter: any, recursive: any, maxresults: any}
@returns(200)

@endgroup

@group pools
@endpoint GET /pools/{poolId}/nodes/{nodeId}/files
@required {poolId: any, nodeId: any}
@optional {$filter: any, recursive: any, maxresults: any}
@returns(200)

@endgroup

@group jobschedules
@endpoint HEAD /jobschedules/{jobScheduleId}
@required {jobScheduleId: any}
@optional {If-Match: any, If-None-Match: any, If-Modified-Since: any, If-Unmodified-Since: any}
@returns(200)
@errors {404}

@endpoint DELETE /jobschedules/{jobScheduleId}
@required {jobScheduleId: any}
@optional {If-Match: any, If-None-Match: any, If-Modified-Since: any, If-Unmodified-Since: any}
@returns(202)

@endpoint GET /jobschedules/{jobScheduleId}
@required {jobScheduleId: any}
@optional {$select: any, $expand: any, If-Match: any, If-None-Match: any, If-Modified-Since: any, If-Unmodified-Since: any}
@returns(200)

@endpoint PATCH /jobschedules/{jobScheduleId}
@required {jobScheduleId: any, jobSchedulePatchParameter: any}
@optional {If-Match: any, If-None-Match: any, If-Modified-Since: any, If-Unmodified-Since: any}
@returns(200)

@endpoint PUT /jobschedules/{jobScheduleId}
@required {jobScheduleId: any, jobScheduleUpdateParameter: any}
@optional {If-Match: any, If-None-Match: any, If-Modified-Since: any, If-Unmodified-Since: any}
@returns(200)

@endpoint POST /jobschedules/{jobScheduleId}/disable
@required {jobScheduleId: any}
@optional {If-Match: any, If-None-Match: any, If-Modified-Since: any, If-Unmodified-Since: any}
@returns(204)

@endpoint POST /jobschedules/{jobScheduleId}/enable
@required {jobScheduleId: any}
@optional {If-Match: any, If-None-Match: any, If-Modified-Since: any, If-Unmodified-Since: any}
@returns(204)

@endpoint POST /jobschedules/{jobScheduleId}/terminate
@required {jobScheduleId: any}
@optional {If-Match: any, If-None-Match: any, If-Modified-Since: any, If-Unmodified-Since: any}
@returns(202)

@endpoint POST /jobschedules
@required {cloudJobSchedule: any}
@returns(201)

@endpoint GET /jobschedules
@optional {$filter: any, $select: any, $expand: any, maxresults: any}
@returns(200)

@endgroup

@group jobs
@endpoint DELETE /jobs/{jobId}
@required {jobId: any}
@optional {If-Match: any, If-None-Match: any, If-Modified-Since: any, If-Unmodified-Since: any}
@returns(202)

@endpoint GET /jobs/{jobId}
@required {jobId: any}
@optional {$select: any, $expand: any, If-Match: any, If-None-Match: any, If-Modified-Since: any, If-Unmodified-Since: any}
@returns(200)

@endpoint PATCH /jobs/{jobId}
@required {jobId: any, jobPatchParameter: any}
@optional {If-Match: any, If-None-Match: any, If-Modified-Since: any, If-Unmodified-Since: any}
@returns(200)

@endpoint PUT /jobs/{jobId}
@required {jobId: any, jobUpdateParameter: any}
@optional {If-Match: any, If-None-Match: any, If-Modified-Since: any, If-Unmodified-Since: any}
@returns(200)

@endpoint POST /jobs/{jobId}/disable
@required {jobId: any, jobDisableParameter: any}
@optional {If-Match: any, If-None-Match: any, If-Modified-Since: any, If-Unmodified-Since: any}
@returns(202)

@endpoint POST /jobs/{jobId}/enable
@required {jobId: any}
@optional {If-Match: any, If-None-Match: any, If-Modified-Since: any, If-Unmodified-Since: any}
@returns(202)

@endpoint POST /jobs/{jobId}/terminate
@required {jobId: any}
@optional {jobTerminateParameter: any, If-Match: any, If-None-Match: any, If-Modified-Since: any, If-Unmodified-Since: any}
@returns(202)

@endpoint POST /jobs
@required {job: any}
@returns(201)

@endpoint GET /jobs
@optional {$filter: any, $select: any, $expand: any, maxresults: any}
@returns(200)

@endgroup

@group jobschedules
@endpoint GET /jobschedules/{jobScheduleId}/jobs
@required {jobScheduleId: any}
@optional {$filter: any, $select: any, $expand: any, maxresults: any}
@returns(200)

@endgroup

@group jobs
@endpoint GET /jobs/{jobId}/jobpreparationandreleasetaskstatus
@required {jobId: any}
@optional {$filter: any, $select: any, maxresults: any}
@returns(200)

@endpoint GET /jobs/{jobId}/taskcounts
@required {jobId: any}
@returns(200)

@endgroup

@group pools
@endpoint POST /pools
@required {pool: any}
@returns(201)

@endpoint GET /pools
@optional {$filter: any, $select: any, $expand: any, maxresults: any}
@returns(200)

@endpoint DELETE /pools/{poolId}
@required {poolId: any}
@optional {If-Match: any, If-None-Match: any, If-Modified-Since: any, If-Unmodified-Since: any}
@returns(202)

@endpoint HEAD /pools/{poolId}
@required {poolId: any}
@optional {If-Match: any, If-None-Match: any, If-Modified-Since: any, If-Unmodified-Since: any}
@returns(200)
@errors {404}

@endpoint GET /pools/{poolId}
@required {poolId: any}
@optional {$select: any, $expand: any, If-Match: any, If-None-Match: any, If-Modified-Since: any, If-Unmodified-Since: any}
@returns(200)

@endpoint PATCH /pools/{poolId}
@required {poolId: any, poolPatchParameter: any}
@optional {If-Match: any, If-None-Match: any, If-Modified-Since: any, If-Unmodified-Since: any}
@returns(200)

@endpoint POST /pools/{poolId}/disableautoscale
@required {poolId: any}
@returns(200)

@endpoint POST /pools/{poolId}/enableautoscale
@required {poolId: any, poolEnableAutoScaleParameter: any}
@optional {If-Match: any, If-None-Match: any, If-Modified-Since: any, If-Unmodified-Since: any}
@returns(200)

@endpoint POST /pools/{poolId}/evaluateautoscale
@required {poolId: any, poolEvaluateAutoScaleParameter: any}
@returns(200)

@endpoint POST /pools/{poolId}/resize
@required {poolId: any, poolResizeParameter: any}
@optional {If-Match: any, If-None-Match: any, If-Modified-Since: any, If-Unmodified-Since: any}
@returns(202)

@endpoint POST /pools/{poolId}/stopresize
@required {poolId: any}
@optional {If-Match: any, If-None-Match: any, If-Modified-Since: any, If-Unmodified-Since: any}
@returns(202)

@endpoint POST /pools/{poolId}/updateproperties
@required {poolId: any, poolUpdatePropertiesParameter: any}
@returns(204)

@endpoint POST /pools/{poolId}/removenodes
@required {poolId: any, nodeRemoveParameter: any}
@optional {If-Match: any, If-None-Match: any, If-Modified-Since: any, If-Unmodified-Since: any}
@returns(202)

@endgroup

@group jobs
@endpoint POST /jobs/{jobId}/tasks
@required {jobId: any, task: any}
@returns(201)

@endpoint GET /jobs/{jobId}/tasks
@required {jobId: any}
@optional {$filter: any, $select: any, $expand: any, maxresults: any}
@returns(200)

@endpoint POST /jobs/{jobId}/addtaskcollection
@required {jobId: any, taskCollection: any}
@returns(200)

@endpoint DELETE /jobs/{jobId}/tasks/{taskId}
@required {jobId: any, taskId: any}
@optional {If-Match: any, If-None-Match: any, If-Modified-Since: any, If-Unmodified-Since: any}
@returns(200)

@endpoint GET /jobs/{jobId}/tasks/{taskId}
@required {jobId: any, taskId: any}
@optional {$select: any, $expand: any, If-Match: any, If-None-Match: any, If-Modified-Since: any, If-Unmodified-Since: any}
@returns(200)

@endpoint PUT /jobs/{jobId}/tasks/{taskId}
@required {jobId: any, taskId: any, taskUpdateParameter: any}
@optional {If-Match: any, If-None-Match: any, If-Modified-Since: any, If-Unmodified-Since: any}
@returns(200)

@endpoint GET /jobs/{jobId}/tasks/{taskId}/subtasksinfo
@required {jobId: any, taskId: any}
@optional {$select: any}
@returns(200)

@endpoint POST /jobs/{jobId}/tasks/{taskId}/terminate
@required {jobId: any, taskId: any}
@optional {If-Match: any, If-None-Match: any, If-Modified-Since: any, If-Unmodified-Since: any}
@returns(204)

@endpoint POST /jobs/{jobId}/tasks/{taskId}/reactivate
@required {jobId: any, taskId: any}
@optional {If-Match: any, If-None-Match: any, If-Modified-Since: any, If-Unmodified-Since: any}
@returns(204)

@endgroup

@group pools
@endpoint POST /pools/{poolId}/nodes/{nodeId}/users
@required {poolId: any, nodeId: any, user: any}
@returns(201)

@endpoint DELETE /pools/{poolId}/nodes/{nodeId}/users/{userName}
@required {poolId: any, nodeId: any, userName: any}
@returns(200)

@endpoint PUT /pools/{poolId}/nodes/{nodeId}/users/{userName}
@required {poolId: any, nodeId: any, userName: any, nodeUpdateUserParameter: any}
@returns(200)

@endpoint GET /pools/{poolId}/nodes/{nodeId}
@required {poolId: any, nodeId: any}
@optional {$select: any}
@returns(200)

@endpoint POST /pools/{poolId}/nodes/{nodeId}/reboot
@required {poolId: any, nodeId: any}
@optional {nodeRebootParameter: any}
@returns(202)

@endpoint POST /pools/{poolId}/nodes/{nodeId}/reimage
@required {poolId: any, nodeId: any}
@optional {nodeReimageParameter: any}
@returns(202)

@endpoint POST /pools/{poolId}/nodes/{nodeId}/disablescheduling
@required {poolId: any, nodeId: any}
@optional {nodeDisableSchedulingParameter: any}
@returns(200)

@endpoint POST /pools/{poolId}/nodes/{nodeId}/enablescheduling
@required {poolId: any, nodeId: any}
@returns(200)

@endpoint GET /pools/{poolId}/nodes/{nodeId}/remoteloginsettings
@required {poolId: any, nodeId: any}
@returns(200)

@endpoint GET /pools/{poolId}/nodes/{nodeId}/rdp
@required {poolId: any, nodeId: any}
@returns(200)

@endpoint POST /pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs
@required {poolId: any, nodeId: any, uploadBatchServiceLogsConfiguration: any}
@returns(200)

@endpoint GET /pools/{poolId}/nodes
@required {poolId: any}
@optional {$filter: any, $select: any, maxresults: any}
@returns(200)

@endgroup

@end