az apim product

Az Azure API Management Product's kezelése.

Parancsok

az apim product api	Az Azure API Management Product API-jának kezelése.
az apim product api add	Adjon hozzá egy API-t a megadott termékhez.
az apim product api check	Ellenőrzi, hogy az azonosító által megadott API-entitás társítva van-e a Product entitással.
az apim product api delete	Törli a megadott API-t a megadott termékből.
az apim product api list	A termékhez társított API-k gyűjteményét sorolja fel.
az apim product create	Létrehoz egy terméket.
az apim product delete	Termék törlése.
az apim product list	A megadott szolgáltatáspéldányban található termékek gyűjteményét sorolja fel.
az apim product show	Lekéri az azonosító által megadott termék adatait.
az apim product update	Frissítse a meglévő termékadatokat.
az apim product wait	Helyezze a parancssori felületet várakozási állapotba, amíg egy APIM-termék valamely feltételének nem teljesül.

az apim product create

Létrehoz egy terméket.

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éldák

Létrehoz egy terméket.

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"

Kötelező paraméterek

--product-name

Terméknév.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot a következővel az configure --defaults group=<name>konfigurálhatja: .

--service-name -n

Az API Management szolgáltatáspéldány neve.

Opcionális paraméterek

--approval-required

Szükség van-e az előfizetés jóváhagyására. Ha hamis, a rendszer automatikusan jóváhagyja az új előfizetéseket, így a fejlesztők közvetlenül a feliratkozás után meghívhatják a termék API-jait. Ha igaz, a rendszergazdáknak manuálisan jóvá kell hagyniuk az előfizetést, mielőtt a fejlesztő bármelyik termék API-ját használhatja. Csak akkor lehet jelen, ha a subscriptionRequired tulajdonság jelen van, és értéke hamis.

elfogadott értékek: false, true

--description

Termékleírás. Html formázási címkéket is tartalmazhat.

--legal-terms

Termék használati feltételei. A termékre előfizetni próbáló fejlesztők megjelennek, és el kell fogadniuk ezeket a feltételeket, mielőtt befejezhetik az előfizetési folyamatot.

--no-wait

Ne várja meg, amíg a hosszú ideig futó művelet befejeződik.

--product-id

Termékazonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

--state

Azt jelzi, hogy a termék közzé van-e téve. A közzétett termékeket a fejlesztői portál felhasználói felfedezhetik. A nem közzétett termékek csak a rendszergazdák számára láthatók. A Termék alapértelmezett állapota nincs közzétéve.

elfogadott értékek: notPublished, published

--subscription-required -s

Szükség van-e termék-előfizetésre a termékben található API-k eléréséhez.

elfogadott értékek: false, true

--subscriptions-limit

Azt határozza meg, hogy a felhasználó hány előfizetéssel rendelkezhet egyszerre a termékhez. Állítsa null értékre, vagy hagyja ki, hogy felhasználói előfizetésenként korlátlan számú előfizetést engedélyezhessen. Csak akkor lehet jelen, ha a subscriptionRequired tulajdonság jelen van, és értéke hamis.

Globális paraméterek

--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

--output -o

Kimeneti formátum.

--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést a használatával az account set -s NAME_OR_IDkonfigurálhatja.

--verbose

Növelje a naplózás részletességét. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az apim product delete

Termék törlése.

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

Példák

A termékhez tartozó összes előfizetéssel rendelkező termék törlése.

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

Kötelező paraméterek

--product-id

Termékazonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot a következővel az configure --defaults group=<name>konfigurálhatja: .

--service-name -n

Az API Management szolgáltatáspéldány neve.

Opcionális paraméterek

--delete-subscriptions

Törölje a termékhez társított meglévő előfizetéseket, vagy sem.

--if-match

Az entitás ETagje.

--no-wait

Ne várja meg, amíg a hosszú ideig futó művelet befejeződik.

--yes -y

Ne kérje a megerősítést.

Globális paraméterek

--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

--output -o

Kimeneti formátum.

--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést a használatával az account set -s NAME_OR_IDkonfigurálhatja.

--verbose

Növelje a naplózás részletességét. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az apim product list

A megadott szolgáltatáspéldányban található termékek gyűjteményét sorolja fel.

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

Példák

Az APIM-példányhoz tartozó összes termék listázása.

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

Kötelező paraméterek

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot a következővel az configure --defaults group=<name>konfigurálhatja: .

--service-name -n

Az API Management szolgáltatáspéldány neve.

Globális paraméterek

--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

--output -o

Kimeneti formátum.

--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést a használatával az account set -s NAME_OR_IDkonfigurálhatja.

--verbose

Növelje a naplózás részletességét. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az apim product show

Lekéri az azonosító által megadott termék adatait.

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

Példák

Lekéri az azonosító által megadott termék adatait.

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

Kötelező paraméterek

--product-id

Termékazonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot a következővel az configure --defaults group=<name>konfigurálhatja: .

--service-name -n

Az API Management szolgáltatáspéldány neve.

Globális paraméterek

--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

--output -o

Kimeneti formátum.

--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést a használatával az account set -s NAME_OR_IDkonfigurálhatja.

--verbose

Növelje a naplózás részletességét. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az apim product update

Meglévő termékadatok frissítése.

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éldák

Frissítse a meglévő termékadatokat.

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"

Kötelező paraméterek

--product-id

Termékazonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot a következővel az configure --defaults group=<name>konfigurálhatja: .

--service-name -n

Az API Management szolgáltatáspéldány neve.

Opcionális paraméterek

--add

Adjon hozzá egy objektumot az objektumok listájához egy elérési út és egy kulcsértékpár megadásával. Példa: --add property.listProperty <key=value, string vagy JSON string>.

--approval-required

Szükség van-e az előfizetés jóváhagyására. Ha hamis, a rendszer automatikusan jóváhagyja az új előfizetéseket, így a fejlesztők közvetlenül a feliratkozás után meghívhatják a termék API-jait. Ha igaz, a rendszergazdáknak manuálisan jóvá kell hagyniuk az előfizetést, mielőtt a fejlesztő bármelyik termék API-ját használhatja. Csak akkor lehet jelen, ha a subscriptionRequired tulajdonság jelen van, és értéke hamis.

elfogadott értékek: false, true

--description

Termékleírás. Html formázási címkéket is tartalmazhat.

--force-string

A "set" vagy a "add" használatakor a JSON-ra való konvertálás helyett őrizze meg a sztringkonstansokat.

--if-match

Az entitás ETagje.

--legal-terms

Termék használati feltételei. A termékre előfizetni próbáló fejlesztők megjelennek, és el kell fogadniuk ezeket a feltételeket, mielőtt befejezhetik az előfizetési folyamatot.

--no-wait

Ne várja meg, amíg a hosszú ideig futó művelet befejeződik.

--product-name

Terméknév.

--remove

Tulajdonság vagy elem eltávolítása egy listából. Példa: --remove property.list OR --remove propertyToRemove.

--set

Objektum frissítése egy beállítandó tulajdonság elérési útjának és értékének megadásával. Példa: --set property1.property2=.

--state

Azt jelzi, hogy a termék közzé van-e téve. A közzétett termékeket a fejlesztői portál felhasználói felfedezhetik. A nem közzétett termékek csak a rendszergazdák számára láthatók. A Termék alapértelmezett állapota nincs közzétéve.

elfogadott értékek: notPublished, published

--subscription-required -s

Szükség van-e termék-előfizetésre a termékben található API-k eléréséhez.

elfogadott értékek: false, true

--subscriptions-limit

Azt határozza meg, hogy a felhasználó hány előfizetéssel rendelkezhet egyszerre a termékhez. Állítsa null értékre, vagy hagyja ki, hogy felhasználói előfizetésenként korlátlan számú előfizetést engedélyezhessen. Csak akkor lehet jelen, ha a subscriptionRequired tulajdonság jelen van, és értéke hamis.

Globális paraméterek

--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

--output -o

Kimeneti formátum.

--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést a használatával az account set -s NAME_OR_IDkonfigurálhatja.

--verbose

Növelje a naplózás részletességét. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az apim product wait

Helyezze a parancssori felületet várakozó állapotba, amíg egy APIM-termék valamelyik feltételének nem teljesül.

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

Példák

Helyezze a parancssori felületet várakozó állapotba, amíg egy APIM-feltétel nem teljesül. (automatikusan létrehozott)

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

Kötelező paraméterek

--product-id

Termékazonosító. Egyedinek kell lennie az aktuális API Management szolgáltatáspéldányban.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot a használatával az configure --defaults group=<name>konfigurálhatja.

--service-name -n

Az API Management szolgáltatáspéldány neve.

Opcionális paraméterek

--created

Várjon, amíg létre nem jön a "provisioningState" paraméter a "Succeeded" (Sikeres) állapotban.

--custom

Várja meg, amíg a feltétel megfelel egy egyéni JMESPath-lekérdezésnek. Például provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Várjon a törlésig.

--exists

Várjon, amíg az erőforrás létezik.

--interval

Lekérdezési időköz másodpercben.

alapértelmezett érték: 30

--timeout

Maximális várakozás másodpercben.

alapértelmezett érték: 3600

--updated

Várjon, amíg frissül a provisioningState paraméterrel a "Succeeded" (Sikeres) időpontban.

Globális paraméterek

--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

--output -o

Kimeneti formátum.

--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést a használatával az account set -s NAME_OR_IDkonfigurálhatja.

--verbose

Növelje a naplózás részletességét. Használja a --debug parancsot a teljes hibakeresési naplókhoz.