Konfigurieren von Benachrichtigungen und Benachrichtigungsvorlagen in Azure API Management

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.

Verfügbarkeit

Wichtig

Diese Funktion ist auf den Ebenen Premium, Standard, Basic und Entwickler von API Management verfügbar.

Navigieren zur API Management-Instanz

  1. Suchen Sie im Azure-Portal nach API Management-Dienste, und wählen Sie die entsprechende Option aus.

    Select API Management services

  2. Wählen Sie auf der Seite API Management-Dienste Ihre API Management-Instanz aus.

    Select your API Management instance

Konfigurieren von Benachrichtigungen im Portal

  1. 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.

    • Anwendungsgalerie-Anfragen (veraltet) - Die angegebenen E-Mail-Empfänger und Benutzer erhalten E-Mail-Benachrichtigungen, wenn neue Anwendungen in die Anwendungsgalerie im Legacy-Entwicklerportal übermittelt werden.

    • BCC - Die angegebenen E-Mail-Empfänger und Benutzer erhalten BCC-Kopien aller E-Mails, die an Entwickler verschickt werden.

    • Neues Problem oder Kommentar (veraltet) - Die angegebenen E-Mail-Empfänger und Benutzer erhalten E-Mail-Benachrichtigungen, wenn neue Probleme oder Kommentare im Legacy-Entwicklerportal erstellt 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.

  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.

    Screenshot showing how to add notification recipients in the portal

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.

So wird eine Benachrichtigungsvorlage im Portal angezeigt und konfiguriert:

  1. Wählen Sie im linken Menü Benachrichtigungsvorlagen aus. Screenshot of notification templates in the portal

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

    Screenshot of notification template editor in the portal

    • 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.
  3. 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.

So ändern Sie E-Mail-Einstellungen:

  1. Wählen Sie im linken Menü Benachrichtigungsvorlagen aus.
  2. Wählen Sie E-Mail-Einstellungen aus.
  3. 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.

      Screenshot of API Management email settings in the portal

  4. Wählen Sie Speichern aus.

Nächste Schritte