Udostępnij za pośrednictwem

Email Template - Get

  • Odwołanie
Usługa:
API Management
Wersja interfejsu API:
2024-05-01

Pobiera szczegóły szablonu wiadomości e-mail określonego przez jego identyfikator.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
serviceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

Nazwa usługi API Management.
subscriptionId
 path True

string (uuid)

Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
templateName
 path True

TemplateName

Identyfikator nazwy szablonu wiadomości e-mail.
api-version
 query True

string

minLength: 1

Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa Typ Opis
200 OK

EmailTemplateContract

Treść odpowiedzi zawiera określony szablon wiadomości e-mail.

Nagłówki

ETag: string
Other Status Codes

ErrorResponse

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

ApiManagementGetTemplate

Przykładowe żądanie

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates/newIssueNotificationMessage?api-version=2024-05-01

Przykładowa odpowiedź

Kod stanu:
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"
      }
    ]
  }
}

Definicje

Nazwa Opis
EmailTemplateContract

Szczegóły szablonu wiadomości e-mail.
EmailTemplateParametersContractProperties

Kontrakt parametru szablonu wiadomości e-mail.
ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail

Szczegóły błędu.
ErrorResponse

Odpowiedź na błąd
TemplateName

Identyfikator nazwy szablonu wiadomości e-mail.

EmailTemplateContract

Objekt

Szczegóły szablonu wiadomości e-mail.

Nazwa Typ Opis
id

string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Nazwa zasobu
properties.body

string

minLength: 1

Treść szablonu wiadomości e-mail. Powinien to być prawidłowy dokument XDocument
properties.description

string

Opis szablonu wiadomości e-mail.
properties.isDefault

boolean

Czy szablon jest domyślnym szablonem udostępnianym przez usługę API Management, czy też został edytowany.
properties.parameters

EmailTemplateParametersContractProperties[]

Wartości parametrów szablonu wiadomości e-mail.
properties.subject

string

minLength: 1
maxLength: 1000

Temat szablonu.
properties.title

string

Tytuł szablonu.
type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

EmailTemplateParametersContractProperties

Objekt

Kontrakt parametru szablonu wiadomości e-mail.

Nazwa Typ Opis
description

string

minLength: 1
maxLength: 256
pattern: ^[A-Za-z0-9-._]+$

Opis parametru szablonu.
name

string

minLength: 1
maxLength: 256
pattern: ^[A-Za-z0-9-._]+$

Nazwa parametru szablonu.
title

string

minLength: 1
maxLength: 4096

Tytuł parametru szablonu.

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa Typ Opis
info

object

Dodatkowe informacje.
type

string

Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa Typ Opis
additionalInfo

ErrorAdditionalInfo[]

Dodatkowe informacje o błędzie.
code

string

Kod błędu.
details

ErrorDetail[]

Szczegóły błędu.
message

string

Komunikat o błędzie.
target

string

Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa Typ Opis
error

ErrorDetail

Obiekt błędu.

TemplateName

Wyliczanie

Identyfikator nazwy szablonu wiadomości e-mail.

Wartość Opis
accountClosedDeveloper
applicationApprovedNotificationMessage
confirmSignUpIdentityDefault
emailChangeIdentityDefault
inviteUserNotificationMessage
newCommentNotificationMessage
newDeveloperNotificationMessage
newIssueNotificationMessage
passwordResetByAdminNotificationMessage
passwordResetIdentityDefault
purchaseDeveloperNotificationMessage
quotaLimitApproachingDeveloperNotificationMessage
rejectDeveloperNotificationMessage
requestDeveloperNotificationMessage