az apim product

Azure API Management Product's beheren.

Opdracht

az apim product api

De API'API Management van Azure API Management product beheren.

az apim product api add

Voeg een API toe aan het opgegeven product.

az apim product api check

Controleert of de API-entiteit die is opgegeven door id, is gekoppeld aan de entiteit Product.

az apim product api delete

Hiermee verwijdert u de opgegeven API uit het opgegeven product.

az apim product api list

Geeft een verzameling van de API's weer die aan een product zijn gekoppeld.

az apim product create

Hiermee maakt u een product.

az apim product delete

Product verwijderen.

az apim product list

Een lijst met een verzameling producten in het opgegeven service-exemplaar.

az apim product show

Hiermee haalt u de details op van het product dat is opgegeven door de id.

az apim product update

Bestaande productdetails bijwerken.

az apim product wait

Plaats de CLI in een wachttoestand totdat aan een voorwaarde van een APIM-product wordt voldaan.

az apim product create

Hiermee maakt u een product.

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

Voorbeelden

Hiermee maakt u een product.

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"

Vereiste parameters

--product-name

Productnaam.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .

--service-name -n

De naam van het service-exemplaar van API Management.

Optionele parameters

--approval-required

Of abonnementsgoedkeuring is vereist. Indien onwaar, worden nieuwe abonnementen automatisch goedgekeurd, zodat ontwikkelaars onmiddellijk na het abonneren de API's van het product kunnen aanroepen. Indien waar, moeten beheerders het abonnement handmatig goedkeuren voordat de ontwikkelaar een van de API's van het product kan gebruiken. Kan alleen aanwezig zijn als de eigenschap subscriptionRequired aanwezig is en de waarde false heeft.

--description

Productbeschrijving. Kan HTML-opmaaktags bevatten.

--legal-terms

Productgebruiksvoorwaarden. Ontwikkelaars die zich op het product willen abonneren, worden weergegeven en moeten deze voorwaarden accepteren voordat ze het abonnementsproces kunnen voltooien.

--no-wait

Wacht niet tot de langlopende bewerking is uitgevoerd.

--product-id

Product-id. Moet uniek zijn in het huidige API Management service-exemplaar.

--state

Of het product is gepubliceerd of niet. Gepubliceerde producten kunnen worden ontdekt door gebruikers van de ontwikkelaarsportal. Niet-gepubliceerde producten zijn alleen zichtbaar voor beheerders. De standaardtoestand product is niet Gepubliceerd.

geaccepteerde waarden: notPublished, published
--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID .

--subscription-required -s

Hiermee wordt bepaald of een productabonnement vereist is voor toegang tot API's die in dit product zijn opgenomen.

--subscriptions-limit

Of het aantal abonnementen dat een gebruiker op hetzelfde moment voor dit product kan hebben. Ingesteld op null of weglaten om onbeperkte abonnementen per gebruiker toe te staan. Kan alleen aanwezig zijn als de eigenschap subscriptionRequired aanwezig is en de waarde false heeft.

az apim product delete

Product verwijderen.

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

Voorbeelden

Verwijder het product met alle abonnementen op dit product.

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

Vereiste parameters

--product-id

Product-id. Moet uniek zijn in het huidige API Management service-exemplaar.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .

--service-name -n

De naam van het service-exemplaar van API Management.

Optionele parameters

--delete-subscriptions

Bestaande abonnementen verwijderen die al dan niet aan het product zijn gekoppeld.

--if-match

ETag van de entiteit.

--no-wait

Wacht niet tot de langlopende bewerking is uitgevoerd.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID .

--yes -y

Niet vragen om bevestiging.

az apim product list

Een lijst met een verzameling producten in het opgegeven service-exemplaar.

az apim product list --resource-group
                     --service-name
                     [--query-examples]
                     [--subscription]

Voorbeelden

Lijst met alle producten voor dit APIM-exemplaar.

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

Vereiste parameters

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .

--service-name -n

De naam van het service-exemplaar van API Management.

Optionele parameters

--query-examples

JMESPath-tekenreeks voor u aanbevelen. U kunt een van de query's kopiƫren en deze na de parameter --query tussen dubbele aanhalingstekens plakken om de resultaten te bekijken. U kunt een of meer positionele trefwoorden toevoegen, zodat we suggesties kunnen geven op basis van deze sleutelwoorden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID .

az apim product show

Hiermee haalt u de details op van het product dat is opgegeven door de id.

az apim product show --product-id
                     --resource-group
                     --service-name
                     [--query-examples]
                     [--subscription]

Voorbeelden

Hiermee haalt u de details op van het product dat is opgegeven door de id.

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

Vereiste parameters

--product-id

Product-id. Moet uniek zijn in het huidige API Management service-exemplaar.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .

--service-name -n

De naam van het service-exemplaar van API Management.

Optionele parameters

--query-examples

JMESPath-tekenreeks voor u aanbevelen. U kunt een van de query's kopiƫren en deze na de parameter --query tussen dubbele aanhalingstekens plakken om de resultaten te bekijken. U kunt een of meer positionele trefwoorden toevoegen, zodat we suggesties kunnen geven op basis van deze sleutelwoorden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID .

az apim product update

Bestaande productdetails bijwerken.

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

Voorbeelden

Bestaande productdetails bijwerken.

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"

Vereiste parameters

--product-id

Product-id. Moet uniek zijn in het huidige API Management service-exemplaar.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .

--service-name -n

De naam van het service-exemplaar van API Management.

Optionele parameters

--add

Voeg een -object toe aan een lijst met objecten door een pad- en sleutelwaardeparen op te geven. Voorbeeld: --add property.listProperty <key=value, string of JSON string>.

--approval-required

Of abonnementsgoedkeuring is vereist. Indien onwaar, worden nieuwe abonnementen automatisch goedgekeurd, zodat ontwikkelaars onmiddellijk na het abonneren de API's van het product kunnen aanroepen. Indien waar, moeten beheerders het abonnement handmatig goedkeuren voordat de ontwikkelaar een van de API's van het product kan gebruiken. Kan alleen aanwezig zijn als de eigenschap subscriptionRequired aanwezig is en de waarde false heeft.

--description

Productbeschrijving. Kan HTML-opmaaktags bevatten.

--force-string

Wanneer u 'set' of 'add' gebruikt, behoudt u letterlijke tekenreeksen in plaats van te proberen te converteren naar JSON.

--if-match

ETag van de entiteit.

--legal-terms

Productgebruiksvoorwaarden. Ontwikkelaars die zich op het product willen abonneren, worden weergegeven en moeten deze voorwaarden accepteren voordat ze het abonnementsproces kunnen voltooien.

--no-wait

Wacht niet tot de langlopende bewerking is uitgevoerd.

--product-name

Productnaam.

--remove

Verwijder een eigenschap of een element uit een lijst. Voorbeeld: --remove property.list OR --remove propertyToRemove.

--set

Werk een object bij door een eigenschapspad en waarde op te geven die moeten worden ingesteld. Voorbeeld: --set property1.property2=.

--state

Of het product is gepubliceerd of niet. Gepubliceerde producten kunnen worden ontdekt door gebruikers van de ontwikkelaarsportal. Niet-gepubliceerde producten zijn alleen zichtbaar voor beheerders. De standaardtoestand product is niet Gepubliceerd.

geaccepteerde waarden: notPublished, published
--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID .

--subscription-required -s

Hiermee wordt bepaald of een productabonnement vereist is voor toegang tot API's die in dit product zijn opgenomen.

--subscriptions-limit

Of het aantal abonnementen dat een gebruiker op hetzelfde moment voor dit product kan hebben. Ingesteld op null of weglaten om onbeperkte abonnementen per gebruiker toe te staan. Kan alleen aanwezig zijn als de eigenschap subscriptionRequired aanwezig is en de waarde false heeft.

az apim product wait

Plaats de CLI in een wachttoestand totdat aan een voorwaarde van een APIM-product wordt voldaan.

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

Voorbeelden

Plaats de CLI in een wachttoestand totdat aan een voorwaarde van een APIM wordt voldaan. (automatisch gegenereerd)

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

Vereiste parameters

--product-id

Product-id. Moet uniek zijn in het huidige API Management service-exemplaar.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .

--service-name -n

De naam van het service-exemplaar van API Management.

Optionele parameters

--created

Wacht totdat u met provisioningState bij Succeeded hebt gemaakt.

--custom

Wacht totdat de voorwaarde voldoet aan een aangepaste JMESPath-query. Bijvoorbeeld provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wacht totdat u deze hebt verwijderd.

--exists

Wacht totdat de resource bestaat.

--interval

Pollinginterval in seconden.

standaardwaarde: 30
--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID .

--timeout

Maximale wachttijd in seconden.

standaardwaarde: 3600
--updated

Wacht totdat de provisioningState is bijgewerkt op 'Succeeded'.