Email Template - List By Service
Obtém todos os modelos de e-mail
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/templates?api-version=2021-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/templates?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2021-08-01
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
resource
|
path | True |
string |
O nome do grupo de recursos. |
service
|
path | True |
string |
O nome do serviço Gestão de API. Padrão Regex: |
subscription
|
path | True |
string |
Credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço. |
api-version
|
query | True |
string |
Versão da API a utilizar com o pedido de cliente. |
$filter
|
query |
string |
| Campo | Utilização | Operadores suportados | Funções suportadas | |
|
$skip
|
query |
integer int32 |
Número de registos a ignorar. |
|
$top
|
query |
integer int32 |
Número de registos a devolver. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
Uma Coleção do Modelo de Email para a instância de serviço de Gestão de API especificada. |
|
Other Status Codes |
Resposta de erro que descreve o motivo pela qual a operação falhou. |
Segurança
azure_auth
Fluxo OAuth2 do Azure Active Directory.
Tipo:
oauth2
Fluxo:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Âmbitos
Name | Description |
---|---|
user_impersonation | representar a sua conta de utilizador |
Exemplos
ApiManagementListTemplates
Pedido de amostra
Resposta da amostra
{
"value": [
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates/ApplicationApprovedNotificationMessage",
"type": "Microsoft.ApiManagement/service/templates",
"name": "ApplicationApprovedNotificationMessage",
"properties": {
"subject": "Your application $AppName is published in the application gallery",
"body": "<!DOCTYPE html >\r\n<html>\r\n <head />\r\n <body>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">Dear $DevFirstName $DevLastName,</p>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">\r\n We are happy to let you know that your request to publish the $AppName application in the application gallery has been approved. Your application has been published and can be viewed <a href=\"http://$DevPortalUrl/Applications/Details/$AppId\">here</a>.\r\n </p>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">Best,</p>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">The $OrganizationName API Team</p>\r\n </body>\r\n</html>",
"title": "Application gallery submission approved",
"description": "Developers who submitted their application for publication in the application gallery on the developer portal receive this email after their submission is approved.",
"isDefault": true,
"parameters": [
{
"name": "AppId",
"title": "Application id"
},
{
"name": "AppName",
"title": "Application name"
},
{
"name": "DevFirstName",
"title": "Developer first name"
},
{
"name": "DevLastName",
"title": "Developer last name"
},
{
"name": "OrganizationName",
"title": "Organization name"
},
{
"name": "DevPortalUrl",
"title": "Developer portal URL"
}
]
}
}
],
"count": 1,
"nextLink": ""
}
Definições
Name | Description |
---|---|
Email |
Representação da lista de modelos de e-mail paginados. |
Email |
Email detalhes do Modelo. |
Email |
Email contrato parâmetro de modelo. |
Error |
Contrato de Campo de Erro. |
Error |
Resposta do Erro. |
EmailTemplateCollection
Representação da lista de modelos de e-mail paginados.
Name | Tipo | Description |
---|---|---|
count |
integer |
Número total de contagem de registos em todas as páginas. |
nextLink |
string |
Ligação da página seguinte, se existir. |
value |
Valores de página. |
EmailTemplateContract
Email detalhes do Modelo.
Name | Tipo | Description |
---|---|---|
id |
string |
ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
O nome do recurso |
properties.body |
string |
Email Corpo do Modelo. Este deve ser um XDocument válido |
properties.description |
string |
Descrição do Modelo de Email. |
properties.isDefault |
boolean |
Se o modelo é o modelo predefinido fornecido por Gestão de API ou se foi editado. |
properties.parameters |
Email valores do Parâmetro de Modelo. |
|
properties.subject |
string |
Assunto do Modelo. |
properties.title |
string |
Título do Modelo. |
type |
string |
O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" |
EmailTemplateParametersContractProperties
Email contrato parâmetro de modelo.
Name | Tipo | Description |
---|---|---|
description |
string |
Descrição do parâmetro do modelo. |
name |
string |
Nome do parâmetro do modelo. |
title |
string |
Título do parâmetro de modelo. |
ErrorFieldContract
Contrato de Campo de Erro.
Name | Tipo | Description |
---|---|---|
code |
string |
Código de erro de nível de propriedade. |
message |
string |
Representação legível por humanos do erro ao nível da propriedade. |
target |
string |
Nome da propriedade. |
ErrorResponse
Resposta do Erro.
Name | Tipo | Description |
---|---|---|
error.code |
string |
Código de erro definido pelo serviço. Este código serve como um subestado para o código de erro HTTP especificado na resposta. |
error.details |
A lista de campos inválidos enviados no pedido, em caso de erro de validação. |
|
error.message |
string |
Representação legível por humanos do erro. |