EmailTemplate interface
Interface que representa um EmailTemplate.
Métodos
create |
Atualiza um modelo de e-mail. |
delete(string, string, string, string, Email |
Redefina o modelo de e-mail para o modelo padrão fornecido pela instância do serviço de Gerenciamento de API. |
get(string, string, string, Email |
Obtém os detalhes do modelo de email especificado por seu identificador. |
get |
Obtém a versão do estado da entidade (Etag) do modelo de email especificado por seu identificador. |
list |
Obtém todos os modelos de e-mail |
update(string, string, string, string, Email |
Atualiza o modelo de e-mail de Gerenciamento de API |
Detalhes de Método
createOrUpdate(string, string, string, EmailTemplateUpdateParameters, EmailTemplateCreateOrUpdateOptionalParams)
Atualiza um modelo de e-mail.
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 e-mail.
- parameters
- EmailTemplateUpdateParameters
Parâmetros de atualização do modelo de e-mail.
Os parâmetros de opções.
Devoluções
Promise<EmailTemplateContract>
delete(string, string, string, string, EmailTemplateDeleteOptionalParams)
Redefina o modelo de e-mail 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 e-mail.
- ifMatch
-
string
ETag da Entidade. O ETag deve corresponder ao estado atual da entidade a partir da resposta do cabeçalho da solicitação GET ou deve ser * para atualização incondicional.
Os parâmetros de opções.
Devoluções
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 e-mail.
- options
- EmailTemplateGetOptionalParams
Os parâmetros de opções.
Devoluções
Promise<EmailTemplateGetResponse>
getEntityTag(string, string, string, EmailTemplateGetEntityTagOptionalParams)
Obtém a versão do 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 e-mail.
Os parâmetros de opções.
Devoluções
Promise<EmailTemplateGetEntityTagHeaders>
listByService(string, string, EmailTemplateListByServiceOptionalParams)
Obtém todos os modelos de e-mail
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.
Os parâmetros de opções.
Devoluções
update(string, string, string, string, EmailTemplateUpdateParameters, EmailTemplateUpdateOptionalParams)
Atualiza o modelo de e-mail de 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 e-mail.
- ifMatch
-
string
ETag da Entidade. O ETag deve corresponder ao estado atual da entidade a partir da resposta do cabeçalho da solicitação GET ou deve ser * para atualização incondicional.
- parameters
- EmailTemplateUpdateParameters
Atualizar parâmetros.
Os parâmetros de opções.
Devoluções
Promise<EmailTemplateUpdateResponse>