az apim api
Az Azure API Management API-k kezelése.
Parancsok
Name | Description | Típus | Állapot |
---|---|---|---|
az apim api create |
Hozzon létre egy API Management API-t. |
Alapvető | FE |
az apim api delete |
API Management API törlése. |
Alapvető | FE |
az apim api export |
API Management API exportálása. |
Alapvető | FE |
az apim api import |
API Management API importálása. |
Alapvető | FE |
az apim api list |
Az API Management API-k listázása. |
Alapvető | FE |
az apim api operation |
Az Azure API Management API-műveletek kezelése. |
Alapvető | FE |
az apim api operation create |
Új műveletet hoz létre az API-ban. |
Alapvető | FE |
az apim api operation delete |
Törli a megadott műveletet az API-ban. |
Alapvető | FE |
az apim api operation list |
Adja meg a megadott API műveleteinek gyűjteményét. |
Alapvető | FE |
az apim api operation show |
Lekéri az azonosító által megadott API-művelet részleteit. |
Alapvető | FE |
az apim api operation update |
Frissítések a művelet részleteit az API-ban, amelyet az azonosítója határoz meg. |
Alapvető | FE |
az apim api release |
Az Azure API Management API kiadásának kezelése. |
Alapvető | FE |
az apim api release create |
Létrehoz egy új kiadást az API-hoz. |
Alapvető | FE |
az apim api release delete |
Törli a megadott kiadást az API-ban. |
Alapvető | FE |
az apim api release list |
Az API összes kiadásának listája. |
Alapvető | FE |
az apim api release show |
Egy API-kiadás részleteit adja vissza. |
Alapvető | FE |
az apim api release update |
Frissítések az API azonosító által meghatározott kiadásának részleteit. |
Alapvető | FE |
az apim api revision |
Az Azure API Management API változatának kezelése. |
Alapvető | FE |
az apim api revision create |
API-változat létrehozása. |
Alapvető | FE |
az apim api revision list |
Egy API összes változatának listája. |
Alapvető | FE |
az apim api schema |
Az Azure API Management API-sémák kezelése. |
Alapvető | FE |
az apim api schema create |
Hozzon létre egy API Management API-sémát. |
Alapvető | FE |
az apim api schema delete |
API Management API-séma törlése. |
Alapvető | FE |
az apim api schema get-etag |
Api Management API-séma etagjének lekérése. |
Alapvető | FE |
az apim api schema list |
Az API Management API-sémák listázása. |
Alapvető | FE |
az apim api schema show |
Az API Management API-séma részleteinek megjelenítése. |
Alapvető | FE |
az apim api schema wait |
Helyezze a parancssori felületet várakozási állapotba, amíg egy apim API-séma valamely feltétele teljesül. |
Alapvető | FE |
az apim api show |
Az API Management API részleteinek megjelenítése. |
Alapvető | FE |
az apim api update |
Api Management API frissítése. |
Alapvető | FE |
az apim api versionset |
Az Azure API Management API verziókészletének kezelése. |
Alapvető | FE |
az apim api versionset create |
Létrehoz egy API-verziókészletet. |
Alapvető | FE |
az apim api versionset delete |
Törli a megadott API-verziókészletet. |
Alapvető | FE |
az apim api versionset list |
Az API-verziókészletek gyűjteményét sorolja fel a megadott szolgáltatáspéldányban. |
Alapvető | FE |
az apim api versionset show |
Lekéri az api-verziókészlet azonosítója által megadott adatait. |
Alapvető | FE |
az apim api versionset update |
Frissítések az Api VersionSet azonosító által megadott adatait. |
Alapvető | FE |
az apim api wait |
Helyezze a parancssori felületet várakozási állapotba, amíg az apim api egy feltételének nem teljesül. |
Alapvető | FE |
az apim api create
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
A létrehozandó api egyedi neve.
API-változat azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat rendelkezik ; rev=n utótagként, ahol n a változat száma.
A létrehozandó API megjelenítendő neve.
Az API elérési útja.
Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>
: .
Az API Management szolgáltatáspéldány neve.
Opcionális paraméterek
Az API típusa.
Megadja az OAuth-műveletek hatókörét.
Megadja az OAuth engedélyezési kiszolgáló azonosítóját.
Megadja a tulajdonosi jogkivonat küldési módszereit.
Az API leírása. HTML-formázási címkéket is tartalmazhat.
Ne várja meg, amíg a hosszú ideig futó művelet befejeződik.
Megadja az openid azonosítót a hitelesítési beállításban.
Ez a cikk ismerteti, hogy az API műveletei mely protokollokon hívhatók meg.
Az API-t implementáló háttérszolgáltatás abszolút URL-címe. Legfeljebb 2000 karakter hosszú lehet.
Megadja az előfizetéskulcs fejlécének nevét.
Az előfizetési kulcs lekérdezési sztring paraméterének nevét adja meg.
Megadja, hogy szükség van-e előfizetési kulcsra az API hívása során, igaz – az API csak zárt termékekbe van belefoglalva, hamis – az API csak a nyitott termékekbe van belefoglalva, null – a termékek vegyesen léteznek.
Ha igaz, az API-nak szüksége van egy előfizetési kulcsra a kérelmekhez.
Globális paraméterek
Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.
Jelenítse meg ezt a súgóüzenetet, és lépjen ki.
Csak a hibák megjelenítése, a figyelmeztetések mellőzése.
Kimeneti formátum.
JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .
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
: .
A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.
az apim api delete
API Management API törlése.
az apim api delete --api-id
--resource-group
--service-name
[--delete-revisions]
[--if-match]
[--no-wait]
[--yes]
Kötelező paraméterek
API-azonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat rendelkezik ; rev=n utótagként, ahol n a változat száma.
Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>
: .
Az API Management szolgáltatáspéldány neve.
Opcionális paraméterek
Törölje az Api összes változatát.
Az entitás ETagje.
Ne várja meg, amíg a hosszú ideig futó művelet befejeződik.
Ne kérje a megerősítést.
Globális paraméterek
Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.
Jelenítse meg ezt a súgóüzenetet, és lépjen ki.
Csak a hibák megjelenítése, a figyelmeztetések mellőzése.
Kimeneti formátum.
JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .
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
: .
A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.
az apim api export
API Management API exportálása.
az apim api export --api-id
--ef {OpenApiJsonFile, OpenApiJsonUrl, OpenApiYamlFile, OpenApiYamlUrl, SwaggerFile, SwaggerUrl, WadlFile, WadlUrl, WsdlFile, WsdlUrl}
--resource-group
--service-name
[--file-path]
Példák
Api Management API exportálása fájlba, vagy az exportálás hivatkozását tartalmazó választ ad vissza.
az apim api export -g MyResourceGroup --service-name MyApim --api-id MyApi --export-format OpenApiJson --file-path path
Kötelező paraméterek
API-azonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat rendelkezik ; rev=n utótagként, ahol n a változat száma. Regex minta: ^[^*#&+:<>?] +$.
Adja meg az exportálási API formátumát.
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
Az api management szolgáltatáspéldány neve.
Opcionális paraméterek
Az API exportálásához megadott fájl elérési útja.
Globális paraméterek
Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.
Jelenítse meg ezt a súgóüzenetet, és lépjen ki.
Csak a hibák megjelenítése, a figyelmeztetések mellőzése.
Kimeneti formátum.
JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .
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
: .
A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.
az apim api import
API Management API importálása.
az apim api import --path
--resource-group
--service-name
--specification-format {GraphQL, 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
Szükséges. Relatív URL-cím, amely egyedileg azonosítja ezt az API-t és annak összes erőforrásútvonalát az API Management szolgáltatáspéldányon belül.
Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>
: .
Az api management szolgáltatáspéldány neve.
Adja meg az importált API formátumát.
Opcionális paraméterek
API-azonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat rendelkezik ; rev=n utótagként, ahol n a változat száma.
Az Api felülvizsgálatát ismerteti. Ha nincs megadva érték, a rendszer létrehozza az 1. alapértelmezett változatot.
Az API típusa.
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.
Az API-val használandó verziókészletet ismerteti.
Az API leírása. HTML-formázási címkéket is tartalmazhat.
Az API megjelenítendő neve.
Ne várja meg, amíg a hosszú ideig futó művelet befejeződik.
Azt ismerteti, hogy az API-ban található műveletek mely protokollokra hívhatók meg (egy vagy több).
Az API-t implementáló háttérszolgáltatás abszolút URL-címe. Legfeljebb 2000 karakter hosszú lehet.
Az API típusa, ha a fájlformátum WSDL.
Az API importálásához megadott fájl elérési útja.
Az API importálásához megadott URL-cím.
Megadja az előfizetéskulcs fejlécének nevét.
Az előfizetési kulcs lekérdezési sztring paraméterének nevét adja meg.
Ha igaz, az API-nak szüksége van egy előfizetési kulcsra a kérelmekhez.
Az importálandó WSDL-végpont (port) helyi neve.
Az importálandó WSDL-szolgáltatás helyi neve.
Globális paraméterek
Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.
Jelenítse meg ezt a súgóüzenetet, és lépjen ki.
Csak a hibák megjelenítése, a figyelmeztetések mellőzése.
Kimeneti formátum.
JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .
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
: .
A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.
az apim api list
Az API Management API-k listázása.
az apim api list --resource-group
--service-name
[--filter-display-name]
[--skip]
[--top]
Kötelező paraméterek
Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>
: .
Az API Management szolgáltatáspéldány neve.
Opcionális paraméterek
API-k szűrése a displayName alapján.
Kihagyandó rekordok száma.
A visszaadni kívánt rekordok száma.
Globális paraméterek
Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.
Jelenítse meg ezt a súgóüzenetet, és lépjen ki.
Csak a hibák megjelenítése, a figyelmeztetések mellőzése.
Kimeneti formátum.
JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .
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
: .
A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.
az apim api show
Az API Management API részleteinek megjelenítése.
az apim api show --api-id
--resource-group
--service-name
Kötelező paraméterek
API-azonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat rendelkezik ; rev=n utótagként, ahol n a változat száma.
Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>
: .
Az API Management szolgáltatáspéldány neve.
Globális paraméterek
Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.
Jelenítse meg ezt a súgóüzenetet, és lépjen ki.
Csak a hibák megjelenítése, a figyelmeztetések mellőzése.
Kimeneti formátum.
JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .
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
: .
A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.
az apim api update
Api Management API frissítése.
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
A létrehozandó api egyedi neve.
API-változat azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat rendelkezik ; rev=n utótagként, ahol n a változat száma.
Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>
: .
Az API Management szolgáltatáspéldány neve.
Opcionális paraméterek
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>
Az API típusa.
Az API leírása. HTML-formázási címkéket is tartalmazhat.
API-név. 1–300 karakter hosszúságúnak kell lennie.
A "set" vagy a "add" használata esetén a JSON-ra való konvertálás helyett őrizze meg a sztringkonstansokat.
Az entitás ETagje. Entitás létrehozásakor nem kötelező, de egy entitás frissítésekor kötelező. Az alapértelmezett érték Nincs.
Ne várja meg, amíg a hosszú ideig futó művelet befejeződik.
Szükséges. Relatív URL-cím, amely egyedileg azonosítja ezt az API-t és annak összes erőforrásútvonalát az API Management szolgáltatáspéldányon belül.
Ez a cikk ismerteti, hogy az API műveletei mely protokollokon hívhatók meg.
Tulajdonság vagy elem eltávolítása a listából. Példa: --remove property.list <indexToRemove>
VAGY --remove propertyToRemove
.
Az API-t implementáló háttérszolgáltatás abszolút URL-címe. Legfeljebb 2000 karakter hosszú lehet.
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>
Megadja az előfizetéskulcs fejlécének nevét.
Az előfizetési kulcs lekérdezési sztring paraméterének nevét adja meg.
Ha igaz, az API-nak szüksége van egy előfizetési kulcsra a kérelmekhez.
Szóközzel elválasztott címkék: key[=value] [key[=value] ...]. Meglévő címkék törlése a "" használatával.
Globális paraméterek
Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.
Jelenítse meg ezt a súgóüzenetet, és lépjen ki.
Csak a hibák megjelenítése, a figyelmeztetések mellőzése.
Kimeneti formátum.
JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .
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
: .
A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.
az apim api wait
Helyezze a parancssori felületet várakozási állapotba, amíg az apim api egy feltételének 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ási állapotba, amíg az apim api egy feltételének nem teljesül. (automatikusan létrehozott)
az apim api wait --created --api-id MyApi --name MyApim --resource-group MyResourceGroup
Kötelező paraméterek
API-változat azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat rendelkezik ; rev=n utótagként, ahol n a változat száma. Szükséges.
Az api management szolgáltatáspéldány neve.
Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>
: .
Opcionális paraméterek
Várjon, amíg létre nem jön a "provisioningState" a "Sikeres" helyen.
Várjon, amíg a feltétel megfelel egy egyéni JMESPath-lekérdezésnek. Pl. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running"?.
Várjon a törlésig.
Várjon, amíg az erőforrás létezik.
Lekérdezési időköz másodpercben.
Maximális várakozás másodpercben.
Várjon, amíg frissül a provisioningState a következő helyen: "Sikeres".
Globális paraméterek
Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.
Jelenítse meg ezt a súgóüzenetet, és lépjen ki.
Csak a hibák megjelenítése, a figyelmeztetések mellőzése.
Kimeneti formátum.
JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .
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
: .
A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.