job_task_counts

Creates, updates, deletes, gets or lists a job_task_counts resource.

Overview

Name	job_task_counts
Type	Resource
Id	azure.batch_dataplane.job_task_counts

Fields

The following fields are returned by SELECT queries:

get_job_task_counts

Name	Datatype	Description
taskCounts	object	The number of Tasks per state. Required.
taskSlotCounts	object	The number of TaskSlots required by Tasks per state. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_job_task_counts	select	job_id, endpoint	timeOut, ocp-date	Gets the Task counts for the specified Job. Task counts provide a count of the Tasks by active, running or completed Task state, and a count of Tasks which succeeded or failed. Tasks in the preparing state are counted as running. Note that the numbers returned may not always be up to date. If you need exact task counts, use a list query.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
job_id	string	The ID of the Job. Required.
ocp-date	string	The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. Default value is None.
timeOut	integer	The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". Default value is None.

SELECT examples

get_job_task_counts

Gets the Task counts for the specified Job. Task counts provide a count of the Tasks by active, running or completed Task state, and a count of Tasks which succeeded or failed. Tasks in the preparing state are counted as running. Note that the numbers returned may not always be up to date. If you need exact task counts, use a list query.

SELECT
taskCounts,
taskSlotCounts
FROM azure.batch_dataplane.job_task_counts
WHERE job_id = '{{ job_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND timeOut = '{{ timeOut }}'
AND ocp-date = '{{ ocp-date }}'
;