exception_policies

Creates, updates, deletes, gets or lists an exception_policies resource.

Overview

Name	exception_policies
Type	Resource
Id	azure.communication_job_router.exception_policies

Fields

The following fields are returned by SELECT queries:

get_exception_policy

Name	Datatype	Description
id	string	Id of an exception policy. Required.
name	string	Friendly name of this policy.
etag	string	The entity tag for this resource. Required.
exceptionRules	array	A collection of exception rules on the exception policy.

list_exception_policies

Name	Datatype	Description
id	string	Id of an exception policy. Required.
name	string	Friendly name of this policy.
etag	string	The entity tag for this resource. Required.
exceptionRules	array	A collection of exception rules on the exception policy.

Methods

The following methods are available for this resource:

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

SELECT examples

get_exception_policy

Retrieves an existing exception policy by Id. Retrieves an existing exception policy by Id.

SELECT
id,
name,
etag,
exceptionRules
FROM azure.communication_job_router.exception_policies
WHERE exception_policy_id = '{{ exception_policy_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list_exception_policies

Retrieves existing exception policies. Retrieves existing exception policies.

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

DELETE examples

delete_exception_policy

Deletes a exception policy by Id. Deletes a exception policy by Id.

DELETE FROM azure.communication_job_router.exception_policies
WHERE exception_policy_id = '{{ exception_policy_id }}' --required
AND endpoint = '{{ endpoint }}' --required
;