EmailTemplate interface

包:

@azure/arm-apimanagement

表示 EmailTemplate 的接口。

方法

createOrUpdate(string, string, string, EmailTemplateUpdateParameters, EmailTemplateCreateOrUpdateOptionalParams)	更新电子邮件模板。
delete(string, string, string, string, EmailTemplateDeleteOptionalParams)	将电子邮件模板重置为 API 管理服务实例提供的默认模板。
get(string, string, string, EmailTemplateGetOptionalParams)	获取由其标识符指定的电子邮件模板的详细信息。
getEntityTag(string, string, string, EmailTemplateGetEntityTagOptionalParams)	获取由其标识符指定的电子邮件模板的实体状态 （Etag） 版本。
listByService(string, string, EmailTemplateListByServiceOptionalParams)	获取所有电子邮件模板
update(string, string, string, string, EmailTemplateUpdateParameters, EmailTemplateUpdateOptionalParams)	更新 API 管理电子邮件模板

方法详细信息

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

更新电子邮件模板。

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

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

serviceName

string

API 管理服务的名称。

templateName

string

电子邮件模板名称标识符。

parameters

EmailTemplateUpdateParameters

电子邮件模板更新参数。

options

EmailTemplateCreateOrUpdateOptionalParams

选项参数。

返回

Promise<EmailTemplateContract>

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

将电子邮件模板重置为 API 管理服务实例提供的默认模板。

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

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

serviceName

string

API 管理服务的名称。

templateName

string

电子邮件模板名称标识符。

ifMatch

string

实体的 ETag。 ETag 应与 GET 请求的标头响应中的当前实体状态匹配，或者它应为 * 进行无条件更新。

options

EmailTemplateDeleteOptionalParams

选项参数。

返回

Promise<void>

get(string, string, string, EmailTemplateGetOptionalParams)

获取由其标识符指定的电子邮件模板的详细信息。

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

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

serviceName

string

API 管理服务的名称。

templateName

string

电子邮件模板名称标识符。

options

EmailTemplateGetOptionalParams

选项参数。

返回

Promise<EmailTemplateGetResponse>

getEntityTag(string, string, string, EmailTemplateGetEntityTagOptionalParams)

获取由其标识符指定的电子邮件模板的实体状态 （Etag） 版本。

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

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

serviceName

string

API 管理服务的名称。

templateName

string

电子邮件模板名称标识符。

options

EmailTemplateGetEntityTagOptionalParams

选项参数。

返回

Promise<EmailTemplateGetEntityTagHeaders>

listByService(string, string, EmailTemplateListByServiceOptionalParams)

获取所有电子邮件模板

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

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

serviceName

string

API 管理服务的名称。

options

EmailTemplateListByServiceOptionalParams

选项参数。

返回

PagedAsyncIterableIterator<EmailTemplateContract, EmailTemplateContract[], PageSettings>

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

更新 API 管理电子邮件模板

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

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

serviceName

string

API 管理服务的名称。

templateName

string

电子邮件模板名称标识符。

ifMatch

string

实体的 ETag。 ETag 应与 GET 请求的标头响应中的当前实体状态匹配，或者它应为 * 进行无条件更新。

parameters

EmailTemplateUpdateParameters

更新参数。

options

EmailTemplateUpdateOptionalParams

选项参数。

返回

Promise<EmailTemplateUpdateResponse>