Email Template - Get

Referentie

Service:: API Management

API-versie:: 2024-05-01

Hiermee haalt u de details op van de e-mailsjabloon die is opgegeven met de id.

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	De naam van de API Management-service.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
templateName	path	True	TemplateName	E-mailsjabloonnaam-id.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	EmailTemplateContract	De hoofdtekst van het antwoord bevat de opgegeven e-mailsjabloon. Kopteksten ETag: string
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Name

Type

Description

200 OK

EmailTemplateContract

De hoofdtekst van het antwoord bevat de opgegeven e-mailsjabloon.

Kopteksten

ETag: string

Other Status Codes

ErrorResponse

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ApiManagementGetTemplate

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

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

Definities

Name	Description
EmailTemplateContract	Details van e-mailsjabloon.
EmailTemplateParametersContractProperties	E-mailsjabloonparametercontract.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
TemplateName	E-mailsjabloonnaam-id.

EmailTemplateContract

Object

Details van e-mailsjabloon.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties.body	string minLength: 1	Hoofdtekst van e-mailsjabloon. Dit moet een geldig XDocument zijn
properties.description	string	Beschrijving van de e-mailsjabloon.
properties.isDefault	boolean	Of de sjabloon nu de standaardsjabloon is die wordt geleverd door API Management of is bewerkt.
properties.parameters	EmailTemplateParametersContractProperties[]	Parameterwaarden voor e-mailsjabloon.
properties.subject	string minLength: 1 maxLength: 1000	Onderwerp van de sjabloon.
properties.title	string	Titel van de sjabloon.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

EmailTemplateParametersContractProperties

Object

E-mailsjabloonparametercontract.

Name	Type	Description
description	string minLength: 1 maxLength: 256 pattern: ^[A-Za-z0-9-._]+$	Beschrijving van sjabloonparameter.
name	string minLength: 1 maxLength: 256 pattern: ^[A-Za-z0-9-._]+$	Naam van sjabloonparameter.
title	string minLength: 1 maxLength: 4096	Sjabloonparametertitel.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

TemplateName

Inventarisatie

E-mailsjabloonnaam-id.

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

Delen via

Email Template - Get

URI-parameters

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

ApiManagementGetTemplate

Voorbeeldaanvraag

Voorbeeldrespons

Definities

EmailTemplateContract

EmailTemplateParametersContractProperties

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

TemplateName

Aanvullende resources