Konfigurace oznámení a šablon oznámení ve službě Azure API Management

PLATÍ PRO: Vývojář | Základní | Základní v2 | Standardní | Standardní v2 | Premium | Premium v2

Azure API Management umožňuje nakonfigurovat e-mailová oznámení pro konkrétní události a nakonfigurovat e-mailové šablony, které se používají ke komunikaci se správci a vývojáři instance služby API Management. Tento článek ukazuje, jak nakonfigurovat oznámení pro dostupné události a poskytuje přehled konfigurace e-mailových šablon používaných pro tyto události.

Požadavky

Pokud nemáte instanci služby API Management, proveďte následující rychlý start: Vytvořte instanci služby Azure API Management.

Přejít k instanci služby API Management

1. Na portálu Azure vyhledejte a vyberte služby API Management:

   

2. Na stránce služby API Management vyberte instanci služby API Management:

   

Konfigurace oznámení na webu Azure Portal

1. V nabídce bočního panelu vaší instance služby API Management vyberte Nasazení a infrastruktura a pak zvolte Oznámení a zobrazte dostupná oznámení.

   Pro oznámení je možné nakonfigurovat následující seznam událostí.

   • Žádosti o předplatné (vyžadující schválení):: Zadaným příjemcům e-mailu a uživatelům se zobrazují e-mailová oznámení o žádostech o odběr pro produkty vyžadující schválení.
   • Nová předplatná: Určeným příjemcům e-mailu a uživatelům se zobrazují e-mailová oznámení o nových předplatných produktů.
   • Žádosti o galerii aplikací: Následující příjemci e-mailu a uživatelé obdrží e-mailová oznámení, když se do galerie aplikací odesílají nové aplikace.
   • Skrytá kopie: Uvedení příjemci e-mailu a uživatelé obdrží skryté kopie všech e-mailů, které jsou odesílány vývojářům.
   • Nový problém nebo komentář: Následující příjemci e-mailu a uživatelé dostanou e-mailová oznámení, když se na portálu pro vývojáře odešle nový problém nebo komentář.
   • Zpráva o zavření účtu: Zadaná příjemci e-mailu a uživatelé dostanou e-mailová oznámení, když je účet zavřený.
   • Blíží se limitu kvóty předplatného: Zadaná příjemci e-mailu a uživatelé dostanou e-mailová oznámení, když se využití předplatného blíží kvótě využití.

2. Vyberte oznámení a zadejte jednu nebo více e-mailových adres, které mají být oznámeny:

   • Pokud chcete přidat e-mailovou adresu správce, vyberte + Přidat správce.
   • Pokud chcete přidat další e-mailovou adresu, vyberte + Přidat e-mail, zadejte e-mailovou adresu a vyberte Přidat.
   • Podle potřeby pokračujte v přidávání e-mailových adres.

   

Konfigurace šablon oznámení

API Management poskytuje šablony oznámení pro e-mailové zprávy pro správu, které se automaticky odesílají vývojářům, když přistupují ke službě a používají ji. K dispozici jsou následující šablony oznámení:

• Dopis na rozloučenou vývojáře
• Oznámení o blížícím se překročení kvóty pro vývojáře
• Uvítací dopis pro vývojáře
• E-mailové oznámení o změně
• Pozvat uživatele
• Potvrzení nového vývojářského účtu
• Aktivované nové předplatné
• Potvrzení změny hesla
• Zamítnutá žádost o předplatné
• Přijatá žádost o předplatné

Každá šablona e-mailu má řádek předmětu ve formátu prostého textu a definici textu ve formátu HTML. Každou položku je možné přizpůsobit podle potřeby.

Poznámka:

Obsah HTML v šabloně musí být správně formátovaný a musí dodržovat specifikaci XML. Znak   není povolený.

Zobrazení a konfigurace šablony oznámení na portálu:

1. V nabídce bočního panelu vyberte Šablony oznámení.

2. Vyberte šablonu oznámení a nakonfigurujte ji pomocí editoru.

   

   • Seznam Parametry obsahuje seznam parametrů, které se při vložení do předmětu nebo textu nahradí určenou hodnotou při odeslání e-mailu.
   • Pokud chcete vložit parametr, umístěte kurzor na místo, kam chcete parametr přejít, a vyberte název parametru.

3. Pokud chcete uložit změny v šabloně e-mailu, vyberte Uložit nebo kliknutím na Zahodit změny zrušte.

Konfigurace nastavení e-mailu

Můžete upravit obecná e-mailová nastavení u oznámení, které se odesílají z vaší instance API Management. Můžete změnit e-mailovou adresu správce, název organizace odesílající oznámení a e-mailovou adresu, ze které se odesílají.

Důležité

Změna původní e-mailové adresy může ovlivnit schopnost příjemců přijímat e-maily. Podívejte se na důležité informace v následující části.

Úprava nastavení e-mailu:

1. V nabídce bočního panelu vyberte Šablony oznámení.

2. Vyberte nastavení e-mailu.

3. Na stránce Obecné nastavení e-mailu zadejte hodnoty pro:

   • E-mail správce: e-mailová adresa pro příjem všech systémových oznámení a dalších nakonfigurovaných oznámení.

   • Název organizace: název vaší organizace pro použití na portálu pro vývojáře a oznámení.

   • Původní e-mailová adresa: Hodnota hlavičky From pro oznámení z instance služby API Management. SLUŽBA API Management odesílá oznámení jménem této původní adresy.

     

4. Zvolte Uložit.

Důležité informace o změně původní e-mailové adresy

Příjemci e-mailových oznámení ze služby API Management můžou být ovlivněni při změně původní e-mailové adresy.

• Změňte adresu Odesílatele: Když změníte původní e-mailovou adresu (například na no-reply@contoso.com), hlavička adresy Od bude noreply@contoso.com apimgmt-noreply@mail.windowsazure.com. Důvodem je to, že služba API Management odesílá e-mail, a ne e-mailový server původní e-mailové adresy.

• E-maily odeslané do složky nevyžádané pošty nebo spamu: Někteří příjemci nemusí dostávat e-mailová oznámení ze služby API Management nebo e-maily se můžou posílat do složky nevyžádané pošty nebo spamu. K tomu může dojít v závislosti na nastavení ověřování E-mailu SPF nebo DKIM organizace:

  • Ověřování SPF: Po změně původní domény e-mailové adresy e-mail už nemusí projít ověřováním SPF. Pokud chcete zajistit úspěšné ověřování APF a doručení e-mailu, vytvořte následující záznam TXT v databázi DNS domény zadané v e-mailové adrese. Pokud je například e-mailová adresa noreply@contoso.com, obraťte se na správce contoso.com, aby přidal následující záznam TXT: "v=spf1 include:spf.protection.outlook.com include:_spf-ssg-a.microsoft.com -all"

  • Ověřování DKIM: K vygenerování platného podpisu pro DKIM pro ověřování e-mailů vyžaduje služba API Management privátní klíč přidružený k doméně původní e-mailové adresy. V současné době ale není možné tento privátní klíč nahrát do služby API Management. Proto k přiřazení platného podpisu používá služba API Management privátní klíč přidružený k mail.windowsazure.com doméně.

Související obsah

• Přehled portálu pro vývojáře
• Vytváření a používání skupin ke správě vývojářských účtů