email_template

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

Overview

Name	email_template
Type	Resource
Id	azure.api_management.email_template

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
body	string	Email Template Body. This should be a valid XDocument. Required.
description	string	Description of the Email Template.
isDefault	boolean	Whether the template is the default template provided by API Management or has been edited.
parameters	array	Email Template Parameter values.
subject	string	Subject of the Template. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
title	string	Title of the Template.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_service

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
body	string	Email Template Body. This should be a valid XDocument. Required.
description	string	Description of the Email Template.
isDefault	boolean	Whether the template is the default template provided by API Management or has been edited.
parameters	array	Email Template Parameter values.
subject	string	Subject of the Template. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
title	string	Title of the Template.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_name, template_name, subscription_id		Gets the details of the email template specified by its identifier.
list_by_service	select	resource_group_name, service_name, subscription_id	$filter, $top, $skip	Gets all email templates.
create_or_update	insert	resource_group_name, service_name, template_name, subscription_id		Updates an Email Template.
update	update	resource_group_name, service_name, template_name, subscription_id		Updates API Management email template.
create_or_update	replace	resource_group_name, service_name, template_name, subscription_id		Updates an Email Template.
delete	delete	resource_group_name, service_name, template_name, subscription_id		Reset the Email Template to default template provided by the API Management service instance.
get_entity_tag	exec	resource_group_name, service_name, template_name, subscription_id		Gets the entity state (Etag) version of the email template specified by its identifier.

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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
service_name	string	The name of the API Management service. Required.
subscription_id	string
template_name	string	Email Template Name Identifier. Known values are: "applicationApprovedNotificationMessage", "accountClosedDeveloper", "quotaLimitApproachingDeveloperNotificationMessage", "newDeveloperNotificationMessage", "emailChangeIdentityDefault", "inviteUserNotificationMessage", "newCommentNotificationMessage", "confirmSignUpIdentityDefault", "newIssueNotificationMessage", "purchaseDeveloperNotificationMessage", "passwordResetIdentityDefault", "passwordResetByAdminNotificationMessage", "rejectDeveloperNotificationMessage", and "requestDeveloperNotificationMessage". Required.
$filter	string	| Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |. Default value is None.
$skip	integer	Number of records to skip. Default value is None.
$top	integer	Number of records to return. Default value is None.

SELECT examples

get

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

SELECT
id,
name,
body,
description,
isDefault,
parameters,
subject,
systemData,
title,
type
FROM azure.api_management.email_template
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND template_name = '{{ template_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_service

Gets all email templates.

SELECT
id,
name,
body,
description,
isDefault,
parameters,
subject,
systemData,
title,
type
FROM azure.api_management.email_template
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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_template (
properties,
resource_group_name,
service_name,
template_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ template_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: email_template
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the email_template resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the email_template resource.
  - name: template_name
    value: "{{ template_name }}"
    description: Required parameter for the email_template resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the email_template resource.
  - name: properties
    description: |
      Email Template Update contract properties.
    value:
      subject: "{{ subject }}"
      title: "{{ title }}"
      description: "{{ description }}"
      body: "{{ body }}"
      parameters:
        - name: "{{ name }}"
          title: "{{ title }}"
          description: "{{ description }}"

UPDATE examples

update

Updates API Management email template.

UPDATE azure.api_management.email_template
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND template_name = '{{ template_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Updates an Email Template.

REPLACE azure.api_management.email_template
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND template_name = '{{ template_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

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

DELETE FROM azure.api_management.email_template
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND template_name = '{{ template_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_entity_tag

Gets the entity state (Etag) version of the email template specified by its identifier.

EXEC azure.api_management.email_template.get_entity_tag 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@template_name='{{ template_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;