Jak skonfigurować powiadomienia i szablony powiadomień w usłudze Azure API Management

DOTYCZY: Developer | Podstawowa | Podstawowa, wersja 2 | Standardowa | Standardowa, wersja 2 | Premium | Premium, wersja 2

Ważne

  • Funkcja e-maila nie jest wspierana w darmowych subskrypcjach próbnych Azure subskrypcjach.
    Ta funkcja jest całkowicie zablokowana i nie można jej włączyć podczas okresu próbnego.
  • Funkcjonalność poczty elektronicznej jest tymczasowo zawieszona na trzy dni po utworzeniu instancji usługi.
    To tymczasowe ograniczenie dotyczy płatnych subskrypcji Azure i jest automatycznie znoszone po trzech dniach.
  • Funkcja poczty elektronicznej jest tymczasowo zawieszona dla subskrypcji Pay-As-You-Go (PAYG) oraz MSDN Azure.
    Możliwość obsługi poczty elektronicznej jest tymczasowo wyłączona dla tych typów subskrypcji do odwołania.
  • Personalizacja szablonów powiadomień nie jest wspierana w subskrypcjach Pay-As-You-Go (PAYG) ani MSDN Azure.
    Te typy subskrypcji nie obejmują możliwości modyfikacji ani konfiguracji wbudowanych szablonów powiadomień, a tego ograniczenia nie da się obejść.

Usługa Azure API Management umożliwia konfigurowanie powiadomień e-mail dla określonych zdarzeń oraz konfigurowanie szablonów poczty e-mail używanych do komunikowania się z administratorami i deweloperami wystąpienia usługi API Management. W tym artykule pokazano, jak skonfigurować powiadomienia dla dostępnych zdarzeń i przedstawiono omówienie konfigurowania szablonów wiadomości e-mail używanych na potrzeby tych zdarzeń.

Wymagania wstępne

Jeśli nie masz wystąpienia usługi API Management, wykonaj czynności opisane w następującym przewodniku „Szybki start”: Tworzenie wystąpienia usługi Azure API Management.

Przejdź do wystąpienia API Management

  1. W witrynie Azure Portal wyszukaj i wybierz pozycję Usługi API Management:

    Zrzut ekranu przedstawiający usługi API Management w wynikach wyszukiwania.

  2. Na stronie usług API Management wybierz wystąpienie usługi API Management:

    Zrzut ekranu przedstawiający instancję zarządzania API na stronie usług zarządzania API.

Konfigurowanie powiadomień w witrynie Azure Portal

  1. W menu bocznym instancji zarządzania API wybierz Deployment + infrastructure, a następnie wybierz Notifications , aby zobaczyć dostępne powiadomienia.

    Możesz skonfigurować następującą listę zdarzeń dla powiadomień.

    • Żądania subskrypcji (wymagające zatwierdzenia): określeni adresaci poczty e-mail i użytkownicy otrzymują powiadomienia e-mail dotyczące żądań subskrypcji dotyczących produktów wymagających zatwierdzenia.
    • Nowe subskrypcje: określeni adresaci poczty e-mail i użytkownicy otrzymują powiadomienia e-mail dotyczące nowych subskrypcji produktów.
    • Żądania galerii aplikacji: następujący adresaci poczty e-mail i użytkownicy otrzymują powiadomienia e-mail po przesłaniu nowych aplikacji do galerii aplikacji.
    • BCC: Określeni odbiorcy i użytkownicy otrzymują kopie ukryte wszystkich wiadomości e-mail wysyłanych do deweloperów.
    • Nowy problem lub komentarz: następujący adresaci poczty e-mail i użytkownicy otrzymują powiadomienia e-mail po przesłaniu nowego problemu lub komentarza w portalu deweloperów.
    • Zamknij wiadomość o koncie: określeni adresaci poczty e-mail i użytkownicy otrzymują powiadomienia e-mail po zamknięciu konta.
    • Zbliżanie się do limitu przydziału subskrypcji: określeni adresaci poczty e-mail i użytkownicy otrzymują powiadomienia e-mail, gdy użycie subskrypcji zbliża się do limitu przydziału użycia.
  2. Wybierz powiadomienie i określ co najmniej jeden adres e-mail, który ma zostać powiadomiony:

    • Aby dodać adres e-mail administratora, wybierz pozycję + Dodaj administratora.
    • Aby dodać kolejny adres e-mail, wybierz pozycję + Dodaj wiadomość e-mail, wprowadź adres e-mail i wybierz pozycję Dodaj.
    • Kontynuuj dodawanie adresów e-mail zgodnie z potrzebami.

    Zrzut ekranu przedstawiający sposób dodawania adresatów powiadomień w portalu.

Konfigurowanie szablonów powiadomień

API Management udostępnia szablony powiadomień dla administracyjnych wiadomości e-mail, które automatycznie wysyła do deweloperów podczas korzystania z usługi. Dostępne są następujące szablony powiadomień:

  • List pożegnalny dla deweloperów
  • Powiadomienie: zbliża się limit przydziału dla deweloperów
  • List powitalny dla deweloperów
  • Powiadomienie o zmianie wiadomości e-mail
  • Zaproś użytkownika
  • Potwierdzenie nowego konta dewelopera
  • Aktywowano nową subskrypcję
  • Potwierdzenie zmiany hasła
  • Odrzucono żądanie subskrypcji
  • Odebrano żądanie subskrypcji

Każdy szablon wiadomości e-mail ma wiersz tematu w postaci zwykłego tekstu i definicję treści w formacie HTML. Możesz dostosować każdy przedmiot według uznania.

Uwaga

Zawartość HTML w szablonie musi być dobrze sformułowana i zgodna ze specyfikacją XML. Znak   nie jest dozwolony.

Aby wyświetlić i skonfigurować szablon powiadomienia w portalu:

  1. W menu paska bocznego wybierz pozycję Szablony powiadomień. Zrzut ekranu przedstawiający szablony powiadomień w portalu.

  2. Wybierz szablon powiadomień i skonfiguruj go za pomocą edytora.

    Zrzut ekranu przedstawiający edytor szablonów powiadomień w portalu.

    • Lista Parametry zawiera listę parametrów, które po wstawieniu do tematu lub treści są zastępowane przez wyznaczoną wartość podczas wysyłania wiadomości e-mail.
    • Aby wstawić parametr, umieść kursor tam, gdzie chcesz, aby parametr się znaleźl, i wybierz nazwę parametru.
  3. Aby zapisać zmiany w szablonie e-maila, wybierz Zapisz. Wybierz Odrzuć, aby anulować zmiany.

Konfigurowanie ustawień poczty e-mail

Możesz zmodyfikować ogólne ustawienia poczty e-mail dla powiadomień wysyłanych z instancji usługi API Management. Możesz zmienić adres e-mail administratora, nazwę organizacji wysyłającej powiadomienia oraz źródłowy adres e-mail.

Ważne

Zmiana źródłowego adresu e-mail może mieć wpływ na możliwość odbierania wiadomości e-mail przez adresatów. Zapoznaj się z zagadnieniami w poniższej sekcji.

Aby zmodyfikować ustawienia poczty e-mail:

  1. W menu paska bocznego wybierz pozycję Szablony powiadomień.

  2. Wybierz pozycję Ustawienia poczty e-mail.

  3. Na stronie Ogólne ustawienia poczty e-mail wprowadź wartości dla:

    • Adres e-mail administratora: adres e-mail do odbierania wszystkich powiadomień systemowych i innych skonfigurowanych powiadomień.

    • Nazwa organizacji: nazwa organizacji do użycia w portalu deweloperów i powiadomieniach.

    • Źródłowy adres e-mail: wartość nagłówka From dla powiadomień z instancji zarządzania API. Usługa API Management wysyła powiadomienia w imieniu tego adresu źródłowego.

      Zrzut ekranu przedstawiający ustawienia poczty e-mail usługi API Management w portalu

  4. Wybierz pozycję Zapisz.

Zagadnienia dotyczące zmiany źródłowego adresu e-mail

Zmiana adresu e-mail może wpłynąć na odbiorców powiadomień e-mail z API Management.

  • Zmień adres From: Gdy zmieniasz adres e-mail pochodzący (np. na no-reply@contoso.com), nagłówek adresu From to noreply@contoso.com apimgmt-noreply@mail.windowsazure.com. Ten adres pojawia się, ponieważ API Management wysyła e-mail, a nie serwer poczty adresu źródłowego.

  • Wiadomość e-mail wysłana do folderu wiadomości-śmieci lub spamu: niektórzy adresaci mogą nie otrzymywać powiadomień e-mail z usługi API Management lub wiadomości e-mail mogą zostać wysłane do folderu wiadomości-śmieci lub spamu. Ten problem może wystąpić w zależności od ustawień uwierzytelniania e-mail SPF lub DKIM w organizacji:

    • Uwierzytelnianie SPF: wiadomość e-mail może przestać przechodzić przez uwierzytelnianie SPF po zmianie domeny źródłowej adresu e-mail. Aby zapewnić pomyślne uwierzytelnianie SPF i dostarczanie wiadomości e-mail, utwórz następujący rekord TXT w bazie danych DNS domeny określonej w adresie e-mail. Jeśli na przykład adres e-mail to noreply@contoso.com, skontaktuj się z administratorem contoso.com, aby dodać następujący rekord TXT: "v=spf1 include:spf.protection.outlook.com include:_spf-ssg-a.microsoft.com -all"

    • Uwierzytelnianie DKIM: aby wygenerować prawidłowy podpis dla uwierzytelniania za pomocą poczty e-mail, usługa API Management wymaga klucza prywatnego skojarzonego z domeną źródłowego adresu e-mail. Jednak obecnie nie możesz przesłać tego klucza prywatnego w Zarządzaniu API. W związku z tym w celu przypisania prawidłowego podpisu usługa API Management używa klucza prywatnego skojarzonego z domeną mail.windowsazure.com .