Email Template - Get

  • Başvuru
Service:
API Management
API Version:
2022-08-01

Tanımlayıcısı tarafından belirtilen e-posta şablonunun ayrıntılarını alır.

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

URI Parametreleri

Name İçinde Gerekli Tür Description
resourceGroupName
 path True

string

Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir.
serviceName
 path True

string

API Management hizmetinin adı.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId
 path True

string

Hedef aboneliğin kimliği.
templateName
 path True

TemplateName

Şablon Adı Tanımlayıcısı'nı Email.
api-version
 query True

string

Bu işlem için kullanılacak API sürümü.

Yanıtlar

Name Tür Description
200 OK

EmailTemplateContract

Yanıt gövdesi belirtilen Email şablonunu içerir.

Headers

ETag: string
Other Status Codes

ErrorResponse

İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name Description
user_impersonation kullanıcı hesabınızın kimliğine bürünme

Örnekler

ApiManagementGetTemplate

Sample Request

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

Sample Response

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

Tanımlar

Name Description
EmailTemplateContract

şablon ayrıntılarını Email.
EmailTemplateParametersContractProperties

şablon parametresi sözleşme Email.
ErrorFieldContract

Hata Alanı sözleşmesi.
ErrorResponse

Hata Yanıtı.
TemplateName

Şablon Adı Tanımlayıcısı'nı Email.

EmailTemplateContract

şablon ayrıntılarını Email.

Name Tür Description
id

string

Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Kaynağın adı
properties.body

string

şablon gövdesini Email. Bu geçerli bir XDocument olmalıdır
properties.description

string

Email Şablonunun açıklaması.
properties.isDefault

boolean

Şablonun API Management tarafından sağlanan varsayılan şablon olup olmadığı veya düzenlendiği.
properties.parameters

EmailTemplateParametersContractProperties[]

Şablon Parametresi değerlerini Email.
properties.subject

string

Şablonun Konusu.
properties.title

string

Şablonun başlığı.
type

string

Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

EmailTemplateParametersContractProperties

şablon parametresi sözleşme Email.

Name Tür Description
description

string

Şablon parametresi açıklaması.
name

string

Şablon parametre adı.
title

string

Şablon parametresi başlığı.

ErrorFieldContract

Hata Alanı sözleşmesi.

Name Tür Description
code

string

Özellik düzeyi hata kodu.
message

string

Özellik düzeyi hatanın insan tarafından okunabilir gösterimi.
target

string

Özellik adı.

ErrorResponse

Hata Yanıtı.

Name Tür Description
error.code

string

Hizmet tanımlı hata kodu. Bu kod, yanıtta belirtilen HTTP hata kodu için bir alt durum görevi görür.
error.details

ErrorFieldContract[]

Doğrulama hatası durumunda istekte gönderilen geçersiz alanların listesi.
error.message

string

Hatanın insan tarafından okunabilir gösterimi.

TemplateName

Şablon Adı Tanımlayıcısı'nı Email.

Name Tür Description
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