az apim product api

Verwalten sie die APIs Azure API Management Produkts.

Befehle

Name	Beschreibung	Typ	Status
az apim product api add	Fügen Sie dem angegebenen Produkt eine API hinzu.	Core	GA
az apim product api check	Überprüft, ob die durch den Bezeichner angegebene API-Entität der Produktentität zugeordnet ist.	Core	GA
az apim product api delete	Löscht die angegebene API aus dem angegebenen Produkt.	Core	GA
az apim product api list	Listet eine Auflistung der APIs auf, die einem Produkt zugeordnet sind.	Core	GA

az apim product api add

Fügen Sie dem angegebenen Produkt eine API hinzu.

az apim product api add --api-id
                        --product-id
                        --resource-group
                        --service-name
                        [--acquire-policy-token]
                        [--change-reference]

Beispiele

Fügen Sie dem angegebenen Produkt eine API hinzu.

az apim product api add --resource-group MyResourceGroup --service-name MyServiceName  --product-id MyProductID --api-id MyAPIID

Erforderliche Parameter

--api-id

API-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.

Eigenschaft	Wert
Parametergruppe:	API Arguments

--product-id

Produkt-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz 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

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--acquire-policy-token

Automatisches Abrufen eines Azure Policy Tokens für diesen Ressourcenvorgang.

Eigenschaft	Wert
Parametergruppe:	Global Policy Arguments

--change-reference

Die zugehörige Änderungsreferenz-ID für diesen Ressourcenvorgang.

Eigenschaft	Wert
Parametergruppe:	Global Policy Arguments

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Ausgabeformat.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

az apim product api check

Überprüft, ob die durch den Bezeichner angegebene API-Entität der Produktentität zugeordnet ist.

az apim product api check --api-id
                          --product-id
                          --resource-group
                          --service-name
                          [--acquire-policy-token]
                          [--change-reference]

Beispiele

Überprüfen Sie, ob die API dem Produkt zugeordnet ist.

az apim product api check --resource-group MyResourceGroup  --service-name MyServiceName  --product-id MyProductID --api-id MyAPIID

Erforderliche Parameter

--api-id

API-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.

Eigenschaft	Wert
Parametergruppe:	API Arguments

--product-id

Produkt-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz 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

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--acquire-policy-token

Automatisches Abrufen eines Azure Policy Tokens für diesen Ressourcenvorgang.

Eigenschaft	Wert
Parametergruppe:	Global Policy Arguments

--change-reference

Die zugehörige Änderungsreferenz-ID für diesen Ressourcenvorgang.

Eigenschaft	Wert
Parametergruppe:	Global Policy Arguments

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Ausgabeformat.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

az apim product api delete

Löscht die angegebene API aus dem angegebenen Produkt.

az apim product api delete --api-id
                           --product-id
                           --resource-group
                           --service-name
                           [--acquire-policy-token]
                           [--change-reference]

Beispiele

Löscht die angegebene API aus dem angegebenen Produkt.

az apim product api delete --resource-group MyResourceGroup --service-name MyServiceName  --product-id MyProductID --api-id MyAPIID

Erforderliche Parameter

--api-id

API-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.

Eigenschaft	Wert
Parametergruppe:	API Arguments

--product-id

Produkt-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz 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

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--acquire-policy-token

Automatisches Abrufen eines Azure Policy Tokens für diesen Ressourcenvorgang.

Eigenschaft	Wert
Parametergruppe:	Global Policy Arguments

--change-reference

Die zugehörige Änderungsreferenz-ID für diesen Ressourcenvorgang.

Eigenschaft	Wert
Parametergruppe:	Global Policy Arguments

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Ausgabeformat.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

az apim product api list

Listet eine Auflistung der APIs auf, die einem Produkt zugeordnet sind.

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

Beispiele

Listet alle APIs auf, die einem Produkt zugeordnet sind.

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

Erforderliche Parameter

--product-id

Produkt-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz 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

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Ausgabeformat.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

Feedback

War diese Seite hilfreich?