queue_positions

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

Overview

Name	queue_positions
Type	Resource
Id	azure.communication_job_router.queue_positions

Fields

The following fields are returned by SELECT queries:

get_queue_position

Name	Datatype	Description
estimatedWaitTimeMinutes	number	Estimated wait time of the job rounded up to the nearest minute. Required.
jobId	string	Id of the job these details are about. Required.
position	integer	Position of the job in question within that queue. Required.
queueId	string	Id of the queue this job is enqueued in. Required.
queueLength	integer	Length of the queue: total number of enqueued jobs. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_queue_position	select	job_id, endpoint		Gets a job's position details. Gets a job's position details.

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	Id of the job. Required.

SELECT examples

get_queue_position

Gets a job's position details. Gets a job's position details.

SELECT
estimatedWaitTimeMinutes,
jobId,
position,
queueId,
queueLength
FROM azure.communication_job_router.queue_positions
WHERE job_id = '{{ job_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;