job_preparation_and_release_task_status

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

Overview

Name	job_preparation_and_release_task_status
Type	Resource
Id	azure.batch_dataplane.job_preparation_and_release_task_status

Fields

The following fields are returned by SELECT queries:

list_job_preparation_and_release_task_status

Name	Datatype	Description
jobPreparationTaskExecutionInfo	object	Information about the execution status of the Job Preparation Task on this Compute Node.
jobReleaseTaskExecutionInfo	object	Information about the execution status of the Job Release Task on this Compute Node. This property is set only if the Job Release Task has run on the Compute Node.
nodeId	string	The ID of the Compute Node to which this entry refers.
nodeUrl	string	The URL of the Compute Node to which this entry refers.
poolId	string	The ID of the Pool containing the Compute Node to which this entry refers.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_job_preparation_and_release_task_status	select	job_id, endpoint	timeOut, ocp-date, maxresults, $filter, $select	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. This API returns the Job Preparation and Job Release Task status on all Compute Nodes that have run the Job Preparation or Job Release Task. This includes Compute Nodes which have since been removed from the Pool. If this API is invoked on a Job which has no Job Preparation or Job Release Task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.

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.
$filter	string	An OData $filter clause. For more information on constructing this filter, see https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status _. Default value is None.
$select	array	An OData $select clause. Default value is None.
maxresults	integer	The maximum number of items to return in the response. A maximum of 1000 applications can be returned. Default value is None.
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

list_job_preparation_and_release_task_status

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. This API returns the Job Preparation and Job Release Task status on all Compute Nodes that have run the Job Preparation or Job Release Task. This includes Compute Nodes which have since been removed from the Pool. If this API is invoked on a Job which has no Job Preparation or Job Release Task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.

SELECT
jobPreparationTaskExecutionInfo,
jobReleaseTaskExecutionInfo,
nodeId,
nodeUrl,
poolId
FROM azure.batch_dataplane.job_preparation_and_release_task_status
WHERE job_id = '{{ job_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND timeOut = '{{ timeOut }}'
AND ocp-date = '{{ ocp-date }}'
AND maxresults = '{{ maxresults }}'
AND $filter = '{{ $filter }}'
AND $select = '{{ $select }}'
;