Dela via

az apim product

  • Referens

Hantera Azure API Management-produkter.

Kommandon

Name Description Typ Status
az apim product api

Hantera API:er för Azure API Management Product.

 Kärna Allmän tillgänglighet
az apim product api add

Lägg till ett API i den angivna produkten.

 Kärna Allmän tillgänglighet
az apim product api check

Kontrollerar att API-entiteten som anges av identifieraren är associerad med entiteten Produkt.

 Kärna Allmän tillgänglighet
az apim product api delete

Tar bort det angivna API:et från den angivna produkten.

 Kärna Allmän tillgänglighet
az apim product api list

Visar en samling api:er som är associerade med en produkt.

 Kärna Allmän tillgänglighet
az apim product create

Skapar en produkt.

 Kärna Allmän tillgänglighet
az apim product delete

Ta bort produkten.

 Kärna Allmän tillgänglighet
az apim product list

Visar en samling produkter i den angivna tjänstinstansen.

 Kärna Allmän tillgänglighet
az apim product show

Hämtar information om den produkt som anges av dess identifierare.

 Kärna Allmän tillgänglighet
az apim product update

Uppdatera befintlig produktinformation.

 Kärna Allmän tillgänglighet
az apim product wait

Placera CLI i vänteläge tills ett villkor för en apim-produkt uppfylls.

 Kärna Allmän tillgänglighet

az apim product create

Redigera

Skapar en 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]

Exempel

Skapar en 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"

Obligatoriska parametrar

--product-name

Produktnamn.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--service-name -n

Namnet på api Management Service-instansen.

Valfria parametrar

--approval-required

Om prenumerationsgodkännande krävs. Om det är falskt godkänns nya prenumerationer automatiskt så att utvecklare kan anropa produktens API:er omedelbart efter prenumerationen. Om det är sant måste administratörer godkänna prenumerationen manuellt innan utvecklaren kan använda någon av produktens API:er. Kan bara finnas om egenskapen subscriptionRequired finns och har värdet false.

accepterade värden: false, true
--description

Produktbeskrivning. Kan innehålla HTML-formateringstaggar.

--legal-terms

Användningsvillkor för produkten. Utvecklare som försöker prenumerera på produkten kommer att presenteras och måste acceptera dessa villkor innan de kan slutföra prenumerationsprocessen.

--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

standardvärde: False
--product-id

Produktidentifierare. Måste vara unikt i den aktuella API Management-tjänstinstansen.

--state

Om produkten är publicerad eller inte. Publicerade produkter kan identifieras av användare av utvecklarportalen. Icke publicerade produkter är endast synliga för administratörer. Standardtillståndet för Product är intePublicerat. Möjliga värden är: "notPublished", "published".

accepterade värden: notPublished, published
--subscription-required -s

Om en produktprenumeration krävs för åtkomst till API:er som ingår i den här produkten.

accepterade värden: false, true
--subscriptions-limit

Om antalet prenumerationer som en användare kan ha på den här produkten samtidigt. Ange till null eller utelämna för att tillåta obegränsade prenumerationer per användare. Kan bara finnas om egenskapen subscriptionRequired finns och har värdet false.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az apim product delete

Redigera

Ta bort produkten.

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

Exempel

Ta bort produkten med alla prenumerationer på den här produkten.

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

Obligatoriska parametrar

--product-id

Produktidentifierare. Måste vara unikt i den aktuella API Management-tjänstinstansen.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--service-name -n

Namnet på api Management Service-instansen.

Valfria parametrar

--delete-subscriptions

Ta bort befintliga prenumerationer som är associerade med produkten eller inte.

--if-match

ETag för entiteten.

--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

standardvärde: False
--yes -y

Fråga inte efter bekräftelse.

standardvärde: False
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az apim product list

Redigera

Visar en samling produkter i den angivna tjänstinstansen.

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

Exempel

Visa en lista över alla produkter för den här APIM-instansen.

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

Obligatoriska parametrar

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--service-name -n

Namnet på api Management Service-instansen.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az apim product show

Redigera

Hämtar information om den produkt som anges av dess identifierare.

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

Exempel

Hämtar information om den produkt som anges av dess identifierare.

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

Obligatoriska parametrar

--product-id

Produktidentifierare. Måste vara unikt i den aktuella API Management-tjänstinstansen.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--service-name -n

Namnet på api Management Service-instansen.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az apim product update

Redigera

Uppdatera befintlig produktinformation.

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]

Exempel

Uppdatera befintlig produktinformation.

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"

Obligatoriska parametrar

--product-id

Produktidentifierare. Måste vara unikt i den aktuella API Management-tjänstinstansen.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--service-name -n

Namnet på api Management Service-instansen.

Valfria parametrar

--add

Lägg till ett objekt i en lista över objekt genom att ange en sökväg och nyckelvärdepar. Exempel: --add property.listProperty <key=value, string or JSON string>.

standardvärde: []
--approval-required

Om prenumerationsgodkännande krävs. Om det är falskt godkänns nya prenumerationer automatiskt så att utvecklare kan anropa produktens API:er omedelbart efter prenumerationen. Om det är sant måste administratörer godkänna prenumerationen manuellt innan utvecklaren kan använda någon av produktens API:er. Kan bara finnas om egenskapen subscriptionRequired finns och har värdet false.

accepterade värden: false, true
--description

Produktbeskrivning. Kan innehålla HTML-formateringstaggar.

--force-string

När du använder "set" eller "add" bevarar du strängliteraler i stället för att försöka konvertera till JSON.

standardvärde: False
--if-match

ETag för entiteten.

--legal-terms

Användningsvillkor för produkten. Utvecklare som försöker prenumerera på produkten kommer att presenteras och måste acceptera dessa villkor innan de kan slutföra prenumerationsprocessen.

--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

standardvärde: False
--product-name

Produktnamn.

--remove

Ta bort en egenskap eller ett element från en lista. Exempel: --remove property.list <indexToRemove> ELLER --remove propertyToRemove.

standardvärde: []
--set

Uppdatera ett objekt genom att ange en egenskapssökväg och ett värde som ska anges. Exempel: --set property1.property2=<value>.

standardvärde: []
--state

Om produkten är publicerad eller inte. Publicerade produkter kan identifieras av användare av utvecklarportalen. Icke publicerade produkter är endast synliga för administratörer. Standardtillståndet för Product är intePublicerat. Möjliga värden är: "notPublished", "published".

accepterade värden: notPublished, published
--subscription-required -s

Om en produktprenumeration krävs för åtkomst till API:er som ingår i den här produkten.

accepterade värden: false, true
--subscriptions-limit

Om antalet prenumerationer som en användare kan ha på den här produkten samtidigt. Ange till null eller utelämna för att tillåta obegränsade prenumerationer per användare. Kan bara finnas om egenskapen subscriptionRequired finns och har värdet false.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az apim product wait

Redigera

Placera CLI i vänteläge tills ett villkor för en apim-produkt uppfylls.

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

Exempel

Placera CLI i vänteläge tills ett villkor för en apim uppfylls. (automatiskt genererad)

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

Obligatoriska parametrar

--product-id

Produktidentifierare. Måste vara unikt i den aktuella API Management-tjänstinstansen.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--service-name -n

Namnet på api Management Service-instansen.

Valfria parametrar

--created

Vänta tills du har skapat med "provisioningState" på "Lyckades".

standardvärde: False
--custom

Vänta tills villkoret uppfyller en anpassad JMESPath-fråga. T.ex. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Vänta tills den har tagits bort.

standardvärde: False
--exists

Vänta tills resursen finns.

standardvärde: False
--interval

Avsökningsintervall i sekunder.

standardvärde: 30
--timeout

Maximal väntetid i sekunder.

standardvärde: 3600
--updated

Vänta tills det har uppdaterats med provisioningState på Lyckades.

standardvärde: False
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.