Tutorial: Erstellen und Veröffentlichen eines Produkts

GILT FÜR: Alle API Management-Ebenen

Produkte in Azure API Management enthalten eine oder mehrere APIs, ein Nutzungskontingent und Nutzungsbedingungen. Nachdem ein Produkt veröffentlicht wurde, können Entwickler*innen das Produkt abonnieren und die APIs des Produkts verwenden.

In diesem Tutorial lernen Sie, wie die folgenden Aufgaben ausgeführt werden:

• Erstellen und Veröffentlichen eines Produkts
• Hinzufügen einer API zum Produkt
• Zugreifen auf Produkt-APIs

Voraussetzungen

• Machen Sie sich mit der Azure API Management-Terminologie vertraut.
• Bearbeiten Sie den folgenden Schnellstart: Erstellen einer neuen Azure API Management-Dienstinstanz
• Absolvieren Sie außerdem das folgende Tutorial: Importieren und Veröffentlichen Ihrer ersten API.

Erstellen und Veröffentlichen eines Produkts

Portal

1. Melden Sie sich beim Azure-Portal an, und navigieren Sie zu Ihrer API Management-Instanz.

2. Wählen Sie im linken Navigationsbereich Produkte>+ Hinzufügen aus.

   

3. Geben Sie im Fenster Produkt hinzufügen Werte ein, die in der folgenden Tabelle beschrieben sind, um Ihr Produkt zu erstellen.

   

   Name	Beschreibung
   Anzeigename	Der Name, wie er im Entwicklerportal angezeigt werden soll
   Beschreibung	Machen Sie Angaben zum Produkt wie etwa dessen Zweck, die zur Verfügung gestellten APIs und sonstige Details.
   State	Wählen Sie Veröffentlicht aus, wenn Sie das Produkt veröffentlichen möchten. Bevor die APIs eines Produkts aufgerufen werden können, müssen Sie das Produkt veröffentlichen. Standardmäßig sind neue Produkte nicht veröffentlicht und nur für die Gruppe Administratoren sichtbar.
   Abonnement erforderlich	Wählen Sie diese Option aus, wenn Benutzer*innen das Produkt abonnieren müssen (das Produkt ist geschützt) und ein Abonnementschlüssel für den Zugriff auf die APIs des Produkts erforderlich ist. Wenn kein Abonnement erforderlich ist (das Produkt ist offen), wird kein Abonnementschlüssel benötigt, um auf die APIs des Produkts zugreifen zu können. Weitere Informationen finden Sie im Abschnitt Zugreifen auf Produkt-APIs weiter unten in diesem Artikel.
   Genehmigung erforderlich	Aktivieren Sie diese Option, wenn Sie möchten, dass ein Administrator Abonnements für dieses Produkt prüfen und ablehnen oder akzeptieren muss. Andernfalls werden Abonnements automatisch genehmigt.
   Grenzwert für Abonnementanzahl	Beschränken Sie optional die Anzahl mehrerer gleichzeitiger Abonnements.
   Rechtliche Bedingungen	Sie können die Nutzungsbedingungen für das Produkt hinzufügen, denen Abonnenten zustimmen müssen, um das Produkt verwenden zu können.
   APIs	Wählen Sie mindestens eine API aus. Sie können APIs auch nach dem Erstellen des Produkts hinzufügen. Weitere Informationen finden Sie weiter unten in diesem Artikel unter Hinzufügen von APIs zu einem Produkt. Wenn das Produkt offen ist (und kein Abonnement erfordert), können Sie nur eine API hinzufügen, die nicht mit einem anderen offenen Produkt verknüpft ist.

4. Wählen Sie Erstellen aus, um das neue Produkt zu erstellen.

Achtung

Gehen Sie beim Konfigurieren eines Produkts, das kein Abonnement erfordert, sorgfältig vor. Diese Konfiguration kann übermäßig freizügig sein und die API des Produkts anfälliger für bestimmte API-Sicherheitsbedrohungen machen.

Azure-Befehlszeilenschnittstelle

So beginnen Sie mit der Verwendung der Azure CLI:

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

Führen Sie zum Erstellen eines Produkts den Befehl az apim product create aus:

az apim product create --resource-group apim-hello-word-resource-group \
    --product-name "Contoso product" --product-id contoso-product \
    --service-name apim-hello-world --subscription-required true \
    --state published --description "This is a test."

Sie können verschiedene Werte für Ihr Produkt angeben:

Parameter	BESCHREIBUNG
--product-name	Der Name, wie er im Entwicklerportal angezeigt werden soll
--description	Machen Sie Angaben zum Produkt wie etwa dessen Zweck, die zur Verfügung gestellten APIs und sonstige Details.
--state	Wählen Sie Veröffentlicht aus, wenn Sie das Produkt veröffentlichen möchten. Bevor die APIs eines Produkts aufgerufen werden können, müssen Sie das Produkt veröffentlichen. Standardmäßig sind neue Produkte nicht veröffentlicht und nur für die Gruppe Administratoren sichtbar.
--subscription-required	Wählen Sie diese Option aus, wenn Benutzer*innen das Produkt abonnieren müssen (das Produkt ist geschützt) oder kein Abonnement erforderlich ist (das Produkt ist offen). Weitere Informationen finden Sie im Abschnitt Zugreifen auf Produkt-APIs weiter unten in diesem Artikel.
--approval-required	Aktivieren Sie diese Option, wenn Sie möchten, dass ein Administrator Abonnements für dieses Produkt prüfen und ablehnen oder akzeptieren muss. Andernfalls werden Abonnements automatisch genehmigt.
--subscriptions-limit	Beschränken Sie optional die Anzahl mehrerer gleichzeitiger Abonnements.
--legal-terms	Sie können die Nutzungsbedingungen für das Produkt hinzufügen, denen Abonnenten zustimmen müssen, um das Produkt verwenden zu können.

Achtung

Gehen Sie beim Konfigurieren eines Produkts, das kein Abonnement erfordert, sorgfältig vor. Diese Konfiguration kann übermäßig freizügig sein und die API des Produkts anfälliger für bestimmte API-Sicherheitsbedrohungen machen.

Ihre aktuellen Produkte können Sie mithilfe des Befehls az apim product list anzeigen:

az apim product list --resource-group apim-hello-word-resource-group \
    --service-name apim-hello-world --output table

Wenn Sie ein Produkt löschen möchten, verwenden Sie den Befehl az apim product delete:

az apim product delete --product-id contoso-product \
    --resource-group apim-hello-word-resource-group \
    --service-name apim-hello-world --delete-subscriptions true

Hinzufügen weiterer Konfigurationen

Setzen Sie die Konfiguration des Produkts fort, nachdem Sie es gespeichert haben. Wählen Sie in der API Management-Instanz das Produkt im Fenster Produkte aus. Sie können Folgendes hinzufügen oder aktualisieren:

Element	Beschreibung
Einstellungen	Produktmetadaten und -status
APIs	Dem Produkt zugeordnete APIs
Richtlinien	Auf Produkt-APIs angewendete Richtlinien
Zugriffssteuerung	Produktsichtbarkeit für Entwickler oder Gäste
Abonnements	Produktabonnenten

Hinzufügen von APIs zu einem Produkt

Bei Produkten handelt es sich um API-Zuordnungen. Sie können viele verschiedene APIs einfügen, und sie Entwicklern über das Entwicklerportal zur Verfügung stellen. Während der Erstellung des Produkts können Sie eine oder mehrere vorhandene APIs hinzufügen. Sie können eine API dem Produkt auch später hinzufügen – und zwar entweder über die Seite mit den Einstellungen des Produkts oder beim Erstellen einer API.

Hinzufügen einer API zu einem vorhandenen Produkt

Portal

1. Wählen Sie im linken Navigationsbereich der API Management-Instanz Produkte aus.
2. Wählen Sie ein Produkt und dann APIs aus.
3. Wählen Sie + API hinzufügen aus.
4. Wählen Sie mindestens eine API und dann Auswählen aus.

Azure-Befehlszeilenschnittstelle

1. Verwenden Sie zum Anzeigen Ihrer verwalteten APIs den Befehl az apim api list:

   az apim api list --resource-group apim-hello-word-resource-group \
       --service-name apim-hello-world --output table
   

2. Mit dem Befehl az apim product api add können Sie Ihrem Produkt eine API hinzufügen:

   az apim product api add --resource-group apim-hello-word-resource-group \
       --api-id demo-conference-api --product-id contoso-product \
       --service-name apim-hello-world
   

3. Überprüfen Sie das Hinzufügen mithilfe des Befehls az apim product api list:

   az apim product api list --resource-group apim-hello-word-resource-group \
       --product-id contoso-product --service-name apim-hello-world --output table
   

Wenn Sie eine API aus einem Produkt entfernen möchten, verwenden Sie den Befehl az apim product api delete:

az apim product api delete --resource-group apim-hello-word-resource-group \
    --api-id demo-conference-api --product-id contoso-product \
    --service-name apim-hello-world

Zugreifen auf Produkt-APIs

Nachdem Sie ein Produkt veröffentlicht haben, können Entwickler*innen auf die APIs zugreifen. Je nachdem, wie das Produkt konfiguriert ist, müssen sie das Produkt abonnieren, um darauf zugreifen zu können.

• Geschütztes Produkt: Entwickler*innen müssen ein geschütztes Produkt zuerst abonnieren, um Zugriff auf seine APIs zu erhalten. Wenn sie ein Produkt abonnieren, erhalten sie einen Abonnementschlüssel, mit dem sie auf jede API in diesem Produkt zugreifen können. Wenn Sie die API Management-Instanz erstellt haben, sind Sie bereits Administrator und haben dadurch standardmäßig alle Produkte abonniert. Weitere Informationen finden Sie unter Abonnements in Azure API Management.

  Wenn ein Client eine API mit einem gültigen Produktabonnementschlüssel anfordert, verarbeitet API Management die Anforderung und lässt den Zugriff im Kontext des Produkts zu. Dabei können für das Produkt konfigurierte Richtlinien und Zugriffssteuerungsregeln angewendet werden.

  Tipp

  Sie können ein Benutzerabonnement für ein Produkt unter Verwendung benutzerdefinierter Abonnementschlüssel über die REST-API oder einen PowerShell-Befehl erstellen oder aktualisieren.

• Offenes Produkt: Entwickler*innen können ohne Abonnementschlüssel auf APIs von offenen Produkten zugreifen. Sie können jedoch andere Mechanismen konfigurieren, um den Clientzugriff auf die APIs zu sichern, darunter OAuth 2.0, Clientzertifikate und das Einschränken der IP-Adressen von Anrufern.

  Hinweis

  Offene Produkte werden im Entwicklerportal nicht aufgeführt, sodass Entwickler dort keine Informationen dazu finden und sie auch nicht abonnieren können. Sie sind nur für die Gruppe Administratoren sichtbar. Sie müssen einen anderen Mechanismus verwenden, um Entwickler über APIs zu informieren, auf die ohne Abonnementschlüssel zugegriffen werden kann.

  Folgendes geschieht, wenn ein Client eine API ohne Abonnementschlüssel anfordert:

  • API Management überprüft, ob die API zu einem offenen Produkt gehört. Eine API kann höchstens einem offenen Produkt zugeordnet werden.

  • Wenn das offene Produkt vorhanden ist, wird die Anforderung im Kontext dieses offenen Produkts verarbeitet. Dabei können für das offene Produkt konfigurierte Richtlinien und Zugriffssteuerungsregeln angewendet werden.

Weitere Informationen finden Sie unter Verarbeitung von Anforderungen mit oder ohne Abonnementschlüssel durch API Management.

Nächste Schritte

In diesem Tutorial haben Sie gelernt, wie die folgenden Aufgaben ausgeführt werden:

• Erstellen und Veröffentlichen eines Produkts
• Hinzufügen einer API zum Produkt
• Zugreifen auf Produkt-APIs

Fahren Sie mit dem nächsten Tutorial fort:

API-Modellantworten