Email Template - Get
Gets the details of the email template specified by its identifier.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/templates/{templateName}?api-version=2021-08-01
Name | In | Required | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
The name of the resource group. |
service
|
path | True |
string |
The name of the API Management service. Regex pattern: |
subscription
|
path | True |
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
template
|
path | True |
Email Template Name Identifier. |
|
api-version
|
query | True |
string |
Version of the API to be used with the client request. |
Name | Type | Description |
---|---|---|
200 OK |
The response body contains the specified Email template. Headers ETag: string |
|
Other Status Codes |
Error response describing why the operation failed. |
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Sample request
Sample response
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates/NewIssueNotificationMessage",
"type": "Microsoft.ApiManagement/service/templates",
"name": "NewIssueNotificationMessage",
"properties": {
"subject": "Your request $IssueName was received",
"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'\">Thank you for contacting us. Our API team will review your issue and get back to you soon.</p>\r\n <p style=\"font-size:12pt;font-family:'Segoe UI'\">\r\n Click this <a href=\"http://$DevPortalUrl/issues/$IssueId\">link</a> to view or edit your request.\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": "New issue received",
"description": "This email is sent to developers after they create a new topic on the Issues page of the developer portal.",
"isDefault": true,
"parameters": [
{
"name": "DevFirstName",
"title": "Developer first name"
},
{
"name": "DevLastName",
"title": "Developer last name"
},
{
"name": "IssueId",
"title": "Issue id"
},
{
"name": "IssueName",
"title": "Issue name"
},
{
"name": "OrganizationName",
"title": "Organization name"
},
{
"name": "DevPortalUrl",
"title": "Developer portal URL"
}
]
}
}
Name | Description |
---|---|
Email |
Email Template details. |
Email |
Email Template Parameter contract. |
Error |
Error Field contract. |
Error |
Error Response. |
Template |
Email Template Name Identifier. |
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 |
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" |
Email Template Parameter contract.
Name | Type | Description |
---|---|---|
description |
string |
Template parameter description. |
name |
string |
Template parameter name. |
title |
string |
Template parameter title. |
Error Field contract.
Name | Type | Description |
---|---|---|
code |
string |
Property level error code. |
message |
string |
Human-readable representation of property-level error. |
target |
string |
Property name. |
Error Response.
Name | Type | Description |
---|---|---|
error.code |
string |
Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. |
error.details |
The list of invalid fields send in request, in case of validation error. |
|
error.message |
string |
Human-readable representation of the error. |
Email Template Name Identifier.
Name | Type | Description |
---|---|---|
accountClosedDeveloper |
string |
|
applicationApprovedNotificationMessage |
string |
|
confirmSignUpIdentityDefault |
string |
|
emailChangeIdentityDefault |
string |
|
inviteUserNotificationMessage |
string |
|
newCommentNotificationMessage |
string |
|
newDeveloperNotificationMessage |
string |
|
newIssueNotificationMessage |
string |
|
passwordResetByAdminNotificationMessage |
string |
|
passwordResetIdentityDefault |
string |
|
purchaseDeveloperNotificationMessage |
string |
|
quotaLimitApproachingDeveloperNotificationMessage |
string |
|
rejectDeveloperNotificationMessage |
string |
|
requestDeveloperNotificationMessage |
string |