Compartilhar via

EmailTemplate interface

  • Referência
Pacote:
@azure/arm-apimanagement

Interface que representa um EmailTemplate.

Métodos

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

Atualiza um modelo de email.
delete(string, string, string, string, EmailTemplateDeleteOptionalParams)

Redefina o Modelo de Email para o modelo padrão fornecido pela instância do serviço de Gerenciamento de API.
get(string, string, string, EmailTemplateGetOptionalParams)

Obtém os detalhes do modelo de email especificado por seu identificador.
getEntityTag(string, string, string, EmailTemplateGetEntityTagOptionalParams)

Obtém a versão de estado da entidade (Etag) do modelo de email especificado por seu identificador.
listByService(string, string, EmailTemplateListByServiceOptionalParams)

Obtém todos os modelos de email
update(string, string, string, string, EmailTemplateUpdateParameters, EmailTemplateUpdateOptionalParams)

Atualiza o modelo de email do Gerenciamento de API

Detalhes do método

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

Atualiza um modelo de email.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

templateName

string

Identificador de nome do modelo de email.

parameters
EmailTemplateUpdateParameters

Parâmetros de atualização do modelo de email.

options
EmailTemplateCreateOrUpdateOptionalParams

Os parâmetros de opções.

Retornos

Promise<EmailTemplateContract>

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

Redefina o Modelo de Email para o modelo padrão fornecido pela instância do serviço de Gerenciamento de API.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

templateName

string

Identificador de nome do modelo de email.

ifMatch

string

ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho da solicitação GET ou deve ser * para atualização incondicional.

options
EmailTemplateDeleteOptionalParams

Os parâmetros de opções.

Retornos

Promise<void>

get(string, string, string, EmailTemplateGetOptionalParams)

Obtém os detalhes do modelo de email especificado por seu identificador.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

templateName

string

Identificador de nome do modelo de email.

options
EmailTemplateGetOptionalParams

Os parâmetros de opções.

Retornos

Promise<EmailTemplateGetResponse>

getEntityTag(string, string, string, EmailTemplateGetEntityTagOptionalParams)

Obtém a versão de estado da entidade (Etag) do modelo de email especificado por seu identificador.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

templateName

string

Identificador de nome do modelo de email.

options
EmailTemplateGetEntityTagOptionalParams

Os parâmetros de opções.

Retornos

Promise<EmailTemplateGetEntityTagHeaders>

listByService(string, string, EmailTemplateListByServiceOptionalParams)

Obtém todos os modelos de email

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

options
EmailTemplateListByServiceOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<EmailTemplateContract, EmailTemplateContract[], PageSettings>

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

Atualiza o modelo de email do Gerenciamento de API

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

templateName

string

Identificador de nome do modelo de email.

ifMatch

string

ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho da solicitação GET ou deve ser * para atualização incondicional.

parameters
EmailTemplateUpdateParameters

Atualizar parâmetros.

options
EmailTemplateUpdateOptionalParams

Os parâmetros de opções.

Retornos

Promise<EmailTemplateUpdateResponse>