Email Template - List By Service

Referentie

Service:: API Management

API-versie:: 2024-05-01

Hiermee haalt u alle e-mailsjablonen op

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

Met optionele parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/templates?$filter={$filter}&$top={$top}&$skip={$skip}&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.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.
$filter	query		string	\| Veld \| Gebruik \| Ondersteunde operators \| Ondersteunde functies \| \|-------------\|-------------\|-------------\|-------------\| \| naam \| filter \| ge, le, eq, ne, gt, lt \| subtekenreeks, bevat, startswith, endswith \|
$skip	query		integer (int32) minimum: 0	Het aantal records dat moet worden overgeslagen.
$top	query		integer (int32) minimum: 1	Aantal records dat moet worden geretourneerd.

Antwoorden

Name	Type	Description
200 OK	EmailTemplateCollection	Een verzameling van de e-mailsjabloon voor het opgegeven API Management-service-exemplaar.
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

ApiManagementListTemplates

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates/ApplicationApprovedNotificationMessage",
      "type": "Microsoft.ApiManagement/service/templates",
      "name": "ApplicationApprovedNotificationMessage",
      "properties": {
        "subject": "Your application $AppName is published in the application gallery",
        "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 application 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>",
        "title": "Application gallery submission approved",
        "description": "Developers who submitted their application for publication in the application gallery on the developer portal receive this email after their submission is approved.",
        "isDefault": true,
        "parameters": [
          {
            "name": "AppId",
            "title": "Application id"
          },
          {
            "name": "AppName",
            "title": "Application name"
          },
          {
            "name": "DevFirstName",
            "title": "Developer first name"
          },
          {
            "name": "DevLastName",
            "title": "Developer last name"
          },
          {
            "name": "OrganizationName",
            "title": "Organization name"
          },
          {
            "name": "DevPortalUrl",
            "title": "Developer portal URL"
          }
        ]
      }
    }
  ],
  "count": 1,
  "nextLink": ""
}

Definities

Name	Description
EmailTemplateCollection	Weergave van lijst met gepaginade e-mailsjablonen.
EmailTemplateContract	Details van e-mailsjabloon.
EmailTemplateParametersContractProperties	E-mailsjabloonparametercontract.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie

EmailTemplateCollection

Object

Weergave van lijst met gepaginade e-mailsjablonen.

Name	Type	Description
count	integer (int64)	Totaal aantal records voor alle pagina's.
nextLink	string	Koppeling naar volgende pagina indien aanwezig.
value	EmailTemplateContract[]	Paginawaarden.

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.

Delen via

Email Template - List By Service

URI-parameters

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

ApiManagementListTemplates

Voorbeeldaanvraag

Voorbeeldrespons

Definities

EmailTemplateCollection

EmailTemplateContract

EmailTemplateParametersContractProperties

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Aanvullende resources