EmailTemplate | @azure/arm-apimanagement

Interface representing a EmailTemplate.

Hierarchy

EmailTemplate

Implemented by

EmailTemplateImpl

Index

Methods

createOrUpdate

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

- Defined in operationsInterfaces/emailTemplate.ts:74
Updates an Email Template.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- templateName: TemplateName
  
  Email Template Name Identifier.
- parameters: EmailTemplateUpdateParameters
  
  Email Template update parameters.
- Optional options: EmailTemplateCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<EmailTemplateCreateOrUpdateResponse>

delete

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

- Defined in operationsInterfaces/emailTemplate.ts:108
Reset the Email Template to default template provided by the API Management service instance.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- templateName: TemplateName
  
  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.
- Optional options: EmailTemplateDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

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

- Defined in operationsInterfaces/emailTemplate.ts:60
Gets the details of the email template specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- templateName: TemplateName
  
  Email Template Name Identifier.
- Optional options: EmailTemplateGetOptionalParams
  
  The options parameters.
Returns Promise<EmailTemplateGetResponse>

getEntityTag

getEntityTag(resourceGroupName: string, serviceName: string, templateName: TemplateName, options?: EmailTemplateGetEntityTagOptionalParams): Promise<EmailTemplateGetEntityTagResponse>

- Defined in operationsInterfaces/emailTemplate.ts:47
Gets the entity state (Etag) version of the email template specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- templateName: TemplateName
  
  Email Template Name Identifier.
- Optional options: EmailTemplateGetEntityTagOptionalParams
  
  The options parameters.
Returns Promise<EmailTemplateGetEntityTagResponse>

listByService

listByService(resourceGroupName: string, serviceName: string, options?: EmailTemplateListByServiceOptionalParams): PagedAsyncIterableIterator<EmailTemplateContract>

- Defined in operationsInterfaces/emailTemplate.ts:35
Gets all email templates

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- Optional options: EmailTemplateListByServiceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<EmailTemplateContract>

update

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

- Defined in operationsInterfaces/emailTemplate.ts:91
Updates API Management email template

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- templateName: TemplateName
  
  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.
- Optional options: EmailTemplateUpdateOptionalParams
  
  The options parameters.
Returns Promise<EmailTemplateUpdateResponse>

Hierarchy

Implemented by

Index

Methods

Methods

createOrUpdate

Parameters

resourceGroupName: string

serviceName: string

templateName: TemplateName

parameters: EmailTemplateUpdateParameters

Optional options: EmailTemplateCreateOrUpdateOptionalParams

Returns Promise<EmailTemplateCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

serviceName: string

templateName: TemplateName

ifMatch: string

Optional options: EmailTemplateDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serviceName: string

templateName: TemplateName

Optional options: EmailTemplateGetOptionalParams

Returns Promise<EmailTemplateGetResponse>

getEntityTag

Parameters

resourceGroupName: string

serviceName: string

templateName: TemplateName

Optional options: EmailTemplateGetEntityTagOptionalParams

Returns Promise<EmailTemplateGetEntityTagResponse>

listByService

Parameters

resourceGroupName: string

serviceName: string

Optional options: EmailTemplateListByServiceOptionalParams

Returns PagedAsyncIterableIterator<EmailTemplateContract>

update

Parameters

resourceGroupName: string

serviceName: string

templateName: TemplateName

ifMatch: string

parameters: EmailTemplateUpdateParameters

Optional options: EmailTemplateUpdateOptionalParams

Returns Promise<EmailTemplateUpdateResponse>