Visszajelzés

az apim api

  • Referencia

Az Azure API Management API-k kezelése.

Parancsok

az apim api create

Hozzon létre egy API Management API-t.
az apim api delete

Töröljön egy API Management API-t.
az apim api import

Importálja az API Management API-t.
az apim api list

Listázd API Management API-ját.
az apim api operation

Azure API Management API-műveletek kezelése.
az apim api operation create

Létrehoz egy új műveletet az API-ban.
az apim api operation delete

Törli a megadott műveletet az API-ban.
az apim api operation list

Listázta a megadott API műveleteinek gyűjteményét.
az apim api operation show

Lekéri az azonosító által megadott API-művelet részleteit.
az apim api operation update

Frissítések a művelet részleteit az API-ban, amelyet az azonosítója határoz meg.
az apim api release

Az Azure API Management API kiadásának kezelése.
az apim api release create

Létrehoz egy új kiadást az API-hoz.
az apim api release delete

Törli a megadott kiadást az API-ban.
az apim api release list

Egy API összes kiadását felsorolja.
az apim api release show

Egy API-kiadás részleteit adja vissza.
az apim api release update

Frissítések az API azonosító által meghatározott kiadásának részleteit.
az apim api revision

Az Azure API Management API változatának kezelése.
az apim api revision create

API-változat létrehozása.
az apim api revision list

Az API-k összes változatának felsorolása.
az apim api schema

Az Azure API Management API-sémák kezelése.
az apim api schema create

Hozzon létre egy API Management API-sémát.
az apim api schema delete

Töröljön egy API Management API-sémát.
az apim api schema get-etag

Egy API Management API-séma etagjének lekérése.
az apim api schema list

Listázd API Management API-sémákat.
az apim api schema show

Egy API Management API-séma részleteinek megjelenítése.
az apim api schema wait

Helyezze a parancssori felületet várakozó állapotba, amíg egy APIM API-séma valamelyik feltétele nem teljesül.
az apim api show

Egy API Management API részleteinek megjelenítése.
az apim api update

Frissítsen egy API Management API-t.
az apim api versionset

Az Azure API Management API verziókészletének kezelése.
az apim api versionset create

Létrehoz egy API-verziókészletet.
az apim api versionset delete

Törli az ADOTT API-verziókészletet.
az apim api versionset list

Az API-verziókészletek gyűjteményét sorolja fel a megadott szolgáltatáspéldányban.
az apim api versionset show

Lekéri az azonosító által megadott API-verziókészlet adatait.
az apim api versionset update

Frissítések az api VersionSet azonosító által megadott adatait.
az apim api wait

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

az apim api create

Szerkesztés

Hozzon létre egy API Management API-t.

az apim api create --api-id
                   --display-name
                   --path
                   --resource-group
                   --service-name
                   [--api-type {graphql, http, soap, websocket}]
                   [--authorization-scope]
                   [--authorization-server-id]
                   [--bearer-token-sending-methods]
                   [--description]
                   [--no-wait]
                   [--open-id-provider-id]
                   [--protocols {http, https, ws, wss}]
                   [--service-url]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-key-required]
                   [--subscription-required {false, true}]

Példák

Hozzon létre egy alapszintű API-t.

az apim api create --service-name MyApim -g MyResourceGroup --api-id MyApi --path '/myapi' --display-name 'My API'

Kötelező paraméterek

--api-id

A létrehozandó API egyedi neve.

--display-name

A létrehozandó API megjelenítendő neve.

--path

Az API elérési útja.

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

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

Opcionális paraméterek

--api-type

Az API típusa.

elfogadott értékek: graphql, http, soap, websocket
--authorization-scope

Az OAuth-műveletek hatókörét határozza meg.

--authorization-server-id

Megadja az OAuth engedélyezési kiszolgáló azonosítóját.

--bearer-token-sending-methods

Megadja a tulajdonosi jogkivonat küldési módszereit.

--description

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

--no-wait

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

--open-id-provider-id

Megadja az openid azonosítót a hitelesítési beállításban.

--protocols

Az API műveleteinek meghívható protokolljait ismerteti.

elfogadott értékek: http, https, ws, wss
--service-url

Az API-t implementáló háttérszolgáltatás abszolút URL-címe. Legfeljebb 2000 karakter hosszú lehet.

--subscription-key-header-name

Megadja az előfizetői azonosító fejlécének nevét.

--subscription-key-query-param-name

Megadja az előfizetési kulcs lekérdezési sztringjének paraméternevét.

--subscription-key-required

Megadja, hogy szükség van-e előfizetői azonosítóra az API hívása során, igaz – az API csak a zárt termékekben szerepel, hamis – az API-t csak a nyitott termékek tartalmazzák, null – a termékek vegyesen szerepelnek.

--subscription-required

Ha igaz, az API-nak szüksége van egy előfizetői azonosítóra a kérelmekhez.

elfogadott értékek: false, true

az apim api delete

Szerkesztés

Töröljön egy API Management API-t.

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

Kötelező paraméterek

--api-id

API-azonosító. Egyedinek kell lennie az aktuális API Management szolgáltatáspéldányban. A nem aktuális változat utótagja ;rev=n, ahol n a változat száma.

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

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

Opcionális paraméterek

--delete-revisions

Törölje az API összes változatát.

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

az apim api import

Szerkesztés

Importálja az API Management API-t.

az apim api import --path
                   --resource-group
                   --service-name
                   --specification-format {OpenApi, OpenApiJson, Swagger, Wadl, Wsdl}
                   [--api-id]
                   [--api-revision]
                   [--api-type {graphql, http, soap, websocket}]
                   [--api-version]
                   [--api-version-set-id]
                   [--description]
                   [--display-name]
                   [--no-wait]
                   [--protocols {http, https, ws, wss}]
                   [--service-url]
                   [--soap-api-type]
                   [--specification-path]
                   [--specification-url]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-required {false, true}]
                   [--wsdl-endpoint-name]
                   [--wsdl-service-name]

Példák

API Management API importálása fájlból vagy URL-címből

az apim api import -g MyResourceGroup --service-name MyApim --path MyApi --specification-url https://MySpecificationURL --specification-format OpenApiJson

Kötelező paraméterek

--path

Kötelező. Relatív URL-cím, amely egyedileg azonosítja ezt az API-t és annak összes erőforrásútvonalát a API Management szolgáltatáspéldányon belül.

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

--specification-format

Adja meg az importált API formátumát.

elfogadott értékek: OpenApi, OpenApiJson, Swagger, Wadl, Wsdl

Opcionális paraméterek

--api-id

API-azonosító. Egyedinek kell lennie az aktuális API Management szolgáltatáspéldányban. A nem aktuális változat utótagja ;rev=n, ahol n a változat száma.

--api-revision

Az API változatának ismertetése. Ha nincs megadva érték, a rendszer létrehozza az alapértelmezett 1. változatot.

--api-type

Az API típusa.

elfogadott értékek: graphql, http, soap, websocket
--api-version

Az API verzióját ismerteti. Ha nem verziószámozott API-hoz ad hozzá verziót, a rendszer automatikusan létrehoz egy eredeti verziót, és az alapértelmezett URL-címen válaszol.

--api-version-set-id

Az API-val használandó verziókészletet ismerteti.

--description

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

--display-name

Az API megjelenítendő neve.

--no-wait

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

--protocols

Ez a cikk azt ismerteti, hogy az API mely protokolljai (egy vagy több) hívhatók meg az API-ban.

elfogadott értékek: http, https, ws, wss
--service-url

Az API-t implementáló háttérszolgáltatás abszolút URL-címe. Legfeljebb 2000 karakter hosszú lehet.

--soap-api-type

Az API típusa, ha a fájlformátum WSDL.

--specification-path

Az API importálásához megadott fájlelérési út.

--specification-url

Az API importálásához megadott URL-cím.

--subscription-key-header-name

Megadja az előfizetői azonosító fejlécének nevét.

--subscription-key-query-param-name

Megadja az előfizetési kulcs lekérdezési sztringjének paraméternevét.

--subscription-required

Ha igaz, az API-nak szüksége van egy előfizetői azonosítóra a kérelmekhez.

elfogadott értékek: false, true
--wsdl-endpoint-name

Az importálandó WSDL-végpont (port) helyi neve.

--wsdl-service-name

Az importálandó WSDL-szolgáltatás helyi neve.

az apim api list

Szerkesztés

Listázd API Management API-ját.

az apim api list --resource-group
                 --service-name
                 [--filter-display-name]
                 [--skip]
                 [--top]

Kötelező paraméterek

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

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

Opcionális paraméterek

--filter-display-name

API-k szűrése a displayName alapján.

--skip

Kihagyandó rekordok száma.

--top

A visszaadandó rekordok száma.

az apim api show

Szerkesztés

Egy API Management API részleteinek megjelenítése.

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

Kötelező paraméterek

--api-id

API-azonosító. Egyedinek kell lennie az aktuális API Management szolgáltatáspéldányban. A nem aktuális változat utótagja ;rev=n, ahol n a változat száma.

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

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

az apim api update

Szerkesztés

Frissítsen egy API Management API-t.

az apim api update --api-id
                   --resource-group
                   --service-name
                   [--add]
                   [--api-type {graphql, http, soap, websocket}]
                   [--description]
                   [--display-name]
                   [--force-string]
                   [--if-match]
                   [--no-wait]
                   [--path]
                   [--protocols {http, https, ws, wss}]
                   [--remove]
                   [--service-url]
                   [--set]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-required {false, true}]
                   [--tags]

Példák

Hozzon létre egy alapszintű API-t.

az apim api update --service-name MyApim -g MyResourceGroup --api-id MyApi --description foo

Kötelező paraméterek

--api-id

A létrehozandó API egyedi neve.

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

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

--api-type

Az API típusa.

elfogadott értékek: graphql, http, soap, websocket
--description

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

--display-name

API-név. 1–300 karakter hosszúságúnak kell lennie.

--force-string

A "set" vagy az "add" használatakor őrizze meg a sztringkonstansokat ahelyett, hogy JSON-ra próbálnál konvertálni.

--if-match

Az entitás ETagje. Az entitások létrehozásakor nem kötelező, de az entitások frissítésekor kötelező.

--no-wait

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

--path

Kötelező. Relatív URL-cím, amely egyedileg azonosítja ezt az API-t és annak összes erőforrásútvonalát a API Management szolgáltatáspéldányon belül.

--protocols

Az API műveleteinek meghívható protokolljait ismerteti.

elfogadott értékek: http, https, ws, wss
--remove

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

--service-url

Az API-t implementáló háttérszolgáltatás abszolút URL-címe. Legfeljebb 2000 karakter hosszú lehet.

--set

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

--subscription-key-header-name

Megadja az előfizetői azonosító fejlécének nevét.

--subscription-key-query-param-name

Megadja az előfizetési kulcs lekérdezési sztringjének paraméternevét.

--subscription-required

Ha igaz, az API-nak szüksége van egy előfizetői azonosítóra a kérelmekhez.

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

Szóközzel tagolt címkék: kulcs[=érték] [kulcs[=érték] ...]. A "" használatával törölheti a meglévő címkéket.

az apim api wait

Szerkesztés

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

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

Példák

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

az apim api wait --created --api-id MyApi --name MyApim --resource-group MyResourceGroup

Kötelező paraméterek

--api-id

API változatazonosítója. Egyedinek kell lennie az aktuális API Management szolgáltatáspéldányban. A nem aktuális változat utótagja ;rev=n, ahol n a változat száma.

--name -n

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

--resource-group -g

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

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.