EmailTemplateImpl | @azure/arm-apimanagement

Class containing EmailTemplate operations.

Hierarchy

EmailTemplateImpl

Implements

EmailTemplate

Index

Constructors

constructor

Methods

Constructors

constructor

new EmailTemplateImpl(client: ApiManagementClientContext): EmailTemplateImpl

- Defined in operations/emailTemplate.ts:37
Initialize a new instance of the class EmailTemplate class.

Parameters
- client: ApiManagementClientContext
  
  Reference to the service client
Returns EmailTemplateImpl

Methods

createOrUpdate

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

Implementation of EmailTemplate.createOrUpdate
- Defined in operations/emailTemplate.ts:181
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>

Implementation of EmailTemplate.delete
- Defined in operations/emailTemplate.ts:234
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>

Implementation of EmailTemplate.get
- Defined in operations/emailTemplate.ts:161
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>

Implementation of EmailTemplate.getEntityTag
- Defined in operations/emailTemplate.ts:142
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>

Implementation of EmailTemplate.listByService
- Defined in operations/emailTemplate.ts:53
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>

Implementation of EmailTemplate.update
- Defined in operations/emailTemplate.ts:204
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

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ApiManagementClientContext

Returns EmailTemplateImpl

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>