Så här konfigurerar du aviseringar och meddelandemallar i Azure API Management

GÄLLER FÖR: Utvecklare | Grundläggande | Basic v2 | Standard | Standard v2 | Premium | Premium v2

Viktigt!

  • E-postfunktionalitet stöds inte i gratis provperiod Azure-prenumerationer.
    Denna funktion är helt blockerad och kan inte aktiveras under provperioden.
  • E-postfunktionaliteten är tillfälligt avstängd i tre dagar efter att en tjänsteinstans har skapats.
    Denna tillfälliga begränsning gäller för betalda Azure-prenumerationer och hävs automatiskt efter tre dagar.
  • E-postfunktionen är tillfälligt avstängd för Pay-As-You-Go (PAYG) och MSDN Azure prenumerationer.
    E-postfunktionen är tillfälligt inaktiverad för dessa prenumerationstyper tills vidare.
  • Anpassning av notifikationsmallar stöds inte i Pay-As-You-Go (PAYG) eller MSDN Azure-prenumerationer.
    Dessa prenumerationstyper inkluderar inte möjligheten att ändra eller konfigurera inbyggda notifikationsmallar, och denna begränsning kan inte åsidosättas.

Med Azure API Management kan du konfigurera e-postaviseringar för specifika händelser och konfigurera de e-postmallar som används för att kommunicera med administratörer och utvecklare av en API Management-instans. Den här artikeln visar hur du konfigurerar meddelanden för tillgängliga händelser och ger en översikt över hur du konfigurerar de e-postmallar som används för dessa händelser.

Förutsättningar

Om du inte har någon API Management-tjänstinstans slutför du följande snabbstart: Skapa en Azure API Management-instans.

Gå till API Management-instansen

  1. I Azure-portalen söker du efter och väljer API Management-tjänster:

    Skärmbild som visar API Management-tjänster i sökresultaten.

  2. På sidan API Management Services väljer du din API Management-instans:

    Skärmbild som visar en API Management-instans på sidan API Management-tjänster.

Konfigurera meddelanden i Azure-portalen

  1. Från sidomenyn i din API Management-instans, välj Deployment + infrastruktur och välj sedan Notifieringar för att se tillgängliga notiser.

    Du kan konfigurera följande lista med händelser för notifikationer.

    • Prenumerationsbegäranden (kräver godkännande): De angivna e-postmottagarna och användarna får e-postaviseringar om prenumerationsbegäranden för produkter som kräver godkännande.
    • Nya prenumerationer: De angivna e-postmottagarna och användarna får e-postaviseringar om nya produktprenumerationer.
    • Begäranden om programgalleri: Följande e-postmottagare och användare får e-postmeddelanden när nya program skickas till programgalleriet.
    • Hemlig kopia: De angivna e-postmottagarna och användarna får blinda kopior av alla e-postmeddelanden som skickas till utvecklare.
    • Nytt problem eller kommentar: Följande e-postmottagare och användare får e-postaviseringar när ett nytt problem eller en kommentar skickas på utvecklarportalen.
    • Stäng kontomeddelande: De angivna e-postmottagarna och användarna får e-postmeddelanden när ett konto stängs.
    • Närmar sig prenumerationskvotgränsen: De angivna e-postmottagarna och användarna får e-postaviseringar när prenumerationsanvändningen närmar sig användningskvoten.
  2. Välj ett meddelande och ange en eller flera e-postadresser som ska meddelas:

    • Om du vill lägga till administratörens e-postadress väljer du + Lägg till administratör.
    • Om du vill lägga till ytterligare en e-postadress väljer du + Lägg till e-post, anger en e-postadress och väljer Lägg till.
    • Fortsätt att lägga till e-postadresser efter behov.

    Skärmbild som visar hur du lägger till meddelandemottagare i portalen.

Konfigurera meddelandemallar

API Management tillhandahåller notifikationsmallar för de administrativa e-postmeddelanden som automatiskt skickas till utvecklare när de får tillgång till och använder tjänsten. Följande notifikationsmallar finns tillgängliga:

  • Utvecklarens avskedsbrev
  • Meddelande om kvotbegränsning för utvecklare närmar sig
  • Välkomstbrev för utvecklare
  • Meddelande om ändring av e-post
  • Bjud in användare
  • Bekräftelse av nytt utvecklarkonto
  • Ny prenumeration aktiverad
  • Bekräftelse av lösenordsändring
  • Prenumerationsbegäran nekades
  • Prenumerationsbegäran har tagits emot

Varje e-postmall har en ämnesrad i oformaterad text och en brödtextdefinition i HTML-format. Du kan anpassa varje föremål som du vill.

Kommentar

HTML-innehåll i en mall måste vara välformat och följa XML-specifikationen. Tecknet   är inte tillåtet.

Så här visar och konfigurerar du en meddelandemall i portalen:

  1. I sidomenyn väljer du Meddelandemallar. Skärmbild av meddelandemallar i portalen.

  2. Välj en notifikationsmall och konfigurera mallen med hjälp av editorn.

    Skärmbild av meddelandemallsredigeraren i portalen.

    • Listan Parametrar innehåller en lista över parametrar som, när de infogas i ämnet eller brödtexten, ersätts med det avsedda värdet när e-postmeddelandet skickas.
    • För att infoga en parameter, placera markören där du vill att parametern ska placeras och välj parameterns namn.
  3. För att spara ändringar i e-postmallen, välj Spara. Välj Släng för att avbryta ändringarna.

Konfigurera e-postinställningar

Du kan ändra allmänna e-postinställningar för meddelanden som skickas från din API Management instans. Du kan ändra administratörens e-postadress, namnet på organisationen som skickar meddelanden och den ursprungliga e-postadressen.

Viktigt!

Om du ändrar den ursprungliga e-postadressen kan det påverka mottagarnas möjlighet att ta emot e-post. Se övervägandena i följande avsnitt.

Så här ändrar du e-postinställningarna:

  1. I sidomenyn väljer du Meddelandemallar.

  2. Välj E-postinställningar.

  3. På sidan Allmänna e-postinställningar anger du värden för:

    • Administratörs-e-post: e-postadressen för att ta emot alla systemaviseringar och andra konfigurerade meddelanden.

    • Organisationsnamn: namnet på din organisation för användning i utvecklarportalen och meddelanden.

    • Avsändande e-postadress: Värdet på From-huvudet för meddelanden från API Management-instansen. API Management skickar meddelanden för den här ursprungsadressen.

      Skärmbild av e-postinställningar för API Management i portalen

  4. Välj Spara.

Överväganden för att ändra den ursprungliga e-postadressen

Att ändra ursprungsadressen kan påverka mottagare av e-postnotiser från API Management.

  • Ändra From-adressen: När du ändrar ursprungsadressen (till exempel till no-reply@contoso.com), är noreply@contoso.com apimgmt-noreply@mail.windowsazure.com rubrik . Denna adress visas eftersom API Management skickar e-posten, inte e-postservern för ursprungsadressen.

  • E-post som skickas till skräppostmappen: Vissa mottagare kanske inte får e-postaviseringar från API Management, eller så kan e-postmeddelanden skickas till skräppostmappen. Detta problem kan uppstå beroende på organisationens SPF- eller DKIM-e-postautentiseringsinställningar:

    • SPF-autentisering: E-post kanske inte längre klarar SPF-autentisering när du har ändrat den ursprungliga e-postadressdomänen. För att säkerställa lyckad SPF-autentisering och leverans av e-post skapar du följande TXT-post i DNS-databasen för domänen som anges i e-postadressen. Om e-postadressen till exempel är noreply@contoso.com, kontaktar du administratören contoso.com för att lägga till följande TXT-record: "v=spf1 include:spf.protection.outlook.com include:_spf-ssg-a.microsoft.com -all"

    • DKIM-autentisering: För att generera en giltig signatur för DKIM för e-postautentisering kräver API Management den privata nyckeln som är associerad med domänen för den ursprungliga e-postadressen. Men du kan för närvarande inte ladda upp denna privata nyckel i API Management. För att tilldela en giltig signatur använder API Management därför den privata nyckel som är associerad med domänen mail.windowsazure.com .