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

Usługa API Management umożliwia konfigurowanie powiadomień e-mail dla określonych zdarzeń oraz konfigurowanie szablonów wiadomości 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.

Przechodzenie do wystąpienia usługi API Management

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

   

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

   

Konfigurowanie powiadomień w portalu

1. W lewym obszarze nawigacji wystąpienia usługi API Management wybierz pozycję Powiadomienia , aby wyświetlić dostępne powiadomienia.

   Na potrzeby powiadomień można skonfigurować następującą listę zdarzeń.

   • Żądania subskrypcji (wymagające zatwierdzenia) — określeni adresaci poczty e-mail i użytkownicy otrzymają 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 otrzymają powiadomienia e-mail dotyczące nowych subskrypcji produktów.
   • BCC — określeni adresaci poczty e-mail i użytkownicy otrzymają kopie wiadomości e-mail ze wszystkimi wiadomościami e-mail wysłanymi do deweloperów.
   • Zamknij wiadomość o koncie — określeni adresaci poczty e-mail i użytkownicy otrzymają powiadomienia e-mail po zamknięciu konta.
   • Zbliżanie się do limitu przydziału subskrypcji — określeni adresaci poczty e-mail i użytkownicy otrzymają 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.

   

Konfigurowanie szablonów powiadomień

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

• Zatwierdzone przesyłanie galerii aplikacji (przestarzałe)
• List pożegnalny dla deweloperów
• Limit przydziału dla deweloperów zbliżający się do powiadomienia
• List powitalny dla deweloperów
• Powiadomienie o zmianie wiadomości e-mail
• Zaproś użytkownika
• Nowy komentarz dodany do problemu (przestarzały)
• Potwierdzenie nowego konta dewelopera
• Odebrano nowy problem (przestarzały)
• Aktywowano nową subskrypcję
• Potwierdzenie zmiany hasła
• Odrzucono żądanie subskrypcji
• Odebrano żądanie subskrypcji

Każdy szablon wiadomości e-mail ma temat w postaci zwykłego tekstu i definicję treści w formacie HTML. Każdy element można dostosować zgodnie z potrzebami.

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 po lewej stronie wybierz pozycję Szablony powiadomień.

2. Wybierz szablon powiadomienia i skonfiguruj szablon przy użyciu edytora.

   

   • Lista Parametry zawiera listę parametrów, które po wstawieniu do tematu lub treści zostaną zastąpione przez wyznaczoną wartość po wysłaniu wiadomości e-mail.
   • Aby wstawić parametr, umieść kursor, w którym chcesz przejść parametr, a następnie wybierz nazwę parametru.

3. Aby zapisać zmiany w szablonie wiadomości e-mail, wybierz pozycję Zapisz lub anuluj zmiany wybierz pozycję Odrzuć.

Konfigurowanie ustawień poczty e-mail

Możesz zmodyfikować ogólne ustawienia poczty e-mail dla powiadomień wysyłanych z wystąpienia 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 po lewej stronie 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 wystąpienia usługi API Management. Usługa API Management wysyła powiadomienia w imieniu tego adresu źródłowego.

     

4. Wybierz pozycję Zapisz.

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

Adresaci powiadomień e-mail z usługi API Management mogą mieć wpływ na zmianę źródłowego adresu e-mail.

• Zmień wartość na Z adresu — po zmianie źródłowego adresu e-mail (na przykład na no-reply@contoso.com), From nagłówek adresu będzie mieć wartość noreply@contoso.com apimgmt-noreply@mail.windowsazure.com. Dzieje się tak, ponieważ wiadomość e-mail jest wysyłana przez usługę API Management, a nie serwer poczty e-mail źródłowego adresu e-mail.

• Poczta e-mail ustawiona na folder Wiadomości-śmieci lub Spam — 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 Spam. Może się to zdarzyć w zależności od ustawień uwierzytelniania poczty e-mail WF lub DKIM organizacji:

  • Uwierzytelnianie SPF — wiadomość e-mail może nie przekazywać uwierzytelniania SPF po zmianie źródłowej domeny 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. Nie można jednak przekazać tego klucza prywatnego w usłudze API Management. 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 .

Następne kroki

• Omówienie portalu dla deweloperów.
• Jak tworzyć konta deweloperów i używać ich do zarządzania nimi