email_templates

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

Overview

Name	email_templates
Type	Resource
Id	azure.api_management.email_templates

Fields

The following fields are returned by SELECT queries:

get

The response body contains the specified Email template.

Name	Datatype	Description
properties	object	Email Template entity contract properties.

list_by_service

A Collection of the Email Template for the specified API Management service instance.

Name	Datatype	Description
properties	object	Email Template entity contract properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serviceName, templateName, subscriptionId		Gets the details of the email template specified by its identifier.
list_by_service	select	resourceGroupName, serviceName, subscriptionId	$filter, $top, $skip	Gets all email templates
create_or_update	insert	resourceGroupName, serviceName, templateName, subscriptionId	If-Match	Updates an Email Template.
update	update	resourceGroupName, serviceName, templateName, If-Match, subscriptionId		Updates API Management email template
delete	delete	resourceGroupName, serviceName, templateName, If-Match, subscriptionId		Reset the Email Template to default template provided by the API Management service instance.

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
If-Match	string	ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
serviceName	string	The name of the API Management service.
subscriptionId	string	The ID of the target subscription.
templateName	string	Email Template Name Identifier.
$filter	string	| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>
$skip	integer (int32)	Number of records to skip.
$top	integer (int32)	Number of records to return.
If-Match	string	ETag of the Entity. Not required when creating an entity, but required when updating an entity.

SELECT examples

get

Gets the details of the email template specified by its identifier.

SELECT
properties
FROM azure.api_management.email_templates
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND templateName = '{{ templateName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_service

Gets all email templates

SELECT
properties
FROM azure.api_management.email_templates
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;

INSERT examples

create_or_update

Updates an Email Template.

INSERT INTO azure.api_management.email_templates (
data__properties,
resourceGroupName,
serviceName,
templateName,
subscriptionId,
If-Match
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ templateName }}',
'{{ subscriptionId }}',
'{{ If-Match }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: email_templates
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the email_templates resource.
    - name: serviceName
      value: string
      description: Required parameter for the email_templates resource.
    - name: templateName
      value: string
      description: Required parameter for the email_templates resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the email_templates resource.
    - name: properties
      value: object
      description: |
        Email Template Update contract properties.
    - name: If-Match
      value: string
      description: ETag of the Entity. Not required when creating an entity, but required when updating an entity.

UPDATE examples

update

Updates API Management email template

UPDATE azure.api_management.email_templates
SET 
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND templateName = '{{ templateName }}' --required
AND If-Match = '{{ If-Match }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
properties;

DELETE examples

delete

Reset the Email Template to default template provided by the API Management service instance.

DELETE FROM azure.api_management.email_templates
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND templateName = '{{ templateName }}' --required
AND If-Match = '{{ If-Match }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;