Delen via

az apim product

Azure API Management-product beheren.

Opdracht

Name Description Type Status
az apim product api

Api's van Azure API Management-producten beheren.

 Core GA
az apim product api add

Voeg een API toe aan het opgegeven product.

 Core GA
az apim product api check

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

 Core GA
az apim product api delete

Hiermee verwijdert u de opgegeven API uit het opgegeven product.

 Core GA
az apim product api list

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

 Core GA
az apim product create

Hiermee maakt u een product.

 Core GA
az apim product delete

Product verwijderen.

 Core GA
az apim product list

Geeft een verzameling producten weer in het opgegeven service-exemplaar.

 Core GA
az apim product show

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

 Core GA
az apim product update

Bestaande productdetails bijwerken.

 Core GA
az apim product wait

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

 Core GA

az apim product create

Bewerken

Hiermee maakt u een product.

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]

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

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

--service-name -n

De naam van het api management-service-exemplaar.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--approval-required

Of goedkeuring van het abonnement vereist is. Als dit onwaar is, worden nieuwe abonnementen automatisch goedgekeurd, zodat ontwikkelaars de API's van het product direct na het abonneren 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.

Eigenschap Waarde
Geaccepteerde waarden: false, true
--description

Productbeschrijving. Kan HTML-opmaaktags bevatten.

--legal-terms

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

--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

Eigenschap Waarde
Default value: False
--product-id

Product-identificatie. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.

--state

Of het product nu wel of niet wordt gepubliceerd. Gepubliceerde producten kunnen worden gedetecteerd door gebruikers van de ontwikkelaarsportal. Niet-gepubliceerde producten zijn alleen zichtbaar voor beheerders. De standaardstatus van Product is niet gepubliceerd. Mogelijke waarden zijn: 'notPublished', 'published'.

Eigenschap Waarde
Geaccepteerde waarden: notPublished, published
--subscription-required -s

Of een productabonnement vereist is voor toegang tot API's die zijn opgenomen in dit product.

Eigenschap Waarde
Geaccepteerde waarden: false, true
--subscriptions-limit

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

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

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

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False

az apim product delete

Bewerken

Product verwijderen.

az apim product delete --product-id
                       --resource-group
                       --service-name
                       [--delete-subscriptions]
                       [--if-match]
                       [--no-wait]
                       [--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-identificatie. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.

--resource-group -g

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

--service-name -n

De naam van het api management-service-exemplaar.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--delete-subscriptions

Verwijder bestaande abonnementen die aan het product zijn gekoppeld of niet.

--if-match

ETag van de entiteit.

--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

Eigenschap Waarde
Default value: False
--yes -y

Niet vragen om bevestiging.

Eigenschap Waarde
Default value: False
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

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

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False

az apim product list

Bewerken

Geeft een verzameling producten weer in het opgegeven service-exemplaar.

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

Voorbeelden

Geef alle producten voor dit APIM-exemplaar weer.

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

Vereiste parameters

--resource-group -g

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

--service-name -n

De naam van het api management-service-exemplaar.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

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

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False

az apim product show

Bewerken

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

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

Voorbeelden

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

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

Vereiste parameters

--product-id

Product-identificatie. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.

--resource-group -g

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

--service-name -n

De naam van het api management-service-exemplaar.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

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

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False

az apim product update

Bewerken

Bestaande productdetails bijwerken.

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]

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-identificatie. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.

--resource-group -g

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

--service-name -n

De naam van het api management-service-exemplaar.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--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 or JSON string>.

Eigenschap Waarde
Parametergroep: Generic Update Arguments
Default value: []
--approval-required

Of goedkeuring van het abonnement vereist is. Als dit onwaar is, worden nieuwe abonnementen automatisch goedgekeurd, zodat ontwikkelaars de API's van het product direct na het abonneren 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.

Eigenschap Waarde
Geaccepteerde waarden: false, true
--description

Productbeschrijving. Kan HTML-opmaaktags bevatten.

--force-string

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

Eigenschap Waarde
Parametergroep: Generic Update Arguments
Default value: False
--if-match

ETag van de entiteit.

--legal-terms

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

--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

Eigenschap Waarde
Default value: False
--product-name

Productnaam.

--remove

Een eigenschap of element uit een lijst verwijderen. Voorbeeld: --remove property.list <indexToRemove> OF --remove propertyToRemove.

Eigenschap Waarde
Parametergroep: Generic Update Arguments
Default value: []
--set

Werk een object bij door een eigenschapspad en waarde op te geven die u wilt instellen. Voorbeeld: --set property1.property2=<value>.

Eigenschap Waarde
Parametergroep: Generic Update Arguments
Default value: []
--state

Of het product nu wel of niet wordt gepubliceerd. Gepubliceerde producten kunnen worden gedetecteerd door gebruikers van de ontwikkelaarsportal. Niet-gepubliceerde producten zijn alleen zichtbaar voor beheerders. De standaardstatus van Product is niet gepubliceerd. Mogelijke waarden zijn: 'notPublished', 'published'.

Eigenschap Waarde
Geaccepteerde waarden: notPublished, published
--subscription-required -s

Of een productabonnement vereist is voor toegang tot API's die zijn opgenomen in dit product.

Eigenschap Waarde
Geaccepteerde waarden: false, true
--subscriptions-limit

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

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

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

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False

az apim product wait

Bewerken

Plaats de CLI in een wachtstatus 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]
                     [--timeout]
                     [--updated]

Voorbeelden

Plaats de CLI in een wachtstatus totdat aan een voorwaarde van een APIM is voldaan. (autogenerated)

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

Vereiste parameters

--product-id

Product-identificatie. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.

--resource-group -g

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

--service-name -n

De naam van het api management-service-exemplaar.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--created

Wacht totdat u 'provisioningState' hebt gemaakt bij 'Succeeded'.

Eigenschap Waarde
Parametergroep: Wait Condition Arguments
Default value: False
--custom

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

Eigenschap Waarde
Parametergroep: Wait Condition Arguments
--deleted

Wacht totdat deze is verwijderd.

Eigenschap Waarde
Parametergroep: Wait Condition Arguments
Default value: False
--exists

Wacht tot de resource bestaat.

Eigenschap Waarde
Parametergroep: Wait Condition Arguments
Default value: False
--interval

Polling-interval in seconden.

Eigenschap Waarde
Parametergroep: Wait Condition Arguments
Default value: 30
--timeout

Maximale wachttijd in seconden.

Eigenschap Waarde
Parametergroep: Wait Condition Arguments
Default value: 3600
--updated

Wacht totdat deze is bijgewerkt met provisioningState op 'Succeeded'.

Eigenschap Waarde
Parametergroep: Wait Condition Arguments
Default value: False
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

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

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False