다음을 통해 공유

Email Template - Update

  • 참조
서비스:
API Management
API 버전:
2021-08-01

API Management 전자 메일 템플릿 업데이트

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

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
resourceGroupName
 path True

string

리소스 그룹의 이름입니다.
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

Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명입니다. 구독 ID는 모든 서비스 호출에 대한 URI의 일부를 형성합니다.
templateName
 path True

TemplateName

전자 메일 템플릿 이름 식별자입니다.
api-version
 query True

string

클라이언트 요청과 함께 사용할 API의 버전입니다.

요청 헤더

Name 필수 형식 Description
If-Match True

string

엔터티의 ETag입니다. ETag는 GET 요청의 헤더 응답에서 현재 엔터티 상태와 일치해야 합니다. 그렇지 않으면 무조건 업데이트의 경우 *여야 합니다.

요청 본문

Name 형식 Description
properties.body

string

minLength: 1

전자 메일 템플릿 본문입니다. 유효한 XDocument여야 합니다.
properties.description

string

전자 메일 템플릿에 대한 설명입니다.
properties.parameters

EmailTemplateParametersContractProperties[]

전자 메일 템플릿 매개 변수 값입니다.
properties.subject

string

minLength: 1
maxLength: 1000

템플릿의 제목입니다.
properties.title

string

서식 파일의 제목입니다.

응답

Name 형식 Description
200 OK

EmailTemplateContract

전자 메일 템플릿이 성공적으로 업데이트됨

헤더

ETag: string
Other Status Codes

ErrorResponse

작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name Description
user_impersonation 사용자 계정 가장

예제

ApiManagementUpdateTemplate

샘플 요청

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates/newIssueNotificationMessage?api-version=2021-08-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/subid/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"
      }
    ]
  }
}

정의

Name Description
EmailTemplateContract

전자 메일 템플릿 세부 정보입니다.
EmailTemplateParametersContractProperties

전자 메일 템플릿 매개 변수 계약입니다.
EmailTemplateUpdateParameters

전자 메일 템플릿 업데이트 매개 변수입니다.
ErrorFieldContract

오류 필드 계약입니다.
ErrorResponse

오류 응답입니다.
TemplateName

전자 메일 템플릿 이름 식별자입니다.

EmailTemplateContract

Object

전자 메일 템플릿 세부 정보입니다.

Name 형식 Description
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

전자 메일 템플릿 매개 변수 계약입니다.

Name 형식 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

템플릿 매개 변수 제목입니다.

EmailTemplateUpdateParameters

Object

전자 메일 템플릿 업데이트 매개 변수입니다.

Name 형식 Description
properties.body

string

minLength: 1

전자 메일 템플릿 본문입니다. 유효한 XDocument여야 합니다.
properties.description

string

전자 메일 템플릿에 대한 설명입니다.
properties.parameters

EmailTemplateParametersContractProperties[]

전자 메일 템플릿 매개 변수 값입니다.
properties.subject

string

minLength: 1
maxLength: 1000

템플릿의 제목입니다.
properties.title

string

서식 파일의 제목입니다.

ErrorFieldContract

Object

오류 필드 계약입니다.

Name 형식 Description
code

string

속성 수준 오류 코드입니다.
message

string

사람이 읽을 수 있는 속성 수준 오류 표현입니다.
target

string

속성 이름입니다.

ErrorResponse

Object

오류 응답입니다.

Name 형식 Description
error.code

string

서비스 정의 오류 코드입니다. 이 코드는 응답에 지정된 HTTP 오류 코드의 하위 상태로 사용됩니다.
error.details

ErrorFieldContract[]

유효성 검사 오류가 발생한 경우 요청에 잘못된 필드 보내기 목록입니다.
error.message

string

사람이 읽을 수 있는 오류 표현입니다.

TemplateName

열거형

전자 메일 템플릿 이름 식별자입니다.

값 Description
accountClosedDeveloper
applicationApprovedNotificationMessage
confirmSignUpIdentityDefault
emailChangeIdentityDefault
inviteUserNotificationMessage
newCommentNotificationMessage
newDeveloperNotificationMessage
newIssueNotificationMessage
passwordResetByAdminNotificationMessage
passwordResetIdentityDefault
purchaseDeveloperNotificationMessage
quotaLimitApproachingDeveloperNotificationMessage
rejectDeveloperNotificationMessage
requestDeveloperNotificationMessage