Email Template - List By Service

Odwołanie

Usługa:: API Management

Wersja interfejsu API:: 2024-05-01

Pobiera wszystkie szablony wiadomości e-mail

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

Z parametrami opcjonalnymi:

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

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.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.
$filter	query		string	\| Pole \| Użycie \| Obsługiwane operatory \| Obsługiwane funkcje \| \|-------------\|-------------\|-------------\|-------------\| \| name \| filter \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \|
$skip	query		integer (int32) minimum: 0	Liczba rekordów do pominięcia.
$top	query		integer (int32) minimum: 1	Liczba rekordów do zwrócenia.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	EmailTemplateCollection	Kolekcja szablonu wiadomości e-mail dla określonego wystąpienia usługi API Management.
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

ApiManagementListTemplates

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa	Opis
EmailTemplateCollection	Reprezentacja listy szablonów stron poczty e-mail.
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

EmailTemplateCollection

Objekt

Reprezentacja listy szablonów stron poczty e-mail.

Nazwa	Typ	Opis
count	integer (int64)	Łączna liczba rekordów na wszystkich stronach.
nextLink	string	Jeśli istnieje, link następnej strony.
value	EmailTemplateContract[]	Wartości stron.

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.

Udostępnij za pośrednictwem

Email Template - List By Service

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

ApiManagementListTemplates

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

EmailTemplateCollection

EmailTemplateContract

EmailTemplateParametersContractProperties

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Dodatkowe zasoby