Skip to main content

queue_statistics

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

Overview

Namequeue_statistics
TypeResource
Idazure.communication_job_router.queue_statistics

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
estimatedWaitTimeMinutesobjectThe estimated wait time of this queue rounded up to the nearest minute, grouped by job priority.
lengthintegerLength of the queue: total number of enqueued jobs. Required.
longestJobWaitTimeMinutesnumberThe wait time of the job that has been enqueued in this queue for the longest.
queueIdstringId of the queue these details are about. Required.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_queue_statisticsselectqueue_id, endpointRetrieves a queue's statistics. Retrieves a queue's statistics.

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.

NameDatatypeDescription
endpointstringThe service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
queue_idstringId of the queue to retrieve statistics. Required.

SELECT examples

Retrieves a queue's statistics. Retrieves a queue's statistics.

SELECT
estimatedWaitTimeMinutes,
length,
longestJobWaitTimeMinutes,
queueId
FROM azure.communication_job_router.queue_statistics
WHERE queue_id = '{{ queue_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;