queues

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

Overview

Name	queues
Type	Resource
Id	azure.communication_job_router.queues

Fields

The following fields are returned by SELECT queries:

get_queue

Name	Datatype	Description
id	string	Id of a queue. Required.
name	string	Friendly name of this queue.
distributionPolicyId	string	Id of a distribution policy that will determine how a job is distributed to workers.
etag	string	The entity tag for this resource. Required.
exceptionPolicyId	string	Id of an exception policy that determines various job escalation rules.
labels	object	A set of key/value pairs that are identifying attributes used by the rules engines to make decisions. Values must be primitive values - number, string, boolean.

list_queues

Name	Datatype	Description
id	string	Id of a queue. Required.
name	string	Friendly name of this queue.
distributionPolicyId	string	Id of a distribution policy that will determine how a job is distributed to workers.
etag	string	The entity tag for this resource. Required.
exceptionPolicyId	string	Id of an exception policy that determines various job escalation rules.
labels	object	A set of key/value pairs that are identifying attributes used by the rules engines to make decisions. Values must be primitive values - number, string, boolean.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_queue	select	queue_id, endpoint		Retrieves an existing queue by Id. Retrieves an existing queue by Id.
list_queues	select	endpoint	maxpagesize	Retrieves existing queues. Retrieves existing queues.
delete_queue	delete	queue_id, endpoint		Deletes a queue by Id. Deletes a queue by Id.

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: )
queue_id	string	Id of a queue. Required.
maxpagesize	integer

SELECT examples

get_queue

Retrieves an existing queue by Id. Retrieves an existing queue by Id.

SELECT
id,
name,
distributionPolicyId,
etag,
exceptionPolicyId,
labels
FROM azure.communication_job_router.queues
WHERE queue_id = '{{ queue_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list_queues

Retrieves existing queues. Retrieves existing queues.

SELECT
id,
name,
distributionPolicyId,
etag,
exceptionPolicyId,
labels
FROM azure.communication_job_router.queues
WHERE endpoint = '{{ endpoint }}' -- required
AND maxpagesize = '{{ maxpagesize }}'
;

DELETE examples

delete_queue

Deletes a queue by Id. Deletes a queue by Id.

DELETE FROM azure.communication_job_router.queues
WHERE queue_id = '{{ queue_id }}' --required
AND endpoint = '{{ endpoint }}' --required
;