Megosztás a következőn keresztül:

az apim product

  • Referencia

Az Azure API Management termékének kezelése.

Parancsok

Name Description Típus Állapot
az apim product api

Az Azure API Management Product API-jainak kezelése.

 Alapvető FE
az apim product api add

Adjon hozzá egy API-t a megadott termékhez.

 Alapvető FE
az apim product api check

Ellenőrzi, hogy az azonosító által megadott API-entitás társítva van-e a Termék entitással.

 Alapvető FE
az apim product api delete

Törli a megadott API-t a megadott termékből.

 Alapvető FE
az apim product api list

A termékhez társított API-k gyűjteményét sorolja fel.

 Alapvető FE
az apim product create

Létrehoz egy terméket.

 Alapvető FE
az apim product delete

Termék törlése.

 Alapvető FE
az apim product list

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

 Alapvető FE
az apim product show

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

 Alapvető FE
az apim product update

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

 Alapvető FE
az apim product wait

Helyezze a parancssori felületet várakozási állapotba, amíg egy apim-termék valamely feltétele teljesül.

 Alapvető FE

az apim product create

Szerkesztés

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 konfigurálhatja a következővel az configure --defaults group=<name>: .

--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ő használhatja a termék API-jait. Csak akkor lehet jelen, ha az subscriptionRequired tulajdonság jelen van, és értéke hamis.

elfogadott értékek: false, true
--description

Termék leírása. HTML-formázási címkéket is tartalmazhat.

--legal-terms

Termék használati feltételei. A termékre feliratkozni 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.

alapértelmezett érték: False
--product-id

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

--state

Függetlenül attól, hogy a termék közzé van-e téve. A közzétett termékeket a fejlesztői portál felhasználói fedezhetik fel. 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. A lehetséges értékek a következők: "notPublished", "published".

elfogadott értékek: notPublished, published
--subscription-required -s

Az, hogy 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 jelzi, hogy a felhasználónak hány előfizetése lehet egyszerre ehhez a termékhez. Állítsa null értékre vagy kihagyásra, hogy felhasználói előfizetésenként korlátlan legyen. Csak akkor lehet jelen, ha az 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.

elfogadott értékek: json, jsonc, none, table, tsv, yaml, yamlc
alapértelmezett érték: json
--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 konfigurálhatja a következővel az account set -s NAME_OR_ID: .

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az apim product delete

Szerkesztés

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 konfigurálhatja a következővel az configure --defaults group=<name>: .

--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.

alapértelmezett érték: False
--yes -y

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

alapértelmezett érték: False
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.

elfogadott értékek: json, jsonc, none, table, tsv, yaml, yamlc
alapértelmezett érték: json
--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 konfigurálhatja a következővel az account set -s NAME_OR_ID: .

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az apim product list

Szerkesztés

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 konfigurálhatja a következővel az configure --defaults group=<name>: .

--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.

elfogadott értékek: json, jsonc, none, table, tsv, yaml, yamlc
alapértelmezett érték: json
--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 konfigurálhatja a következővel az account set -s NAME_OR_ID: .

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az apim product show

Szerkesztés

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

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

Példák

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

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 konfigurálhatja a következővel az configure --defaults group=<name>: .

--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.

elfogadott értékek: json, jsonc, none, table, tsv, yaml, yamlc
alapértelmezett érték: json
--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 konfigurálhatja a következővel az account set -s NAME_OR_ID: .

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az apim product update

Szerkesztés

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

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 konfigurálhatja a következővel az configure --defaults group=<name>: .

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

alapértelmezett érték: []
--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ő használhatja a termék API-jait. Csak akkor lehet jelen, ha az subscriptionRequired tulajdonság jelen van, és értéke hamis.

elfogadott értékek: false, true
--description

Termék leírása. HTML-formázási címkéket is tartalmazhat.

--force-string

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

alapértelmezett érték: False
--if-match

Az entitás ETagje.

--legal-terms

Termék használati feltételei. A termékre feliratkozni 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.

alapértelmezett érték: False
--product-name

Terméknév.

--remove

Tulajdonság vagy elem eltávolítása a listából. Példa: --remove property.list <indexToRemove> VAGY --remove propertyToRemove.

alapértelmezett érték: []
--set

Frissítsen egy objektumot egy beállítandó tulajdonság elérési útjának és értékének megadásával. Példa: --set property1.property2=<value>

alapértelmezett érték: []
--state

Függetlenül attól, hogy a termék közzé van-e téve. A közzétett termékeket a fejlesztői portál felhasználói fedezhetik fel. 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. A lehetséges értékek a következők: "notPublished", "published".

elfogadott értékek: notPublished, published
--subscription-required -s

Az, hogy 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 jelzi, hogy a felhasználónak hány előfizetése lehet egyszerre ehhez a termékhez. Állítsa null értékre vagy kihagyásra, hogy felhasználói előfizetésenként korlátlan legyen. Csak akkor lehet jelen, ha az 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.

elfogadott értékek: json, jsonc, none, table, tsv, yaml, yamlc
alapértelmezett érték: json
--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 konfigurálhatja a következővel az account set -s NAME_OR_ID: .

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az apim product wait

Szerkesztés

Helyezze a parancssori felületet várakozási állapotba, amíg egy apim-termék valamely feltétele 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ási állapotba, amíg az apim egy feltételének 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ó. 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 konfigurálhatja a következővel az configure --defaults group=<name>: .

--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" a "Sikeres" helyen.

alapértelmezett érték: False
--custom

Várjon, amíg a feltétel megfelel egy egyéni JMESPath-lekérdezésnek. Pl. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running"?.

--deleted

Várjon a törlésig.

alapértelmezett érték: False
--exists

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

alapértelmezett érték: False
--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 a következő helyen: "Sikeres".

alapértelmezett érték: False
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.

elfogadott értékek: json, jsonc, none, table, tsv, yaml, yamlc
alapértelmezett érték: json
--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 konfigurálhatja a következővel az account set -s NAME_OR_ID: .

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.