Sdílet prostřednictvím

az apim product

  • Reference

Správa produktu Azure API Management

Příkazy

Name Description Typ Stav
az apim product api

Správa rozhraní API produktu Azure API Management

 Základ GA
az apim product api add

Přidejte rozhraní API do zadaného produktu.

 Základ GA
az apim product api check

Kontroluje, že entita rozhraní API zadaná identifikátorem je přidružená k entitě Product.

 Základ GA
az apim product api delete

Odstraní zadané rozhraní API ze zadaného produktu.

 Základ GA
az apim product api list

Zobrazí kolekci rozhraní API přidružených k produktu.

 Základ GA
az apim product create

Vytvoří produkt.

 Základ GA
az apim product delete

Odstraňte produkt.

 Základ GA
az apim product list

Vypíše kolekci produktů v zadané instanci služby.

 Základ GA
az apim product show

Získá podrobnosti o produktu určeném jeho identifikátorem.

 Základ GA
az apim product update

Aktualizujte existující podrobnosti o produktu.

 Základ GA
az apim product wait

Umístěte rozhraní příkazového řádku do stavu čekání, dokud nebude splněna podmínka produktu apim.

 Základ GA

az apim product create

Upravit

Vytvoří 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]

Příklady

Vytvoří 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"

Povinné parametry

--product-name

Název produktu.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--service-name -n

Název instance služby API Management.

Volitelné parametry

--approval-required

Určuje, jestli se vyžaduje schválení předplatného. Pokud je false, nová předplatná se automaticky schválí, aby vývojáři mohli volat rozhraní API produktu hned po přihlášení k odběru. Pokud je pravda, musí správci předplatné schválit ručně, aby vývojář mohl použít libovolná rozhraní API produktu. Může být k dispozici pouze v případě, že je k dispozici vlastnost SubscriptionRequired a má hodnotu false.

Přípustné hodnoty: false, true
--description

Popis produktu. Může obsahovat značky formátování HTML.

--legal-terms

Podmínky použití produktu. Vývojáři, kteří se pokoušejí přihlásit k odběru produktu, se zobrazí a před dokončením procesu předplatného musí tyto podmínky přijmout.

--no-wait

Nečekejte na dokončení dlouhotrvající operace.

Default value: False
--product-id

Identifikátor produktu. V aktuální instanci služby API Management musí být jedinečné.

--state

Bez ohledu na to, jestli je produkt publikovaný nebo ne. Publikované produkty můžou zjistit uživatelé portálu pro vývojáře. Nepublikovaná produkty jsou viditelné pouze správcům. Výchozí stav Produktu neníPublished. Mezi možné hodnoty patří: notPublished, Published.

Přípustné hodnoty: notPublished, published
--subscription-required -s

Určuje, jestli se pro přístup k rozhraním API zahrnutým v tomto produktu vyžaduje předplatné produktu.

Přípustné hodnoty: false, true
--subscriptions-limit

Určuje, jestli počet předplatných, které může uživatel mít k tomuto produktu současně. Nastavte na hodnotu null nebo vynecháte povolení neomezeného počtu předplatných pro jednotlivé uživatele. Může být k dispozici pouze v případě, že je k dispozici vlastnost SubscriptionRequired a má hodnotu false.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az apim product delete

Upravit

Odstraňte produkt.

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

Příklady

Odstraňte produkt se všemi předplatnými tohoto produktu.

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

Povinné parametry

--product-id

Identifikátor produktu. V aktuální instanci služby API Management musí být jedinečné.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--service-name -n

Název instance služby API Management.

Volitelné parametry

--delete-subscriptions

Odstraňte existující předplatná přidružená k produktu nebo ne.

--if-match

ETag of the Entity.

--no-wait

Nečekejte na dokončení dlouhotrvající operace.

Default value: False
--yes -y

Nezotvádejte výzvu k potvrzení.

Default value: False
Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az apim product list

Upravit

Vypíše kolekci produktů v zadané instanci služby.

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

Příklady

Zobrazí seznam všech produktů pro tuto instanci APIM.

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

Povinné parametry

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--service-name -n

Název instance služby API Management.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az apim product show

Upravit

Získá podrobnosti o produktu určeném jeho identifikátorem.

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

Příklady

Získá podrobnosti o produktu určeném jeho identifikátorem.

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

Povinné parametry

--product-id

Identifikátor produktu. V aktuální instanci služby API Management musí být jedinečné.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--service-name -n

Název instance služby API Management.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az apim product update

Upravit

Aktualizujte existující podrobnosti o produktu.

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]

Příklady

Aktualizujte existující podrobnosti o produktu.

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"

Povinné parametry

--product-id

Identifikátor produktu. V aktuální instanci služby API Management musí být jedinečné.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--service-name -n

Název instance služby API Management.

Volitelné parametry

--add

Přidejte objekt do seznamu objektů zadáním párů cest a klíč-hodnota. Příklad: --add property.listProperty <key=value, string or JSON string>.

Default value: []
--approval-required

Určuje, jestli se vyžaduje schválení předplatného. Pokud je false, nová předplatná se automaticky schválí, aby vývojáři mohli volat rozhraní API produktu hned po přihlášení k odběru. Pokud je pravda, musí správci předplatné schválit ručně, aby vývojář mohl použít libovolná rozhraní API produktu. Může být k dispozici pouze v případě, že je k dispozici vlastnost SubscriptionRequired a má hodnotu false.

Přípustné hodnoty: false, true
--description

Popis produktu. Může obsahovat značky formátování HTML.

--force-string

Při použití set nebo add zachovávejte řetězcové literály místo pokusu o převod na JSON.

Default value: False
--if-match

ETag of the Entity.

--legal-terms

Podmínky použití produktu. Vývojáři, kteří se pokoušejí přihlásit k odběru produktu, se zobrazí a před dokončením procesu předplatného musí tyto podmínky přijmout.

--no-wait

Nečekejte na dokončení dlouhotrvající operace.

Default value: False
--product-name

Název produktu.

--remove

Odeberte vlastnost nebo prvek ze seznamu. Příklad: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Default value: []
--set

Aktualizujte objekt zadáním cesty vlastnosti a hodnoty, která se má nastavit. Příklad: --set property1.property2=<value>.

Default value: []
--state

Bez ohledu na to, jestli je produkt publikovaný nebo ne. Publikované produkty můžou zjistit uživatelé portálu pro vývojáře. Nepublikovaná produkty jsou viditelné pouze správcům. Výchozí stav Produktu neníPublished. Mezi možné hodnoty patří: notPublished, Published.

Přípustné hodnoty: notPublished, published
--subscription-required -s

Určuje, jestli se pro přístup k rozhraním API zahrnutým v tomto produktu vyžaduje předplatné produktu.

Přípustné hodnoty: false, true
--subscriptions-limit

Určuje, jestli počet předplatných, které může uživatel mít k tomuto produktu současně. Nastavte na hodnotu null nebo vynecháte povolení neomezeného počtu předplatných pro jednotlivé uživatele. Může být k dispozici pouze v případě, že je k dispozici vlastnost SubscriptionRequired a má hodnotu false.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az apim product wait

Upravit

Umístěte rozhraní příkazového řádku do stavu čekání, dokud nebude splněna podmínka produktu apim.

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

Příklady

Umístěte rozhraní příkazového řádku do stavu čekání, dokud nebude splněna podmínka apim. (automaticky vygenerováno)

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

Povinné parametry

--product-id

Identifikátor produktu. V aktuální instanci služby API Management musí být jedinečné.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--service-name -n

Název instance služby API Management.

Volitelné parametry

--created

Počkejte na vytvoření s 'provisioningState' v 'Succeeded'.

Default value: False
--custom

Počkejte, až podmínka splňuje vlastní dotaz JMESPath. Například provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Počkejte na odstranění.

Default value: False
--exists

Počkejte, až prostředek existuje.

Default value: False
--interval

Interval dotazování v sekundách

Default value: 30
--timeout

Maximální čekání v sekundách.

Default value: 3600
--updated

Počkejte, dokud se neaktualizuje stav zřizování ve stavu Úspěch.

Default value: False
Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.