你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Email Template - Create Or Update

更新电子邮件模板。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/templates/{templateName}?api-version=2021-08-01

URI 参数

Name In Required Type Description
resourceGroupName
path True
  • string

资源组的名称。

serviceName
path True
  • string

API 管理服务的名称。

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

唯一标识Microsoft Azure订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。

templateName
path True

电子邮件模板名称标识符。

api-version
query True
  • string

要与客户端请求一起使用的 API 版本。

请求头

Name Required Type Description
If-Match
  • string

实体的 ETag。 创建实体时不需要,但在更新实体时是必需的。

请求正文

Name Type Description
properties.body
  • string

电子邮件模板正文。 这应该是有效的 XDocument

properties.description
  • string

电子邮件模板的说明。

properties.parameters

电子邮件模板参数值。

properties.subject
  • string

模板的主题。

properties.title
  • string

模板的标题。

响应

Name Type Description
200 OK

已成功更新电子邮件模板。

201 Created

已成功更新电子邮件模板。

Other Status Codes

描述操作失败的原因的错误响应。

安全性

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 模拟用户帐户

示例

ApiManagementCreateTemplate

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates/newIssueNotificationMessage?api-version=2021-08-01

{
  "properties": {
    "subject": "Your request for $IssueName was successfully received."
  }
}

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 for $IssueName was successfully 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": false,
    "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"
      }
    ]
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates/NewIssueNotificationMessage",
  "type": "Microsoft.ApiManagement/service/templates",
  "name": "NewIssueNotificationMessage",
  "properties": {
    "subject": "Your request for $IssueName was successfully 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": false,
    "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"
      }
    ]
  }
}

定义

EmailTemplateContract

电子邮件模板详细信息。

EmailTemplateParametersContractProperties

电子邮件模板参数协定。

EmailTemplateUpdateParameters

电子邮件模板更新参数。

ErrorFieldContract

错误字段协定。

ErrorResponse

错误响应。

TemplateName

电子邮件模板名称标识符。

EmailTemplateContract

电子邮件模板详细信息。

Name Type Description
id
  • string

资源的完全限定的资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

资源的名称

properties.body
  • string

电子邮件模板正文。 这应该是有效的 XDocument

properties.description
  • string

电子邮件模板的说明。

properties.isDefault
  • boolean

模板是API 管理提供的默认模板,还是已被编辑。

properties.parameters

电子邮件模板参数值。

properties.subject
  • string

模板的主题。

properties.title
  • string

模板的标题。

type
  • string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft”。存储/storageAccounts”

EmailTemplateParametersContractProperties

电子邮件模板参数协定。

Name Type Description
description
  • string

模板参数说明。

name
  • string

模板参数名称。

title
  • string

模板参数标题。

EmailTemplateUpdateParameters

电子邮件模板更新参数。

Name Type Description
properties.body
  • string

电子邮件模板正文。 这应该是有效的 XDocument

properties.description
  • string

电子邮件模板的说明。

properties.parameters

电子邮件模板参数值。

properties.subject
  • string

模板的主题。

properties.title
  • string

模板的标题。

ErrorFieldContract

错误字段协定。

Name Type Description
code
  • string

属性级错误代码。

message
  • string

可读属性级错误的可读表示形式。

target
  • string

属性名称。

ErrorResponse

错误响应。

Name Type Description
error.code
  • string

服务定义的错误代码。 此代码用作响应中指定的 HTTP 错误代码的子状态。

error.details

请求中发送的无效字段列表(如果出现验证错误)。

error.message
  • string

错误的用户可读表示形式。

TemplateName

电子邮件模板名称标识符。

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