Email Template - Update

リファレンス

サービス:: API Management

API バージョン:: 2024-05-01

API Management 電子メールテンプレートを更新します

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 Management サービスの名前。
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 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 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。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.body	string minLength: 1	電子メールテンプレートの本文。これは有効な XDocument である必要があります
properties.description	string	電子メールテンプレートの説明。
properties.isDefault	boolean	テンプレートが API Management によって提供される既定のテンプレートであるか、編集されているか。
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

その他のリソース