az apim product

Referenz

Verwalten von Azure API Management Produkt.

Befehle

az apim product api	Verwalten sie die APIs des Azure API Management Produkts.
az apim product api add	Fügen Sie dem angegebenen Produkt eine API hinzu.
az apim product api check	Überprüft, ob die API-Entität, die durch Bezeichner angegeben ist, der Product-Entität zugeordnet ist.
az apim product api delete	Löscht die angegebene API aus dem angegebenen Produkt
az apim product api list	Listet eine Auflistung von APIs auf, die einem Produkt zugeordnet sind
az apim product create	Erstellt ein Produkt.
az apim product delete	Löscht das Produkt
az apim product list	Listet eine Auflistung der Produkte in der angegebenen Dienstinstanz auf
az apim product show	Ruft die Details des durch den Bezeichner angegebenen Produkts ab.
az apim product update	Aktualisieren sie vorhandene Produktdetails.
az apim product wait	Platzieren Sie die CLI in einem Wartenstatus, bis eine Bedingung eines APIM-Produkts erfüllt ist.

az apim product create

Bearbeiten

Erstellt ein Produkt.

az apim product create --product-name
                       --resource-group
                       --service-name
                       [--approval-required {false, true}]
                       [--description]
                       [--legal-terms]
                       [--no-wait]
                       [--product-id]
                       [--state {notPublished, published}]
                       [--subscription-required {false, true}]
                       [--subscriptions-limit]

Beispiele

Erstellt ein Produkt.

az apim product create --resource-group MyResourceGroup  --service-name MyServiceName --product-id MyProductID --product-name MyProductName --description MyDescription --legal-terms MyTerms --subscription-required true --approval-required true --subscriptions-limit 8 --state "published"

Erforderliche Parameter

--product-name

Produktname

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--service-name -n

Der Name der API-Verwaltungsdienstinstanz.

Optionale Parameter

--approval-required

Ob die Abonnementgenehmigung erforderlich ist. Wenn falsch, werden neue Abonnements automatisch genehmigt, damit Entwickler die APIs des Produkts sofort nach dem Abonnieren aufrufen können. Wenn true, müssen Administratoren das Abonnement manuell genehmigen, bevor der Entwickler eine der APIs des Produkts verwenden kann. Kann nur vorhanden sein, wenn die Eigenschaft "subscriptionRequired" vorhanden ist und einen Wert von "false" aufweist.

Zulässige Werte: false, true

--description

Produktbeschreibung. Kann HTML-Formatierungstags umfassen.

--legal-terms

Nutzungsbedingungen für das Produkt. Diese Bedingungen werden Entwicklern angezeigt, die das Produkt abonnieren möchten. Sie müssen die Bedingungen akzeptieren, um den Abonnementvorgang abschließen zu können.

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

--product-id

Produktbezeichner. Muss in der aktuellen API Management Dienstinstanz eindeutig sein.

--state

Ob das Produkt veröffentlicht wird oder nicht. Veröffentlichte Produkte werden von Benutzern des Entwicklerportals erkannt. Nicht veröffentlichte Produkte sind nur für Administratoren sichtbar. Der Standardzustand des Produkts ist nicht veröffentlicht.

Zulässige Werte: notPublished, published

--subscription-required -s

Ob ein Produktabonnement für den Zugriff auf APIs erforderlich ist, die in diesem Produkt enthalten sind.

Zulässige Werte: false, true

--subscriptions-limit

Ob die Anzahl der Abonnements, die ein Benutzer gleichzeitig für dieses Produkt haben kann. Legen Sie fest, dass null oder ausgelassen wird, um unbegrenzt pro Benutzerabonnement zuzulassen. Kann nur vorhanden sein, wenn die Eigenschaft "subscriptionRequired" vorhanden ist und einen Wert von "false" aufweist.

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az apim product delete

Bearbeiten

Löscht das Produkt

az apim product delete --product-id
                       --resource-group
                       --service-name
                       [--delete-subscriptions]
                       [--if-match]
                       [--no-wait]
                       [--yes]

Beispiele

Löschen Sie das Produkt mit allen Abonnements dieses Produkts.

az apim product delete --resource-group MyResourceGroup  --service-name MyServiceName --product-id MyProductID --delete-subscriptions true

Erforderliche Parameter

--product-id

Produktbezeichner. Muss in der aktuellen API Management Dienstinstanz eindeutig sein.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--service-name -n

Der Name der API-Verwaltungsdienstinstanz.

Optionale Parameter

--delete-subscriptions

Löschen Sie vorhandene Abonnements, die dem Produkt zugeordnet sind oder nicht.

--if-match

ETag der Entität.

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

--yes -y

Nicht zur Bestätigung auffordern

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az apim product list

Bearbeiten

Listet eine Auflistung der Produkte in der angegebenen Dienstinstanz auf

az apim product list --resource-group
                     --service-name

Beispiele

Alle Produkte für diese APIM-Instanz auflisten.

az apim product list --resource-group MyResourceGroup --service-name MyServiceName

Erforderliche Parameter

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--service-name -n

Der Name der API-Verwaltungsdienstinstanz.

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az apim product show

Bearbeiten

Ruft die Details des durch den Bezeichner angegebenen Produkts ab.

az apim product show --product-id
                     --resource-group
                     --service-name

Beispiele

Ruft die Details des durch den Bezeichner angegebenen Produkts ab.

az apim product show --resource-group MyResourceGroup --service-name MyServiceName  --product-id MyProductID

Erforderliche Parameter

--product-id

Produktbezeichner. Muss in der aktuellen API Management Dienstinstanz eindeutig sein.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--service-name -n

Der Name der API-Verwaltungsdienstinstanz.

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az apim product update

Bearbeiten

Aktualisieren vorhandener Produktdetails.

az apim product update --product-id
                       --resource-group
                       --service-name
                       [--add]
                       [--approval-required {false, true}]
                       [--description]
                       [--force-string]
                       [--if-match]
                       [--legal-terms]
                       [--no-wait]
                       [--product-name]
                       [--remove]
                       [--set]
                       [--state {notPublished, published}]
                       [--subscription-required {false, true}]
                       [--subscriptions-limit]

Beispiele

Aktualisieren sie vorhandene Produktdetails.

az apim product update --resource-group MyResourceGroup  --service-name MyServiceName --product-id MyProductID --product-name MyNewProductName --description MyNewDescription --legal-terms MyNewTerms --subscription-required false --state "notPublished"

Erforderliche Parameter

--product-id

Produktbezeichner. Muss in der aktuellen API Management Dienstinstanz eindeutig sein.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--service-name -n

Der Name der API-Verwaltungsdienstinstanz.

Optionale Parameter

--add

Fügen Sie einem Objekt eine Liste von Objekten hinzu, indem Sie ein Pfad- und Schlüsselwertpaar angeben. Beispiel: --add property.listProperty <key=value, string or JSON string>.

--approval-required

Zulässige Werte: false, true

--description

Produktbeschreibung. Kann HTML-Formatierungstags umfassen.

--force-string

Wenn Sie "set" oder "add" verwenden, behalten Sie Zeichenfolgen literale beibehalten, anstatt zu versuchen, in JSON zu konvertieren.

--if-match

ETag der Entität.

--legal-terms

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

--product-name

Produktname

--remove

Entfernen Sie eine Eigenschaft oder ein Element aus einer Liste. Beispiel: --remove property.list OR --remove propertyToRemove.

--set

Aktualisieren Sie ein Objekt, indem Sie einen Eigenschaftenpfad und einen wert angeben, der festgelegt werden soll. Beispiel: --set-property1.property2=.

--state

Zulässige Werte: notPublished, published

--subscription-required -s

Ob ein Produktabonnement für den Zugriff auf APIs erforderlich ist, die in diesem Produkt enthalten sind.

Zulässige Werte: false, true

--subscriptions-limit

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az apim product wait

Bearbeiten

Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung eines APIM-Produkts erfüllt ist.

az apim product wait --product-id
                     --resource-group
                     --service-name
                     [--created]
                     [--custom]
                     [--deleted]
                     [--exists]
                     [--interval]
                     [--timeout]
                     [--updated]

Beispiele

Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung eines APIM erfüllt ist. (automatisch generiert)

az apim product wait --created --resource-group MyResourceGroup --service-name MyServiceName --product-id MyProductID

Erforderliche Parameter

--product-id

Produktbezeichner. Muss in der aktuellen API Management Dienstinstanz eindeutig sein.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--service-name -n

Der Name der API-Verwaltungsdienstinstanz.

Optionale Parameter

--created

Warten Sie, bis Sie mit "provisioningState" unter "Erfolgreich" erstellt wurden.

--custom

Warten Sie, bis die Bedingung eine benutzerdefinierte JMESPath-Abfrage erfüllt. Beispiel: provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Warten Sie, bis sie gelöscht wurde.

--exists

Warten Sie, bis die Ressource vorhanden ist.

--interval

Abfrageintervall in Sekunden.

Standardwert: 30

--timeout

Maximale Wartezeit in Sekunden.

Standardwert: 3600

--updated

Warten Sie, bis die Aktualisierung mit provisioningState unter "Erfolgreich" ausgeführt wurde.

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az apim product

Befehle

az apim product create

Beispiele

Erforderliche Parameter

Optionale Parameter

az apim product delete

Beispiele

Erforderliche Parameter

Optionale Parameter

az apim product list

Beispiele

Erforderliche Parameter

az apim product show

Beispiele

Erforderliche Parameter

az apim product update

Beispiele

Erforderliche Parameter

Optionale Parameter

az apim product wait

Beispiele

Erforderliche Parameter

Optionale Parameter

Feedback