Email Template - List By Service

服務:

API Management

API 版本:

2024-05-01

取得所有電子郵件範本

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

含選擇性參數:

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 參數

名稱	位於	必要	類型	Description
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)	目標訂用帳戶的標識碼。 此值必須是 UUID。
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。
$filter	query		string	|欄位 |使用量 |支持的運算子 |支援的函式 | |-------------|-------------|-------------|-------------| |name |filter |ge， le， eq， ne， gt， lt |substringof、contains、startswith、endswith |
$skip	query		integer (int32) minimum: 0	要略過的記錄數目。
$top	query		integer (int32) minimum: 1	要傳回的記錄數目。

回應

名稱	類型	Description
200 OK	EmailTemplateCollection	指定之 API 管理服務實例的電子郵件範本集合。
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

ApiManagementListTemplates

範例要求

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

Java

/**
 * Samples for EmailTemplate ListByService.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/
     * ApiManagementListTemplates.json
     */
    /**
     * Sample code: ApiManagementListTemplates.
     * 
     * @param manager Entry point to ApiManagementManager.
     */
    public static void
        apiManagementListTemplates(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.emailTemplates().listByService("rg1", "apimService1", null, null, null,
            com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_list_templates.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="00000000-0000-0000-0000-000000000000",
    )

    response = client.email_template.list_by_service(
        resource_group_name="rg1",
        service_name="apimService1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementListTemplates.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

Go

package armapimanagement_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e436160e64c0f8d7fb20d662be2712f71f0a7ef5/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementListTemplates.json
func ExampleEmailTemplateClient_NewListByServicePager() {
	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)
	}
	pager := clientFactory.NewEmailTemplateClient().NewListByServicePager("rg1", "apimService1", &armapimanagement.EmailTemplateClientListByServiceOptions{Filter: nil,
		Top:  nil,
		Skip: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.EmailTemplateCollection = armapimanagement.EmailTemplateCollection{
		// 	Count: to.Ptr[int64](1),
		// 	Value: []*armapimanagement.EmailTemplateContract{
		// 		{
		// 			Name: to.Ptr("ApplicationApprovedNotificationMessage"),
		// 			Type: to.Ptr("Microsoft.ApiManagement/service/templates"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates/ApplicationApprovedNotificationMessage"),
		// 			Properties: &armapimanagement.EmailTemplateContractProperties{
		// 				Description: to.Ptr("Developers who submitted their application for publication in the application gallery on the developer portal receive this email after their submission is approved."),
		// 				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'\">\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>"),
		// 				IsDefault: to.Ptr(true),
		// 				Parameters: []*armapimanagement.EmailTemplateParametersContractProperties{
		// 					{
		// 						Name: to.Ptr("AppId"),
		// 						Title: to.Ptr("Application id"),
		// 					},
		// 					{
		// 						Name: to.Ptr("AppName"),
		// 						Title: to.Ptr("Application name"),
		// 					},
		// 					{
		// 						Name: to.Ptr("DevFirstName"),
		// 						Title: to.Ptr("Developer first name"),
		// 					},
		// 					{
		// 						Name: to.Ptr("DevLastName"),
		// 						Title: to.Ptr("Developer last name"),
		// 					},
		// 					{
		// 						Name: to.Ptr("OrganizationName"),
		// 						Title: to.Ptr("Organization name"),
		// 					},
		// 					{
		// 						Name: to.Ptr("DevPortalUrl"),
		// 						Title: to.Ptr("Developer portal URL"),
		// 				}},
		// 				Subject: to.Ptr("Your application $AppName is published in the application gallery"),
		// 				Title: to.Ptr("Application gallery submission approved"),
		// 			},
		// 	}},
		// }
	}
}

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

JavaScript

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

/**
 * This sample demonstrates how to Gets all email templates
 *
 * @summary Gets all email templates
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementListTemplates.json
 */
async function apiManagementListTemplates() {
  const subscriptionId =
    process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.emailTemplate.listByService(resourceGroupName, serviceName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.ApiManagement;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementListTemplates.json
// this example is just showing the usage of "EmailTemplate_ListByService" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);

// get the collection of this ApiManagementEmailTemplateResource
ApiManagementEmailTemplateCollection collection = apiManagementService.GetApiManagementEmailTemplates();

// invoke the operation and iterate over the result
await foreach (ApiManagementEmailTemplateResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    ApiManagementEmailTemplateData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

範例回覆

狀態碼:

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": ""
}

定義

名稱	Description
EmailTemplateCollection	分頁電子郵件範本清單表示法。
EmailTemplateContract	電子郵件範本詳細數據。
EmailTemplateParametersContractProperties	電子郵件範本參數合約。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應

EmailTemplateCollection

Object

分頁電子郵件範本清單表示法。

名稱	類型	Description
count	integer (int64)	所有頁面的總記錄計數數目。
nextLink	string	如果有的話，下一頁連結。
value	EmailTemplateContract[]	頁面值。

EmailTemplateContract

Object

電子郵件範本詳細數據。

名稱	類型	Description
id	string	資源的完整資源標識碼。 例如 - /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
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	範本參數標題。

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。