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

Email Template - Create Or Update

参考

Service:: API Management

API Version:: 2022-08-01

汇报Email模板。

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

URI 参数

名称	在	必需	类型	说明
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	目标订阅的 ID。
templateName	path	True	TemplateName	Email模板名称标识符。
api-version	query	True	string	要用于此操作的 API 版本。

请求头

名称	必需	类型	说明
If-Match		string	实体的 ETag。创建实体时不需要，但在更新实体时是必需的。

请求正文

名称	类型	说明
properties.body	string	Email模板正文。这应该是有效的 XDocument
properties.description	string	Email模板的说明。
properties.parameters	EmailTemplateParametersContractProperties[]	Email模板参数值。
properties.subject	string	模板的主题。
properties.title	string	模板的标题。

响应

名称	类型	说明
200 OK	EmailTemplateContract	已成功更新Email模板。
201 Created	EmailTemplateContract	已成功更新Email模板。
Other Status Codes	ErrorResponse	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

ApiManagementCreateTemplate

Sample Request

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

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

import com.azure.resourcemanager.apimanagement.models.TemplateName;

/** Samples for EmailTemplate CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateTemplate.json
     */
    /**
     * Sample code: ApiManagementCreateTemplate.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementCreateTemplate(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .emailTemplates()
            .define(TemplateName.NEW_ISSUE_NOTIFICATION_MESSAGE)
            .withExistingService("rg1", "apimService1")
            .withSubject("Your request for $IssueName was successfully received.")
            .create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from typing import Any, IO, TYPE_CHECKING, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

if TYPE_CHECKING:
    # pylint: disable=unused-import,ungrouped-imports
    from .. import models as _models
"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_create_template.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.email_template.create_or_update(
        resource_group_name="rg1",
        service_name="apimService1",
        template_name="newIssueNotificationMessage",
        parameters={"properties": {"subject": "Your request for $IssueName was successfully received."}},
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateTemplate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateTemplate.json
func ExampleEmailTemplateClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewEmailTemplateClient().CreateOrUpdate(ctx, "rg1", "apimService1", armapimanagement.TemplateNameNewIssueNotificationMessage, armapimanagement.EmailTemplateUpdateParameters{
		Properties: &armapimanagement.EmailTemplateUpdateParameterProperties{
			Subject: to.Ptr("Your request for $IssueName was successfully received."),
		},
	}, &armapimanagement.EmailTemplateClientCreateOrUpdateOptions{IfMatch: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.EmailTemplateContract = armapimanagement.EmailTemplateContract{
	// 	Name: to.Ptr("NewIssueNotificationMessage"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/templates"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates/NewIssueNotificationMessage"),
	// 	Properties: &armapimanagement.EmailTemplateContractProperties{
	// 		Description: to.Ptr("This email is sent to developers after they create a new topic on the Issues page of the developer portal."),
	// 		Body: to.Ptr("<!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>"),
	// 		IsDefault: to.Ptr(false),
	// 		Parameters: []*armapimanagement.EmailTemplateParametersContractProperties{
	// 			{
	// 				Name: to.Ptr("DevFirstName"),
	// 				Title: to.Ptr("Developer first name"),
	// 			},
	// 			{
	// 				Name: to.Ptr("DevLastName"),
	// 				Title: to.Ptr("Developer last name"),
	// 			},
	// 			{
	// 				Name: to.Ptr("IssueId"),
	// 				Title: to.Ptr("Issue id"),
	// 			},
	// 			{
	// 				Name: to.Ptr("IssueName"),
	// 				Title: to.Ptr("Issue name"),
	// 			},
	// 			{
	// 				Name: to.Ptr("OrganizationName"),
	// 				Title: to.Ptr("Organization name"),
	// 			},
	// 			{
	// 				Name: to.Ptr("DevPortalUrl"),
	// 				Title: to.Ptr("Developer portal URL"),
	// 		}},
	// 		Subject: to.Ptr("Your request for $IssueName was successfully received."),
	// 		Title: to.Ptr("New issue received"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Updates an Email Template.
 *
 * @summary Updates an Email Template.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateTemplate.json
 */
async function apiManagementCreateTemplate() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const templateName = "newIssueNotificationMessage";
  const parameters = {
    subject: "Your request for $IssueName was successfully received.",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.emailTemplate.createOrUpdate(
    resourceGroupName,
    serviceName,
    templateName,
    parameters
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 201

{
  "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"
      }
    ]
  }
}

Status code:: 200

{
  "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	Email模板详细信息。
EmailTemplateParametersContractProperties	Email模板参数协定。
EmailTemplateUpdateParameters	Email模板更新参数。
ErrorFieldContract	错误字段协定。
ErrorResponse	错误响应。
TemplateName	Email模板名称标识符。

EmailTemplateContract

Email模板详细信息。

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

EmailTemplateParametersContractProperties

Email模板参数协定。

名称	类型	说明
description	string	模板参数说明。
name	string	模板参数名称。
title	string	模板参数标题。

EmailTemplateUpdateParameters

Email模板更新参数。

名称	类型	说明
properties.body	string	Email模板正文。这应该是有效的 XDocument
properties.description	string	Email模板的说明。
properties.parameters	EmailTemplateParametersContractProperties[]	Email模板参数值。
properties.subject	string	模板的主题。
properties.title	string	模板的标题。

ErrorFieldContract

错误字段协定。

名称	类型	说明
code	string	属性级错误代码。
message	string	属性级错误的可读表示形式。
target	string	属性名称。

ErrorResponse

错误响应。

名称	类型	说明
error.code	string	服务定义的错误代码。此代码用作响应中指定的 HTTP 错误代码的子状态。
error.details	ErrorFieldContract[]	在发生验证错误时，请求中发送的无效字段列表。
error.message	string	错误的用户可读表示形式。

TemplateName

Email模板名称标识符。

名称	类型	说明
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

Email Template - Create Or Update

URI 参数

请求头

请求正文

响应

安全性

azure_auth

Scopes

示例

ApiManagementCreateTemplate

Sample Request

Sample Response

定义

EmailTemplateContract

EmailTemplateParametersContractProperties

EmailTemplateUpdateParameters

ErrorFieldContract

ErrorResponse

TemplateName

其他资源