Konfigurieren von Benachrichtigungen und Benachrichtigungsvorlagen in Azure API Management

Artikel
04/08/2024

API Management bietet die Möglichkeit, E-Mail-Benachrichtigungen über spezifische Ereignisse sowie die E-Mail-Vorlagen zu konfigurieren, die zur Kommunikation mit Administratoren und Entwicklern einer API Management-Instanz 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

Suchen Sie im Azure-Portal nach API Management-Dienste, und wählen Sie diese Option aus.
Wählen Sie auf der Seite API Management-Dienste Ihre API Management-Instanz aus.

Konfigurieren von Benachrichtigungen im Portal

Wählen Sie im linken Navigationsbereich Ihrer API Management-Instanz Benachrichtigungen aus, um die verfügbaren Benachrichtigungen anzuzeigen.

Die folgenden Ereignisse können für Benachrichtigungen konfiguriert werden.
- Abonnementanfragen (mit ausstehender Genehmigung) - Die angegebenen E-Mail-Empfänger und Benutzer erhalten E-Mail-Benachrichtigungen über Abonnementanfragen für Produkte mit ausstehender Genehmigung.
- Neue Abonnements - Die angegebenen E-Mail-Empfänger und Benutzer erhalten E-Mail-Benachrichtigungen über neue Produktabonnements.
- BCC - Die angegebenen E-Mail-Empfänger und Benutzer erhalten BCC-Kopien aller E-Mails, die an Entwickler verschickt werden.
- Kontoschließung - Die angegebenen E-Mail-Empfänger und Benutzer erhalten E-Mail-Benachrichtigungen, wenn Konten geschlossen werden.
- Kurz vor Abonnement-Kontingent - Die angegebenen E-Mail-Empfänger und Benutzer erhalten E-Mail-Benachrichtigungen, wenn sich die Abonnementnutzung dem Nutzungskontingent annähert.
  
  Hinweis
  
  Benachrichtigungen werden nur durch die Richtlinie Kontingent nach Abonnement ausgelöst. Die Richtlinie Kontingent nach Schlüssel generiert keine Benachrichtigungen.
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:

Übermittlung in Anwendungsgalerie genehmigt (veraltet)
Entwickler-Abschiedsbrief
Entwickler-Nutzungskontingent beinahe erreicht
Entwickler-Begrüßungsschreiben
Benachrichtigung über Änderung der E-Mail-Adresse
Benutzer einladen
Neuer Kommentar zu einem Problem (veraltet)
Bestätigung für neues Entwicklerkonto
Neues Problem erhalten (veraltet)
Neues Abonnement aktiviert
Bestätigung der Kennwortänderung
Abonnementanforderung abgelehnt
Abonnementerneuerung erhalten

Jede E-Mail-Vorlage enthält einen Betreff im Nur-Text-Format und einen Text 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:

Wählen Sie im linken Menü Benachrichtigungsvorlagen aus.
Wählen Sie eine Benachrichtigungsvorlage aus, und konfigurieren Sie die Vorlage mithilfe des Editors.
- Die Parameter aus der Liste Parameter können in den Betreff oder den Text eingefügt werden und werden beim Versand der E-Mail durch den entsprechenden Wert ersetzt.
- Um einen Parameter einzufügen, platzieren Sie den Cursor an die gewünschte Stelle, und wählen Sie den Parameternamen aus.
Wählen Sie Speichern aus, um die Änderungen an der E-Mail-Vorlage zu speichern, oder wählen Sie Verwerfen aus, um die Änderungen zu verwerfen.

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 kann sich auf die Fähigkeit der Empfänger, E-Mails zu empfangen, auswirken. Weitere Informationen finden Sie in den Überlegungen im folgenden Abschnitt.

So ändern Sie E-Mail-Einstellungen:

Wählen Sie im linken Menü Benachrichtigungsvorlagen aus.
Wählen Sie E-Mail-Einstellungen aus.
Geben Sie auf der Seite General email settings (Allgemeine E-Mail-Einstellungen) Werte für Folgendes ein:
- Administrator-E-Mail - Die E-Mail-Adresse, die alle Systembenachrichtigungen und andere konfigurierte Benachrichtigungen empfangen soll.
- Name der Organisation - Der Name Ihrer Organisation zur Verwendung im Entwicklerportal und in Benachrichtigungen.
- Originating email address (Ursprungs-E-Mail-Adresse) - Der Wert der From-Kopfzeile für Benachrichtigungen von der API Management-Instanz. API Management sendet Benachrichtigungen im Namen dieser Ursprungsadresse.
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 zu Von-Adresse: Wenn Sie die ursprüngliche E-Mail-Adresse (z. B. in no-reply@contoso.com) ändern, lautet der From-Adressheader noreply@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.
Email auf Junk- oder Spamordner festgelegt: Einige Empfänger erhalten möglicherweise keine E-Mail-Benachrichtigungen von API Management oder E-Mails laden im Junk- oder Spam-Ordner. Dies kann je nach den SPF- oder DKIM-Einstellungen der Organisation für die E-Mail-Authentifizierung geschehen:
- SPF-Authentifizierung: E-Mail übergeben die SPF-Authentifizierung möglicherweise nicht mehr, nachdem Sie die Domäne der Absender-E-Mail-Adresse 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 lautet, wenden Sie sich an den*die Administrator*in 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, benötigt API Management den privaten Schlüssel, der der Domäne der ursprünglichen E-Mail-Adresse zugeordnet ist. Es ist jedoch derzeit nicht möglich, diesen privaten Schlüssel in API Management hochzuladen. Um eine gültige Signatur zuzuweisen, verwendet API Management daher den privaten Schlüssel, der der Domäne mail.windowsazure.com zugeordnet ist.