az apim product
Verwalten sie die Azure-API-Verwaltungsprodukts.
Befehle
Name | Beschreibung | Typ | Status |
---|---|---|---|
az apim product api |
Verwalten sie die APIs des Azure API Management-Produkts. |
Core | Allgemein verfügbar |
az apim product api add |
Fügen Sie dem angegebenen Produkt eine API hinzu. |
Core | Allgemein verfügbar |
az apim product api check |
Überprüft, ob die durch den Bezeichner angegebene API-Entität der Produktentität zugeordnet ist. |
Core | Allgemein verfügbar |
az apim product api delete |
Löscht die angegebene API aus dem angegebenen Produkt |
Core | Allgemein verfügbar |
az apim product api list |
Listet eine Auflistung von APIs auf, die einem Produkt zugeordnet sind |
Core | Allgemein verfügbar |
az apim product create |
Erstellt ein Produkt. |
Core | Allgemein verfügbar |
az apim product delete |
Löscht das Produkt |
Core | Allgemein verfügbar |
az apim product list |
Listet eine Auflistung der Produkte in der angegebenen Dienstinstanz auf |
Core | Allgemein verfügbar |
az apim product show |
Ruft die Details des Produkts ab, das durch seinen Bezeichner angegeben ist. |
Core | Allgemein verfügbar |
az apim product update |
Aktualisieren sie vorhandene Produktdetails. |
Core | Allgemein verfügbar |
az apim product wait |
Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung eines APIM-Produkts erfüllt ist. |
Core | Allgemein verfügbar |
az apim product create
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
Produktname
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name>
konfigurieren.
Der Name der API-Verwaltungsdienstinstanz.
Optionale Parameter
Gibt an, ob die Abonnementgenehmigung erforderlich ist. Wenn "false" lautet, werden neue Abonnements automatisch genehmigt, sodass Entwickler die APIs des Produkts unmittelbar nach dem Abonnieren aufrufen können. Bei "true" müssen Administratoren das Abonnement manuell genehmigen, bevor der Entwickler eine der APIs des Produkts verwenden kann. Kann nur vorhanden sein, wenn "subscriptionRequired"-Eigenschaft vorhanden ist und den Wert "false" aufweist.
Produktbeschreibung. Kann HTML-Formatierungstags umfassen.
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.
Nicht auf den Abschluss lang andauernder Vorgänge warten
Produkt-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.
Gibt an, ob das Produkt veröffentlicht wird oder nicht. Veröffentlichte Produkte sind von Benutzern des Entwicklerportals auffindbar. Nicht veröffentlichte Produkte sind nur für Administratoren sichtbar. Der Standardstatus des Produkts ist nicht veröffentlicht. Mögliche Werte sind: 'notPublished', 'published'.
Gibt an, ob für den Zugriff auf in diesem Produkt enthaltene APIs ein Produktabonnement erforderlich ist.
Gibt an, ob die Anzahl der Abonnements, die ein Benutzer gleichzeitig für dieses Produkt haben kann. Wird auf NULL festgelegt oder weggelassen, um unbegrenzte Anzahl pro Benutzerabonnements zuzulassen. Kann nur vorhanden sein, wenn "subscriptionRequired"-Eigenschaft vorhanden ist und den Wert "false" aufweist.
Globale Parameter
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID
konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
az apim product delete
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 für dieses Produkt.
az apim product delete --resource-group MyResourceGroup --service-name MyServiceName --product-id MyProductID --delete-subscriptions true
Erforderliche Parameter
Produkt-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name>
konfigurieren.
Der Name der API-Verwaltungsdienstinstanz.
Optionale Parameter
Löschen Sie vorhandene Abonnements, die dem Produkt zugeordnet sind, oder nicht.
ETag der Entität.
Nicht auf den Abschluss lang andauernder Vorgänge warten
Nicht zur Bestätigung auffordern
Globale Parameter
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID
konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
az apim product list
Listet eine Auflistung der Produkte in der angegebenen Dienstinstanz auf
az apim product list --resource-group
--service-name
Beispiele
Listet alle Produkte für diese APIM-Instanz auf.
az apim product list --resource-group MyResourceGroup --service-name MyServiceName
Erforderliche Parameter
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name>
konfigurieren.
Der Name der API-Verwaltungsdienstinstanz.
Globale Parameter
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID
konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
az apim product show
Ruft die Details des Produkts ab, das durch seinen Bezeichner angegeben ist.
az apim product show --product-id
--resource-group
--service-name
Beispiele
Ruft die Details des Produkts ab, das durch seinen Bezeichner angegeben ist.
az apim product show --resource-group MyResourceGroup --service-name MyServiceName --product-id MyProductID
Erforderliche Parameter
Produkt-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name>
konfigurieren.
Der Name der API-Verwaltungsdienstinstanz.
Globale Parameter
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID
konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
az apim product update
Aktualisieren sie vorhandene 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
Produkt-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name>
konfigurieren.
Der Name der API-Verwaltungsdienstinstanz.
Optionale Parameter
Fügen Sie einer Liste von Objekten ein Objekt hinzu, indem Sie ein Pfad- und Schlüsselwertpaar angeben. Beispiel: --add property.listProperty <key=value, string or JSON string>
.
Gibt an, ob die Abonnementgenehmigung erforderlich ist. Wenn "false" lautet, werden neue Abonnements automatisch genehmigt, sodass Entwickler die APIs des Produkts unmittelbar nach dem Abonnieren aufrufen können. Bei "true" müssen Administratoren das Abonnement manuell genehmigen, bevor der Entwickler eine der APIs des Produkts verwenden kann. Kann nur vorhanden sein, wenn "subscriptionRequired"-Eigenschaft vorhanden ist und den Wert "false" aufweist.
Produktbeschreibung. Kann HTML-Formatierungstags umfassen.
Wenn Sie "set" oder "add" verwenden, behalten Sie Zeichenfolgenliterale bei, anstatt zu versuchen, in JSON zu konvertieren.
ETag der Entität.
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.
Nicht auf den Abschluss lang andauernder Vorgänge warten
Produktname
Entfernen sie eine Eigenschaft oder ein Element aus einer Liste. Beispiel: --remove property.list <indexToRemove>
ODER --remove propertyToRemove
.
Aktualisieren Sie ein Objekt, indem Sie einen festzulegenden Eigenschaftspfad und -wert angeben. Beispiel: --set property1.property2=<value>
.
Gibt an, ob das Produkt veröffentlicht wird oder nicht. Veröffentlichte Produkte sind von Benutzern des Entwicklerportals auffindbar. Nicht veröffentlichte Produkte sind nur für Administratoren sichtbar. Der Standardstatus des Produkts ist nicht veröffentlicht. Mögliche Werte sind: 'notPublished', 'published'.
Gibt an, ob für den Zugriff auf in diesem Produkt enthaltene APIs ein Produktabonnement erforderlich ist.
Gibt an, ob die Anzahl der Abonnements, die ein Benutzer gleichzeitig für dieses Produkt haben kann. Wird auf NULL festgelegt oder weggelassen, um unbegrenzte Anzahl pro Benutzerabonnements zuzulassen. Kann nur vorhanden sein, wenn "subscriptionRequired"-Eigenschaft vorhanden ist und den Wert "false" aufweist.
Globale Parameter
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID
konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
az apim product wait
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
Produkt-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name>
konfigurieren.
Der Name der API-Verwaltungsdienstinstanz.
Optionale Parameter
Warten Sie, bis sie mit 'provisioningState' unter 'Succeeded' erstellt wurde.
Warten Sie, bis die Bedingung eine benutzerdefinierte JMESPath-Abfrage erfüllt. Beispiel: provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Warten Sie, bis sie gelöscht wurde.
Warten Sie, bis die Ressource vorhanden ist.
Abrufintervall in Sekunden.
Maximale Wartezeit in Sekunden.
Warten Sie, bis sie mit provisioningState unter 'Succeeded' aktualisiert wurde.
Globale Parameter
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID
konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.