Értesítések és értesítési sablonok konfigurálása az Azure API Managementben

  • Cikk

A KÖVETKEZŐKRE VONATKOZIK: Fejlesztő | Alapszintű | Alapszintű v2 | Standard | Standard v2 | Prémium

Az API Management lehetővé teszi az e-mail-értesítések konfigurálását adott eseményekhez, valamint azon e-mail sablonok konfigurálását, amelyek egy API Management-példány rendszergazdáival és fejlesztőivel való kommunikációhoz használhatók. Ez a cikk bemutatja, hogyan konfigurálhatja az értesítéseket az elérhető eseményekhez, és áttekintést nyújt az eseményekhez használt e-mail-sablonok konfigurálásáról.

Előfeltételek

Ha nem rendelkezik API Management szolgáltatáspéldánysal, végezze el az alábbi rövid útmutatót: Azure API Management-példány létrehozása.

Nyissa meg az API Management-példányát

  1. Az Azure Portalon keresse meg és válassza ki az API Management-szolgáltatásokat.

    API Management-szolgáltatások kiválasztása

  2. Az API Management-szolgáltatások lapon válassza ki az API Management-példányt.

    Az API Management-példány kiválasztása

Értesítések konfigurálása a portálon

  1. Az API Management-példány bal oldali navigációs sávjában válassza az Értesítések lehetőséget az elérhető értesítések megtekintéséhez.

    Az alábbi események listája konfigurálható értesítésekhez.

    • Előfizetési kérelmek (jóváhagyást igényel) – A megadott e-mail-címzettek és felhasználók e-mailben értesítést kapnak a jóváhagyást igénylő termékekre vonatkozó előfizetési kérelmekről.

    • Új előfizetések – A megadott e-mail-címzettek és felhasználók e-mailben értesítést kapnak az új termék-előfizetésekről.

    • Titkos másolat – A megadott e-mail-címzettek és felhasználók e-mailben kapják meg a fejlesztőknek küldött összes e-mail másolatát.

    • Fióküzenet bezárása – A megadott e-mail-címzettek és felhasználók e-mail-értesítéseket kapnak egy fiók bezárásakor.

    • Az előfizetési kvóta korlátjának megközelítése – A megadott e-mail-címzettek és felhasználók e-mailben értesítést kapnak, ha az előfizetés kihasználtsága megközelíti a használati kvótát.

      Feljegyzés

      Az értesítéseket a kvóta csak előfizetési szabályzattal aktiválja. A kulcsszabályzat szerinti kvóta nem generál értesítéseket.

  2. Jelöljön ki egy értesítést, és adjon meg egy vagy több értesítendő e-mail-címet:

    • A rendszergazdai e-mail-cím hozzáadásához válassza a + Rendszergazda hozzáadása lehetőséget.
    • Másik e-mail-cím hozzáadásához válassza a + E-mail hozzáadása lehetőséget, adjon meg egy e-mail-címet, és válassza a Hozzáadás lehetőséget.
    • Szükség szerint folytassa az e-mail-címek hozzáadását.

    Képernyőkép az értesítés címzettjeinek a portálon való hozzáadásáról

Értesítési sablonok konfigurálása

Az API Management értesítési sablonokat biztosít a rendszergazdai e-mailekhez, amelyeket a rendszer automatikusan küld a fejlesztőknek a szolgáltatás elérésekor és használatakor. A következő értesítési sablonok érhetők el:

  • Alkalmazáskatalógus beküldése jóváhagyva (elavult)
  • Fejlesztői búcsúlevél
  • A fejlesztői kvótakorlát közeledő értesítése
  • Fejlesztői üdvözlőlevél
  • E-mail változásértesítés
  • Felhasználó meghívása
  • Új megjegyzés hozzáadva egy problémához (elavult)
  • Új fejlesztői fiók megerősítése
  • Új probléma érkezett (elavult)
  • Új előfizetés aktiválva
  • Jelszómódosítás megerősítése
  • Az előfizetési kérelem elutasítva
  • Előfizetési kérelem érkezett

Minden e-mail-sablonhoz tartozik egy egyszerű szöveg, egy szövegtörzs definíciója HTML formátumban. Minden elem igény szerint testre szabható.

Feljegyzés

A sablon HTML-tartalmának jól formázottnak kell lennie, és be kell tartania az XML-specifikációt. A   karakter nem engedélyezett.

Értesítési sablon megtekintése és konfigurálása a portálon:

  1. A bal oldali menüben válassza az Értesítési sablonok lehetőséget. Képernyőkép az értesítési sablonokról a portálon

  2. Válasszon ki egy értesítési sablont, és konfigurálja a sablont a szerkesztővel.

    Képernyőkép az értesítési sablonszerkesztőről a portálon

    • A Paraméterek lista tartalmazza a paraméterek listáját, amelyek a tárgyba vagy törzsbe való beszúráskor az e-mail küldésekor a kijelölt értékre kerülnek.
    • Paraméter beszúrásához helyezze a kurzort oda, ahová a paramétert el szeretné helyezni, és válassza ki a paraméter nevét.

  3. Az e-mail-sablon módosításainak mentéséhez válassza a Mentés lehetőséget, vagy a módosítások visszavonásához válassza az Elvetés lehetőséget.

E-mail-beállítások konfigurálása

Módosíthatja az általános e-mail-beállításokat a API Management-példányból küldött értesítésekhez. Módosíthatja a rendszergazda e-mail-címét, az értesítéseket küldő szervezet nevét és a feladó e-mail-címét.

Fontos

A feladó e-mail-címének módosítása befolyásolhatja a címzettek e-mail-fogadási képességét. Tekintse meg a következő szakaszban ismertetett szempontokat .

Az e-mail-beállítások módosítása:

  1. A bal oldali menüben válassza az Értesítési sablonok lehetőséget.
  2. Válassza az E-mail beállítások lehetőséget.
  3. Az Általános e-mail-beállítások lapon adja meg a következő értékeket:

    • Rendszergazda istrator e-mail – az összes rendszerértesítés és egyéb konfigurált értesítés fogadásához szükséges e-mail-cím

    • Szervezet neve – a szervezet neve a fejlesztői portálon és értesítésekben való használatra

    • Feladó e-mail-cím – Az API Management-példány értesítéseinek fejlécének From értéke. Az API Management e feladó cím nevében küld értesítéseket.

      Képernyőkép az API Management e-mail beállításairól a portálon

  4. Válassza a Mentés lehetőséget.

A feladó e-mail-cím módosításának szempontjai

Az API Managementtől érkező e-mail-értesítések címzettjeire hatással lehet a feladó e-mail-címének módosítása.

  • Váltás Feladó címre – Ha módosítja az eredeti e-mail-címet (például), no-reply@contoso.coma From címfejléc lesz noreply@contoso.com apimgmt-noreply@mail.windowsazure.com. Ennek az az oka, hogy az e-mailt az API Management küldi el, és nem az eredeti e-mail-cím e-mail-kiszolgálója.

  • Levélszemét vagy Levélszemét mappára van állítva – Előfordulhat, hogy egyes címzettek nem kapják meg az e-mail-értesítéseket az API Managementtől, vagy e-maileket küldhetnek a Levélszemét vagy Levélszemét mappába. Ez a szervezet SPF- vagy DKIM-alapú e-mail-hitelesítési beállításaitól függően történhet:

    • SPF-hitelesítés – Előfordulhat, hogy az e-mail-cím nem ad át SPF-hitelesítést, miután módosította az eredeti e-mail-címtartományt. A sikeres SPF-hitelesítés és az e-mailek kézbesítésének biztosításához hozza létre a következő TXT rekordot az e-mail-címben megadott tartomány DNS-adatbázisában. Ha például az e-mail-cím az noreply@contoso.com, forduljon a contoso.com rendszergazdájához a következő TXT rekord hozzáadásához: "v=spf1 include:spf.protection.outlook.com include:_spf-ssg-a.microsoft.com -all"

    • DKIM-hitelesítés – Ahhoz, hogy érvényes aláírást hozzon létre a DKIM számára az e-mail-hitelesítéshez, az API Management megköveteli a feladó e-mail-cím tartományához társított titkos kulcsot. Ezt a titkos kulcsot azonban jelenleg nem lehet feltölteni az API Managementbe. Ezért érvényes aláírás hozzárendeléséhez az API Management a tartományhoz mail.windowsazure.com társított titkos kulcsot használja.

Következő lépések