Email Template - List By Service

Reference

Service:: API Management

API Version:: 2024-05-01

Gets all email templates

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/templates?api-version=2024-05-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/templates?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2024-05-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
serviceName	path	True	string	The name of the API Management service. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string	The API version to use for this operation.
$filter	query		string	\| Field \| Usage \| Supported operators \| Supported functions \| \|-------------\|-------------\|-------------\|-------------\| \| name \| filter \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \|
$skip	query		integer int32	Number of records to skip.
$top	query		integer int32	Number of records to return.

Responses

Name	Type	Description
200 OK	EmailTemplateCollection	A Collection of the Email Template for the specified API Management service instance.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

ApiManagementListTemplates

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates?api-version=2024-05-01

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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": ""
}

Definitions

Name	Description
EmailTemplateCollection	Paged email template list representation.
EmailTemplateContract	Email Template details.
EmailTemplateParametersContractProperties	Email Template Parameter contract.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response

EmailTemplateCollection

Paged email template list representation.

Name	Type	Description
count	integer	Total record count number across all pages.
nextLink	string	Next page link if any.
value	EmailTemplateContract[]	Page values.

EmailTemplateContract

Email Template details.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties.body	string	Email Template Body. This should be a valid XDocument
properties.description	string	Description of the Email Template.
properties.isDefault	boolean	Whether the template is the default template provided by API Management or has been edited.
properties.parameters	EmailTemplateParametersContractProperties[]	Email Template Parameter values.
properties.subject	string	Subject of the Template.
properties.title	string	Title of the Template.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

EmailTemplateParametersContractProperties

Email Template Parameter contract.

Name	Type	Description
description	string	Template parameter description.
name	string	Template parameter name.
title	string	Template parameter title.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

Share via