Konfigurieren von Benachrichtigungen und Benachrichtigungsvorlagen in Azure API Management

GILT FÜR: Developer | Basic | Basic v2 | Standard | Standard v2 | Premium | Premium v2

Mit Azure API Management können Sie E-Mail-Benachrichtigungen für bestimmte Ereignisse konfigurieren und die E-Mail-Vorlagen konfigurieren, die für die Kommunikation mit den Administratoren und Entwicklern einer API-Verwaltungsinstanz verwendet werden. Dieser Artikel beschreibt die Konfiguration von Benachrichtigungen für verfügbare Ereignisse und bietet eine Übersicht über die Konfiguration der E-Mail-Vorlagen für diese Ereignisse.

Voraussetzungen

Wenn Sie über keine API Management-Dienstinstanz verfügen, absolvieren Sie den folgenden Schnellstart: Erstellen einer Azure API Management-Instanz.

Navigieren zur API Management-Instanz

1. Suchen Sie im Azure-Portal nach API-Verwaltungsdiensten, und wählen Sie sie aus:

   

2. Wählen Sie auf der Seite "API-Verwaltungsdienste " Ihre API-Verwaltungsinstanz aus:

   

Konfigurieren von Benachrichtigungen im Azure-Portal

1. Wählen Sie im Randleistenmenü Ihrer API-Verwaltungsinstanz "Bereitstellung + Infrastruktur" und dann " Benachrichtigungen " aus, um die verfügbaren Benachrichtigungen anzuzeigen.

   Die folgenden Ereignisse können für Benachrichtigungen konfiguriert werden.

   • Abonnementanforderungen (genehmigung erforderlich): Die angegebenen E-Mail-Empfänger und Benutzer erhalten E-Mail-Benachrichtigungen zu Abonnementanforderungen für Produkte, die eine Genehmigung erfordern.
   • Neue Abonnements: Die angegebenen E-Mail-Empfänger und Benutzer erhalten E-Mail-Benachrichtigungen zu neuen Produktabonnements.
   • Anwendungskataloganforderungen: Die folgenden E-Mail-Empfänger und Benutzer erhalten E-Mail-Benachrichtigungen, wenn neue Anwendungen an den Anwendungskatalog übermittelt werden.
   • BCC: Die angegebenen E-Mail-Empfänger und Benutzer erhalten blinde Kopien aller E-Mails, die an Entwickler gesendet wurden.
   • Neues Problem oder Kommentar: Die folgenden E-Mail-Empfänger und Benutzer erhalten E-Mail-Benachrichtigungen, wenn ein neues Problem oder ein neuer Kommentar im Entwicklerportal übermittelt wird.
   • Kontonachricht schließen: Die angegebenen E-Mail-Empfänger und Benutzer erhalten E-Mail-Benachrichtigungen, wenn ein Konto geschlossen wird.
   • Näherung des Kontingentlimits für Abonnements: Die angegebenen E-Mail-Empfänger und Benutzer erhalten E-Mail-Benachrichtigungen, wenn die Abonnementnutzung dem Nutzungskontingent nahe kommt.

2. Wählen Sie eine Benachrichtigung aus, und geben Sie mindestens eine E-Mail-Adresse an, die benachrichtigt werden soll:

   • Zum Hinzufügen der E-Mail-Adresse des Administrators wählen Sie + Administrator hinzufügen aus.
   • Wenn Sie eine weitere E-Mail-Adresse hinzufügen möchten, wählen Sie + E-Mail-Adresse hinzufügen aus, geben Sie eine E-Mail-Adresse ein, und wählen Sie Hinzufügen aus.
   • Fügen Sie nach Bedarf weitere E-Mail-Adressen hinzu.

   

Konfigurieren von Benachrichtigungsvorlagen

API Management bietet Benachrichtigungsvorlagen für die administrativen E-Mail-Nachrichten, die automatisch an Entwickler gesendet werden, wenn sie auf den Dienst zugreifen und ihn verwenden. Die folgenden Benachrichtigungsvorlagen werden bereitgestellt:

• Entwickler-Abschiedsbrief
• Entwickler-Nutzungskontingent beinahe erreicht
• Entwickler-Begrüßungsschreiben
• Benachrichtigung über Änderung der E-Mail-Adresse
• Benutzer einladen
• Bestätigung für neues Entwicklerkonto
• Neues Abonnement aktiviert
• Bestätigung der Kennwortänderung
• Abonnementanforderung abgelehnt
• Abonnementerneuerung erhalten

Jede E-Mail-Vorlage enthält eine Betreffzeile im Nur-Text-Format und eine Textkörperdefinition im HTML-Format. Jedes dieser Elemente kann nach Belieben angepasst werden.

Hinweis

HTML-Inhalte in einer Vorlage müssen wohlgeformt sein und der XML-Spezifikation entsprechen. Das  -Zeichen ist nicht zulässig.

So wird eine Benachrichtigungsvorlage im Portal angezeigt und konfiguriert:

1. Wählen Sie im Randleistenmenü Benachrichtigungsvorlagen aus.

2. Wählen Sie eine Benachrichtigungsvorlage aus, und konfigurieren Sie die Vorlage mithilfe des Editors.

   

   • Die Parameterliste enthält eine Liste von Parametern, die beim Einfügen in den Betreff oder Textkörper durch den festgelegten Wert ersetzt werden, wenn die E-Mail gesendet wird.
   • Um einen Parameter einzufügen, platzieren Sie den Cursor an die gewünschte Stelle, und wählen Sie den Parameternamen aus.

3. Um Änderungen an der E-Mail-Vorlage zu speichern, wählen Sie "Speichern" aus, oder wählen Sie "Verwerfen" aus, um die Änderungen abzubrechen.

Konfigurieren von E-Mail-Einstellungen

Sie können allgemeine E-Mail-Einstellungen für Benachrichtigungen ändern, die von Ihrer API Management-Instanz gesendet werden. Sie können die E-Mail-Adresse des Administrators, den Namen der Organisation, die Benachrichtigungen sendet, und die Ursprungs-E-Mail-Adresse ändern.

Wichtig

Das Ändern der ursprünglichen E-Mail-Adresse wirkt sich möglicherweise auf die Fähigkeit der Empfänger zum Empfangen von E-Mails aus. Weitere Informationen finden Sie in den Überlegungen im folgenden Abschnitt.

So ändern Sie E-Mail-Einstellungen:

1. Wählen Sie im Randleistenmenü Benachrichtigungsvorlagen aus.

2. Wählen Sie E-Mail-Einstellungen aus.

3. Geben Sie auf der Seite "Allgemeine E-Mail-Einstellungen " Werte für Folgendes ein:

   • Administrator-E-Mail: die E-Mail-Adresse zum Empfangen aller Systembenachrichtigungen und anderer konfigurierter Benachrichtigungen.

   • Name der Organisation: der Name Ihrer Organisation für die Verwendung im Entwicklerportal und Benachrichtigungen.

   • Absender-E-Mail-Adresse: Der Wert des From-Headers für Benachrichtigungen aus der API-Verwaltungsinstanz. API Management sendet Benachrichtigungen im Namen dieser Ursprungsadresse.

     

4. Wählen Sie Speichern aus.

Überlegungen zum Ändern der ursprünglichen E-Mail-Adresse

Wenn Sie die ursprüngliche E-Mail-Adresse ändern, kann sich das auf Empfänger von E-Mail-Benachrichtigungen von API Management auswirken.

• Ändern Sie die Absenderadresse: Wenn Sie die ursprüngliche E-Mail-Adresse (z. B. zu no-reply@contoso.com) ändern, wird die Absenderadressenoreply@contoso.com apimgmt-noreply@mail.windowsazure.com. Dies liegt daran, dass die E-Mail von API Management und nicht vom E-Mail-Server der ursprünglichen E-Mail-Adresse gesendet wird.

• An Junk- oder Spamordner gesendete E-Mails: Einige Empfänger erhalten möglicherweise keine E-Mail-Benachrichtigungen aus der API-Verwaltung, oder E-Mails werden an den Junk- oder Spamordner gesendet. Dies kann je nach den SPF- oder DKIM-Einstellungen der Organisation für die E-Mail-Authentifizierung geschehen:

  • SPF-Authentifizierung: E-Mail übergibt möglicherweise keine SPF-Authentifizierung mehr, nachdem Sie die ursprüngliche E-Mail-Adressdomäne geändert haben. Um eine erfolgreiche SPF-Authentifizierung und E-Mail-Zustellung sicherzustellen, erstellen Sie den folgenden TXT-Eintrag in der DNS-Datenbank der Domäne, die in der E-Mail-Adresse angegeben ist. Wenn die E-Mail-Adresse beispielsweise noreply@contoso.com ist, wenden Sie sich an den Administrator von contoso.com, um den folgenden TXT-Eintrag hinzuzufügen: "v=spf1 include:spf.protection.outlook.com include:_spf-ssg-a.microsoft.com -all"

  • DKIM-Authentifizierung: Um eine gültige Signatur für DKIM für die E-Mail-Authentifizierung zu generieren, erfordert die API-Verwaltung den privaten Schlüssel, der der Domäne der ursprünglichen E-Mail-Adresse zugeordnet ist. Derzeit ist es jedoch nicht möglich, diesen privaten Schlüssel in die API-Verwaltung hochzuladen. Um eine gültige Signatur zuzuweisen, verwendet API Management daher den privaten Schlüssel, der der Domäne mail.windowsazure.com zugeordnet ist.

Verwandte Inhalte

• Übersicht über das Entwicklerportal
• Erstellen und Verwenden von Gruppen für Entwicklerkonten