templates

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

Overview

Name	templates
Type	Resource
Id	azure.communication_messages.templates

Fields

The following fields are returned by SELECT queries:

list_templates

Name	Datatype	Description
name	string	The template's name. Required.
kind	string	The type discriminator describing a template type. Required. "whatsApp"
language	string	The template's language, in the ISO 639 format, consist of a two-letter language code followed by an optional two-letter country code, e.g., 'en' or 'en_US'. Required.
status	string	The aggregated template status. Required. Known values are: "approved", "rejected", "pending", and "paused". (approved, rejected, pending, paused)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_templates	select	channel_id, endpoint	maxpagesize	List all templates for given Azure Communication Services channel.

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
channel_id	string	The registration ID of the channel. 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

list_templates

List all templates for given Azure Communication Services channel.

SELECT
name,
kind,
language,
status
FROM azure.communication_messages.templates
WHERE channel_id = '{{ channel_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND maxpagesize = '{{ maxpagesize }}'
;