distribution_policies

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

Overview

Name	distribution_policies
Type	Resource
Id	azure.communication_job_router.distribution_policies

Fields

The following fields are returned by SELECT queries:

get_distribution_policy

Name	Datatype	Description
id	string	Id of a distribution policy. Required.
name	string	Friendly name of this policy.
etag	string	The entity tag for this resource. Required.
mode	object	Mode governing the specific distribution method.
offerExpiresAfterSeconds	number	Number of seconds after which any offers created under this policy will be expired.

list_distribution_policies

Name	Datatype	Description
id	string	Id of a distribution policy. Required.
name	string	Friendly name of this policy.
etag	string	The entity tag for this resource. Required.
mode	object	Mode governing the specific distribution method.
offerExpiresAfterSeconds	number	Number of seconds after which any offers created under this policy will be expired.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_distribution_policy	select	distribution_policy_id, endpoint		Retrieves an existing distribution policy by Id. Retrieves an existing distribution policy by Id.
list_distribution_policies	select	endpoint	maxpagesize	Retrieves existing distribution policies. Retrieves existing distribution policies.
delete_distribution_policy	delete	distribution_policy_id, endpoint		Delete a distribution policy by Id. Delete a distribution policy 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
distribution_policy_id	string	Id of a distribution policy. Required.
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
maxpagesize	integer

SELECT examples

get_distribution_policy

Retrieves an existing distribution policy by Id. Retrieves an existing distribution policy by Id.

SELECT
id,
name,
etag,
mode,
offerExpiresAfterSeconds
FROM azure.communication_job_router.distribution_policies
WHERE distribution_policy_id = '{{ distribution_policy_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list_distribution_policies

Retrieves existing distribution policies. Retrieves existing distribution policies.

SELECT
id,
name,
etag,
mode,
offerExpiresAfterSeconds
FROM azure.communication_job_router.distribution_policies
WHERE endpoint = '{{ endpoint }}' -- required
AND maxpagesize = '{{ maxpagesize }}'
;

DELETE examples

delete_distribution_policy

Delete a distribution policy by Id. Delete a distribution policy by Id.

DELETE FROM azure.communication_job_router.distribution_policies
WHERE distribution_policy_id = '{{ distribution_policy_id }}' --required
AND endpoint = '{{ endpoint }}' --required
;