Share via

EmailTemplate interface

  • Reference
Package:
@azure/arm-apimanagement

Interface representing a EmailTemplate.

Methods

createOrUpdate(string, string, string, EmailTemplateUpdateParameters, EmailTemplateCreateOrUpdateOptionalParams)

Updates an Email Template.
delete(string, string, string, string, EmailTemplateDeleteOptionalParams)

Reset the Email Template to default template provided by the API Management service instance.
get(string, string, string, EmailTemplateGetOptionalParams)

Gets the details of the email template specified by its identifier.
getEntityTag(string, string, string, EmailTemplateGetEntityTagOptionalParams)

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

Gets all email templates
update(string, string, string, string, EmailTemplateUpdateParameters, EmailTemplateUpdateOptionalParams)

Updates API Management email template

Method Details

createOrUpdate(string, string, string, EmailTemplateUpdateParameters, EmailTemplateCreateOrUpdateOptionalParams)

Updates an Email Template.

function createOrUpdate(resourceGroupName: string, serviceName: string, templateName: string, parameters: EmailTemplateUpdateParameters, options?: EmailTemplateCreateOrUpdateOptionalParams): Promise<EmailTemplateContract>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

templateName

string

Email Template Name Identifier.

parameters
EmailTemplateUpdateParameters

Email Template update parameters.

options
EmailTemplateCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<EmailTemplateContract>

delete(string, string, string, string, EmailTemplateDeleteOptionalParams)

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

function delete(resourceGroupName: string, serviceName: string, templateName: string, ifMatch: string, options?: EmailTemplateDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

templateName

string

Email Template Name Identifier.

ifMatch

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.

options
EmailTemplateDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, EmailTemplateGetOptionalParams)

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

function get(resourceGroupName: string, serviceName: string, templateName: string, options?: EmailTemplateGetOptionalParams): Promise<EmailTemplateGetResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

templateName

string

Email Template Name Identifier.

options
EmailTemplateGetOptionalParams

The options parameters.

Returns

Promise<EmailTemplateGetResponse>

getEntityTag(string, string, string, EmailTemplateGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, templateName: string, options?: EmailTemplateGetEntityTagOptionalParams): Promise<EmailTemplateGetEntityTagHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

templateName

string

Email Template Name Identifier.

options
EmailTemplateGetEntityTagOptionalParams

The options parameters.

Returns

Promise<EmailTemplateGetEntityTagHeaders>

listByService(string, string, EmailTemplateListByServiceOptionalParams)

Gets all email templates

function listByService(resourceGroupName: string, serviceName: string, options?: EmailTemplateListByServiceOptionalParams): PagedAsyncIterableIterator<EmailTemplateContract, EmailTemplateContract[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

options
EmailTemplateListByServiceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<EmailTemplateContract, EmailTemplateContract[], PageSettings>

update(string, string, string, string, EmailTemplateUpdateParameters, EmailTemplateUpdateOptionalParams)

Updates API Management email template

function update(resourceGroupName: string, serviceName: string, templateName: string, ifMatch: string, parameters: EmailTemplateUpdateParameters, options?: EmailTemplateUpdateOptionalParams): Promise<EmailTemplateUpdateResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

templateName

string

Email Template Name Identifier.

ifMatch

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.

parameters
EmailTemplateUpdateParameters

Update parameters.

options
EmailTemplateUpdateOptionalParams

The options parameters.

Returns

Promise<EmailTemplateUpdateResponse>