Meldingen en meldingssjablonen configureren in Azure API Management

VAN TOEPASSING OP: Ontwikkelaar | Basic | Basic v2 | Standaard | Standard v2 | Premium | Premium v2

Belangrijk

  • E-mailfunctionaliteit wordt niet ondersteund in de gratis proefversie van Azure-abonnementen.
    Deze mogelijkheid is volledig geblokkeerd en kan niet worden ingeschakeld tijdens de proefperiode.
  • De e-mailfunctionaliteit wordt tijdelijk drie dagen opgeschort nadat een service-instantie is aangemaakt.
    Deze tijdelijke beperking geldt voor betaalde Azure-abonnementen en wordt automatisch opgeheven na drie dagen.
  • De e-mailfunctionaliteit is tijdelijk opgeschort voor Pay-As-You-Go (PAYG) en MSDN Azure abonnementen.
    De e-mailmogelijkheid is tijdelijk uitgeschakeld voor deze abonnementstypen tot nader order.
  • Aanpassing van notificatietemplates wordt niet ondersteund in Pay-As-You-Go (PAYG) of MSDN Azure Abonnementen.
    Deze abonnementstypen bieden niet de mogelijkheid om ingebouwde notificatietemplates te wijzigen of te configureren, en deze beperking kan niet worden overruled.

Met Azure API Management kunt u e-mailmeldingen configureren voor specifieke gebeurtenissen en de e-mailsjablonen configureren die worden gebruikt om te communiceren met de beheerders en ontwikkelaars van een API Management-exemplaar. Dit artikel laat zien hoe u meldingen configureert voor de beschikbare gebeurtenissen en biedt een overzicht van het configureren van de e-mailsjablonen die voor deze gebeurtenissen worden gebruikt.

Vereisten

Als u geen exemplaar van de API Management-service hebt, voltooi dan de volgende quickstart: Een Azure API Management-exemplaar maken.

Ga naar uw API Management-instantie

  1. Zoek en selecteer API Management-services in Azure Portal:

    Schermopname van API Management-services in de zoekresultaten.

  2. Selecteer op de pagina API Management-services uw API Management-exemplaar:

    Schermopname van een API Management-exemplaar op de pagina API Management-services.

Meldingen configureren in Azure Portal

  1. Selecteer in het zijbalkmenu van je API Management-instantie Deployment + infrastructuur en selecteer vervolgens Notifications om de beschikbare meldingen te bekijken.

    Je kunt de volgende lijst met gebeurtenissen voor meldingen configureren.

    • Abonnementsaanvragen (waarvoor goedkeuring is vereist): de opgegeven e-mailontvangers en gebruikers ontvangen e-mailmeldingen over abonnementsaanvragen voor producten waarvoor goedkeuring is vereist.
    • Nieuwe abonnementen: de opgegeven e-mailontvangers en gebruikers ontvangen e-mailmeldingen over nieuwe productabonnementen.
    • Aanvragen voor toepassingsgalerie: de volgende e-mailontvangers en gebruikers ontvangen e-mailmeldingen wanneer nieuwe toepassingen worden verzonden naar de toepassingsgalerie.
    • BCC: de opgegeven e-mailontvangers en gebruikers ontvangen e-mailblind carbon kopieën van alle e-mailberichten die naar ontwikkelaars worden verzonden.
    • Nieuw probleem of opmerking: de volgende e-mailontvangers en gebruikers ontvangen e-mailmeldingen wanneer er een nieuw probleem of opmerking wordt verzonden in de ontwikkelaarsportal.
    • Accountbericht sluiten: de opgegeven e-mailontvangers en gebruikers ontvangen e-mailmeldingen wanneer een account wordt gesloten.
    • Limiet voor abonnementsquotum naderen: de opgegeven e-mailontvangers en gebruikers ontvangen e-mailmeldingen wanneer het abonnementsgebruik dicht bij het gebruiksquotum komt.
  2. Selecteer een melding en geef een of meer e-mailadressen op die moeten worden gewaarschuwd:

    • Als u het e-mailadres van de beheerder wilt toevoegen, selecteert u + Beheerder toevoegen.
    • Als u nog een e-mailadres wilt toevoegen, selecteert u + E-mailadres toevoegen, voert u een e-mailadres in en selecteert u Toevoegen.
    • Ga zo nodig door met het toevoegen van e-mailadressen.

    Schermopname die laat zien hoe u ontvangers van meldingen toevoegt in de portal.

Meldingssjablonen configureren

API Management biedt notificatietemplates voor de administratieve e-mailberichten die het automatisch naar ontwikkelaars stuurt wanneer zij toegang krijgen tot en gebruikmaken van de dienst. De volgende notificatietemplates zijn beschikbaar:

  • Afscheidsbrief voor ontwikkelaars
  • Quotumlimiet voor ontwikkelaars nadert melding
  • Welkomstbrief voor ontwikkelaars
  • Melding voor e-mailwijziging
  • Gebruiker uitnodigen
  • Bevestiging van nieuwe ontwikkelaarsaccount
  • Nieuw abonnement geactiveerd
  • Bevestiging van wachtwoordwijziging
  • Abonnementsaanvraag geweigerd
  • Ontvangen abonnementsaanvraag

Elke e-mailsjabloon heeft een onderwerpregel in tekst zonder opmaak en een hoofdtekstdefinitie in HTML-indeling. Je kunt elk item naar wens aanpassen.

Notitie

HTML-inhoud in een sjabloon moet goed zijn opgemaakt en voldoen aan de XML-specificatie. Het   teken is niet toegestaan.

Een meldingssjabloon weergeven en configureren in de portal:

  1. Selecteer Meldingssjablonen in het zijbalkmenu. Schermopname van meldingssjablonen in de portal.

  2. Selecteer een notificatiesjabloon en configureer het sjabloon met behulp van de editor.

    Schermopname van de editor voor meldingssjablonen in de portal.

    • De lijst Parameters bevat een lijst met parameters die, wanneer deze worden ingevoegd in het onderwerp of de hoofdtekst, worden vervangen door de aangewezen waarde wanneer het e-mailbericht wordt verzonden.
    • Om een parameter in te voegen, plaats je de cursor waar je de parameter wilt plaatsen en selecteer je de parameternaam.
  3. Om wijzigingen in het e-mailsjabloon op te slaan, kies je op Opslaan. Selecteer Afleggen om de wijzigingen te annuleren.

E-mailinstellingen configureren

U kunt algemene e-mailinstellingen wijzigen voor meldingen die worden verzonden vanuit uw API Management-exemplaar. U kunt het e-mailadres van de beheerder, de naam van de organisatie die meldingen verzendt en het e-mailadres van de afzender wijzigen.

Belangrijk

Als u het oorspronkelijke e-mailadres wijzigt, kan dit van invloed zijn op de mogelijkheid van geadresseerden om e-mail te ontvangen. Zie de overwegingen in de volgende sectie.

E-mailinstellingen wijzigen:

  1. Selecteer Meldingssjablonen in het zijbalkmenu.

  2. Selecteer E-mailinstellingen.

  3. Voer op de pagina Algemene e-mailinstellingen waarden in voor:

    • E-mailadres van beheerder: het e-mailadres voor het ontvangen van alle systeemmeldingen en andere geconfigureerde meldingen.

    • Organisatienaam: de naam van uw organisatie voor gebruik in de ontwikkelaarsportal en meldingen.

    • Oorspronkelijk e-mailadres: de waarde van de header From voor meldingen van het API Management-exemplaar. API Management verzendt meldingen namens dit oorspronkelijke adres.

      Schermopname van e-mailinstellingen voor API Management in de portal

  4. Selecteer Opslaan.

Overwegingen voor het wijzigen van het oorspronkelijke e-mailadres

Het wijzigen van het oorspronkelijke e-mailadres kan invloed hebben op ontvangers van e-mailmeldingen van API Management.

  • Verander het Van-adres: Wanneer je het oorspronkelijke e-mailadres verandert (bijvoorbeeld naar no-reply@contoso.com), is de noreply@contoso.com apimgmt-noreply@mail.windowsazure.com . Dit adres verschijnt omdat API Management de e-mail verstuurt, niet de e-mailserver van het oorspronkelijke e-mailadres.

  • E-mail die wordt verzonden naar de map ongewenste e-mail of spam: sommige geadresseerden ontvangen mogelijk niet de e-mailmeldingen van API Management of e-mailberichten worden verzonden naar de map ongewenste e-mail of spam. Dit probleem kan optreden afhankelijk van de SPF- of DKIM-e-mailauthenticatie-instellingen van de organisatie:

    • SPF-verificatie: E-mail geeft SPF-verificatie mogelijk niet meer door nadat u het oorspronkelijke e-mailadresdomein hebt gewijzigd. Maak de volgende TXT-record in de DNS-database van het domein dat is opgegeven in het e-mailadres om een geslaagde SPF-verificatie en -bezorging van e-mail te garanderen. Als het e-mailadres bijvoorbeeld noreply@contoso.com is, neem dan contact op met de beheerder van contoso.com om de volgende TXT-record toe te voegen: "v=spf1 include:spf.protection.outlook.com include:_spf-ssg-a.microsoft.com -all"

    • DKIM-verificatie: Voor het genereren van een geldige handtekening voor DKIM voor e-mailverificatie vereist API Management de persoonlijke sleutel die is gekoppeld aan het domein van het oorspronkelijke e-mailadres. Je kunt deze privésleutel echter momenteel niet uploaden in API Management. Om een geldige handtekening toe te wijzen, gebruikt API Management daarom de persoonlijke sleutel die aan het mail.windowsazure.com domein is gekoppeld.