Schnellstart: Erstellen einer Azure Notification Hubs-Instanz mithilfe der Azure-Befehlszeilenschnittstelle

  • Artikel

Azure Notification Hubs bietet ein benutzerfreundliches, horizontal skalierbares Pushmodul, mit dem Sie von einem beliebigen Back-End (cloudbasiert oder lokal) Benachrichtigungen an sämtliche Plattformen (iOS, Android, Windows, Kindle, Baidu usw.) senden können. Weitere Informationen zu diesem Dienst finden Sie unter Was ist Azure Notification Hubs?.

In dieser Schnellstartanleitung erstellen Sie einen Notification Hub mithilfe der Azure-Befehlszeilenschnittstelle. Im ersten Abschnitt erfahren Sie, wie Sie einen Notification Hubs-Namespace erstellen. Im zweiten Abschnitt erfahren Sie, wie Sie einen Notification Hub in einem bereits vorhandenen Namespace erstellen. Außerdem erfahren Sie, wie Sie eine benutzerdefinierte Zugriffsrichtlinie erstellen.

Wenn Sie kein Azure-Abonnement besitzen, können Sie ein kostenloses Konto erstellen, bevor Sie beginnen.

Voraussetzungen

  • Verwenden Sie die Bash-Umgebung in Azure Cloud Shell. Weitere Informationen finden Sie unter Schnellstart für Bash in Azure Cloud Shell.

  • Wenn Sie CLI-Referenzbefehle lieber lokal ausführen, installieren Sie die Azure CLI. Wenn Sie Windows oder macOS ausführen, sollten Sie die Azure CLI in einem Docker-Container ausführen. Weitere Informationen finden Sie unter Ausführen der Azure CLI in einem Docker-Container.

    • Wenn Sie eine lokale Installation verwenden, melden Sie sich mithilfe des Befehls az login bei der Azure CLI an. Führen Sie die in Ihrem Terminal angezeigten Schritte aus, um den Authentifizierungsprozess abzuschließen. Informationen zu anderen Anmeldeoptionen finden Sie unter Anmelden mit der Azure CLI.

    • Installieren Sie die Azure CLI-Erweiterung beim ersten Einsatz, wenn Sie dazu aufgefordert werden. Weitere Informationen zu Erweiterungen finden Sie unter Verwenden von Erweiterungen mit der Azure CLI.

    • Führen Sie az version aus, um die installierte Version und die abhängigen Bibliotheken zu ermitteln. Führen Sie az upgrade aus, um das Upgrade auf die aktuelle Version durchzuführen.

Wichtig

Für Notification Hubs ist mindestens die Version 2.0.67 der Azure-Befehlszeilenschnittstelle erforderlich. Führen Sie az version aus, um die installierte Version und die abhängigen Bibliotheken zu ermitteln. Führen Sie az upgrade aus, um das Upgrade auf die aktuelle Version durchzuführen.

Erstellen einer Ressourcengruppe

Azure Notification Hubs muss genau wie alle anderen Azure-Ressourcen in einer Ressourcengruppe bereitgestellt werden. Mit Ressourcengruppen können verwandte Azure-Ressourcen organisiert und verwaltet werden. Lesen Sie Was ist Azure Resource Manager?, um mehr über Ressourcengruppen zu erfahren.

Erstellen Sie für diese Schnellstartanleitung mithilfe des folgenden Befehls vom Typ az group create eine Ressourcengruppe namens spnhubrg am Standort eastus.

az group create --name spnhubrg --location eastus

Erstellen eines Notification Hubs-Namespace

  1. Erstellen Sie einen Namespace für Ihre Benachrichtigungs-Hubs.

    Ein Namespace enthält mindestens einen Hub, und der Name muss über alle Azure-Abonnements hinweg eindeutig und mindestens sechs Zeichen lang sein. Verwenden Sie den Befehl az notification-hub namespace check-availability, um die Verfügbarkeit eines Namens zu prüfen.

    az notification-hub namespace check-availability --name spnhubns

    Die Azure CLI reagiert mit der folgenden Konsolenausgabe auf Ihre Verfügbarkeitsanfrage:

    {
"id": "/subscriptions/yourSubscriptionID/providers/Microsoft.NotificationHubs/checkNamespaceAvailability",
"isAvailable": true,
"location": null,
"name": "spnhubns",
"properties": false,
"sku": null,
"tags": null,
"type": "Microsoft.NotificationHubs/namespaces/checkNamespaceAvailability"
}

    Beachten Sie die zweite Zeile in der Antwort der Azure CLI: "isAvailable": true. In dieser Zeile ist false angegeben, wenn der gewünschte Name, den Sie für den Namespace angegeben haben, nicht verfügbar ist. Nachdem Sie die Verfügbarkeit des Namens bestätigt haben, führen Sie den Befehl az notification-hub namespace create aus, um Ihren Namespace zu erstellen.

    az notification-hub namespace create --resource-group spnhubrg --name spnhubns  --location eastus --sku Free

    Wenn der Wert für --name, den Sie für den Befehl az notification-hub namespace create angegeben haben, nicht verfügbar ist oder die Benennungsregeln und -einschränkungen für Azure-Ressourcen nicht erfüllt, reagiert die Azure CLI mit der folgenden Konsolenausgabe:

    #the name is not available
The specified name is not available. For more information visit https://aka.ms/eventhubsarmexceptions.

#the name is invalid
The specified service namespace is invalid.

    Wenn der erste von Ihnen ausprobierte Name nicht erfolgreich ist, wählen Sie einen anderen Namen für Ihren neuen Namespace aus, und führen Sie den Befehl az notification-hub namespace create erneut aus.

    Hinweis

    Ab diesem Schritt müssen Sie den Wert des Parameters --namespace in jedem Azure CLI-Befehl ersetzen, den Sie aus dieser Schnellstartanleitung kopieren.

  2. Rufen Sie eine Liste der Namespaces ab.

    Verwenden Sie den Befehl az notification-hub namespace list, um die Details zum neuen Namespace anzuzeigen. Der Parameter --resource-group ist optional, wenn Sie alle Namespaces für ein Abonnement anzeigen möchten.

    az notification-hub namespace list --resource-group spnhubrg

Erstellen von Notification Hubs

  1. Erstellen Sie Ihren ersten Notification Hub.

    In dem neuen Namespace können nun Benachrichtigungs-Hubs erstellt werden. Führen Sie den Befehl az notification-hub create aus, um einen Notification Hub zu erstellen.

    az notification-hub create --resource-group spnhubrg --namespace-name spnhubns --name spfcmtutorial1nhub --location eastus

  2. Erstellen Sie einen zweiten Notification Hub.

    In einem einzelnen Namespace können mehrere Notification Hubs erstellt werden. Führen Sie erneut den Befehl az notification-hub create aus, um einen zweiten Notification Hub im gleichen Namespace zu erstellen.

    az notification-hub create --resource-group spnhubrg --namespace-name spnhubns --name mysecondnhub --location eastus

  3. Rufen Sie eine Liste der Benachrichtigungs-Hubs ab.

    Die Azure CLI gibt mit jedem ausgeführten Befehl eine Erfolgsmeldung oder eine Fehlermeldung zurück. Sie haben jedoch auch die Möglichkeit, eine Liste der Benachrichtigungs-Hubs abzurufen. Zu diesem Zweck wurde der Befehl az notification-hub list entworfen.

    az notification-hub list --resource-group spnhubrg --namespace-name spnhubns --output table

Verwenden von Zugriffsrichtlinien

  1. Azure Notification Hubs nutzt SAS-Sicherheit (Shared Access Signature) durch die Verwendung von Zugriffsrichtlinien. Zwei Richtlinien werden automatisch erstellt, wenn Sie einen Benachrichtigungs-Hub erstellen. Die Verbindungszeichenfolgen aus diesen Richtlinien sind zum Konfigurieren von Pushbenachrichtigungen erforderlich. Mit dem Befehl az notification-hub authorization-rule list wird eine Liste mit Richtliniennamen und den entsprechenden Ressourcengruppen bereitgestellt.

    az notification-hub authorization-rule list --resource-group spnhubrg --namespace-name spnhubns --notification-hub-name spfcmtutorial1nhub --output table

    Wichtig

    Verwenden Sie in Ihrer Anwendung nicht die Richtlinie DefaultFullSharedAccessSignature. Diese Richtlinie ist nur für die Verwendung in Ihrem Back-End vorgesehen. Verwenden Sie in Ihrer Clientanwendung nur Zugriffsrichtlinien vom Typ Listen.

  2. Wenn Sie weitere Autorisierungsregeln mit aussagekräftigen Namen erstellen möchten, können Sie eigene Zugriffsrichtlinien erstellen und anpassen. Verwenden Sie dazu den Befehl az notification-hub authorization-rule create. Der Parameter --rights ist eine durch Leerzeichen getrennte Liste der Berechtigungen, die Sie zuweisen möchten.

    az notification-hub authorization-rule create --resource-group spnhubrg --namespace-name spnhubns --notification-hub-name spfcmtutorial1nhub --name spnhub1key --rights Listen Manage Send

  3. Jede Zugriffsrichtlinie verfügt über zwei Gruppen von Schlüsseln und Verbindungszeichenfolgen. Sie werden später zum Konfigurieren eines Benachrichtigungs-Hubs benötigt. Führen Sie den Befehl az notification-hub authorization-rule list-keys aus, um die Schlüssel und Verbindungszeichenfolgen für eine Notification Hubs-Zugriffsrichtlinie aufzulisten.

    # query the keys and connection strings for DefaultListenSharedAccessSignature
az notification-hub authorization-rule list-keys --resource-group spnhubrg --namespace-name spnhubns --notification-hub-name spfcmtutorial1nhub --name DefaultListenSharedAccessSignature --output table

    # query the keys and connection strings for a custom policy
az notification-hub authorization-rule list-keys --resource-group spnhubrg --namespace-name spnhubns --notification-hub-name spfcmtutorial1nhub --name spnhub1key --output table

    Hinweis

    Ein Notification Hubs-Namespace und ein Benachrichtigungshub haben jeweils separate Zugriffsrichtlinien. Achten Sie beim Abfragen von Schlüsseln und Verbindungszeichenfolgen auf die Verwendung der korrekten Azure CLI-Referenz.

Bereinigen von Ressourcen

Wenn Sie die Ressourcengruppe und alle zugehörigen Ressourcen nicht mehr benötigen, können Sie sie mit dem Befehl az group delete löschen.

az group delete --name spnhubrg

Nächste Schritte