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
Productnaam.
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
De naam van het service-exemplaar van API Management.
Optionele parameters
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.
Productbeschrijving. Kan HTML-opmaaktags bevatten.
Productgebruiksvoorwaarden. Ontwikkelaars die zich op het product willen abonneren, worden weergegeven en moeten deze voorwaarden accepteren voordat ze het abonnementsproces kunnen voltooien.
Wacht niet tot de langlopende bewerking is uitgevoerd.
Product-id. Moet uniek zijn in het huidige API Management service-exemplaar.
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.
Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID .
Hiermee wordt bepaald of een productabonnement vereist is voor toegang tot API's die in dit product zijn opgenomen.
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.
Vergroot de logboekbebossing om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekverkenbaarheid. Gebruik --debug voor volledige logboeken voor foutopsporing.
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. Moet uniek zijn in het huidige API Management service-exemplaar.
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
De naam van het service-exemplaar van API Management.
Optionele parameters
Bestaande abonnementen verwijderen die al dan niet aan het product zijn gekoppeld.
ETag van de entiteit.
Wacht niet tot de langlopende bewerking is uitgevoerd.
Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID .
Niet vragen om bevestiging.
Vergroot de logboekbebossing om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekverkenbaarheid. Gebruik --debug voor volledige logboeken voor foutopsporing.
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
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
De naam van het service-exemplaar van API Management.
Optionele parameters
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.
Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID .
Vergroot de logboekbebossing om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekverkenbaarheid. Gebruik --debug voor volledige logboeken voor foutopsporing.
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. Moet uniek zijn in het huidige API Management service-exemplaar.
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
De naam van het service-exemplaar van API Management.
Optionele parameters
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.
Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID .
Vergroot de logboekbebossing om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekverkenbaarheid. Gebruik --debug voor volledige logboeken voor foutopsporing.
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. Moet uniek zijn in het huidige API Management service-exemplaar.
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
De naam van het service-exemplaar van API Management.
Optionele parameters
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>.
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.
Productbeschrijving. Kan HTML-opmaaktags bevatten.
Wanneer u 'set' of 'add' gebruikt, behoudt u letterlijke tekenreeksen in plaats van te proberen te converteren naar JSON.
ETag van de entiteit.
Productgebruiksvoorwaarden. Ontwikkelaars die zich op het product willen abonneren, worden weergegeven en moeten deze voorwaarden accepteren voordat ze het abonnementsproces kunnen voltooien.
Wacht niet tot de langlopende bewerking is uitgevoerd.
Productnaam.
Verwijder een eigenschap of een element uit een lijst. Voorbeeld: --remove property.list OR --remove propertyToRemove.
Werk een object bij door een eigenschapspad en waarde op te geven die moeten worden ingesteld. Voorbeeld: --set property1.property2=.
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.
Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID .
Hiermee wordt bepaald of een productabonnement vereist is voor toegang tot API's die in dit product zijn opgenomen.
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.
Vergroot de logboekbebossing om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekverkenbaarheid. Gebruik --debug voor volledige logboeken voor foutopsporing.
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. Moet uniek zijn in het huidige API Management service-exemplaar.
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
De naam van het service-exemplaar van API Management.
Optionele parameters
Wacht totdat u met provisioningState bij Succeeded hebt gemaakt.
Wacht totdat de voorwaarde voldoet aan een aangepaste JMESPath-query. Bijvoorbeeld provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wacht totdat u deze hebt verwijderd.
Wacht totdat de resource bestaat.
Pollinginterval in seconden.
Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID .
Maximale wachttijd in seconden.
Wacht totdat de provisioningState is bijgewerkt op 'Succeeded'.
Vergroot de logboekbebossing om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekverkenbaarheid. Gebruik --debug voor volledige logboeken voor foutopsporing.