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

Email Template - Update

参考

服务:: API Management

API 版本:: 2024-05-01

更新 API 管理电子邮件模板

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

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。名称不区分大小写。
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API 管理服务的名称。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。该值必须是 UUID。
templateName	path	True	TemplateName	电子邮件模板名称标识符。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

请求头

名称	必需	类型	说明
If-Match	True	string	实体的 ETag。 ETag 应与 GET 请求的标头响应中的当前实体状态匹配，或者它应为 * 进行无条件更新。

请求正文

名称	类型	说明
properties.body	string minLength: 1	电子邮件模板正文。这应该是有效的 XDocument
properties.description	string	电子邮件模板的说明。
properties.parameters	EmailTemplateParametersContractProperties[]	电子邮件模板参数值。
properties.subject	string minLength: 1 maxLength: 1000	模板的主题。
properties.title	string	模板的标题。

响应

名称	类型	说明
200 OK	EmailTemplateContract	电子邮件模板已成功更新标头 ETag: string
Other Status Codes	ErrorResponse	描述作失败的原因的错误响应。

名称

类型

说明

200 OK

EmailTemplateContract

电子邮件模板已成功更新

标头

ETag: string

Other Status Codes

ErrorResponse

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

ApiManagementUpdateTemplate

示例请求

HTTP

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


{
  "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'\">\r\n          We are happy to let you know that your request to publish the $AppName application in the 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>"
  }
}

示例响应

状态代码:: 200

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

定义

名称	说明
EmailTemplateContract	电子邮件模板详细信息。
EmailTemplateParametersContractProperties	电子邮件模板参数协定。
EmailTemplateUpdateParameters	电子邮件模板更新参数。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
TemplateName	电子邮件模板名称标识符。

EmailTemplateContract

Object

电子邮件模板详细信息。

名称	类型	说明
id	string	资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	资源的名称
properties.body	string minLength: 1	电子邮件模板正文。这应该是有效的 XDocument
properties.description	string	电子邮件模板的说明。
properties.isDefault	boolean	模板是 API 管理提供的默认模板，还是已编辑。
properties.parameters	EmailTemplateParametersContractProperties[]	电子邮件模板参数值。
properties.subject	string minLength: 1 maxLength: 1000	模板的主题。
properties.title	string	模板的标题。
type	string	资源的类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

EmailTemplateParametersContractProperties

Object

电子邮件模板参数协定。

名称	类型	说明
description	string minLength: 1 maxLength: 256 pattern: ^[A-Za-z0-9-._]+$	模板参数说明。
name	string minLength: 1 maxLength: 256 pattern: ^[A-Za-z0-9-._]+$	模板参数名称。
title	string minLength: 1 maxLength: 4096	模板参数标题。

EmailTemplateUpdateParameters

Object

电子邮件模板更新参数。

名称	类型	说明
properties.body	string minLength: 1	电子邮件模板正文。这应该是有效的 XDocument
properties.description	string	电子邮件模板的说明。
properties.parameters	EmailTemplateParametersContractProperties[]	电子邮件模板参数值。
properties.subject	string minLength: 1 maxLength: 1000	模板的主题。
properties.title	string	模板的标题。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

TemplateName

枚举

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

值	说明
accountClosedDeveloper
applicationApprovedNotificationMessage
confirmSignUpIdentityDefault
emailChangeIdentityDefault
inviteUserNotificationMessage
newCommentNotificationMessage
newDeveloperNotificationMessage
newIssueNotificationMessage
passwordResetByAdminNotificationMessage
passwordResetIdentityDefault
purchaseDeveloperNotificationMessage
quotaLimitApproachingDeveloperNotificationMessage
rejectDeveloperNotificationMessage
requestDeveloperNotificationMessage

通过

Email Template - Update

URI 参数

请求头

请求正文

响应

安全性

azure_auth

作用域

示例

ApiManagementUpdateTemplate

示例请求

示例响应

定义

EmailTemplateContract

EmailTemplateParametersContractProperties

EmailTemplateUpdateParameters

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

TemplateName

其他资源