Visszajelzés

az apim

  • Referencia

Azure API Management-szolgáltatások kezelése.

Parancsok

az apim api

Az Azure API Management API-k kezelése.
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 apply-network-updates

Frissítse a virtuális hálózaton futó API Management erőforrást a frissített hálózati beállítások kiválasztásához.
az apim backup

Biztonsági másolatot készít a API Management szolgáltatásról az adott Azure Storage-fiókba. Ez a művelet hosszú ideig fut, és eltarthat néhány percig.
az apim check-name

Ellenőrzi, hogy elérhető-e a szolgáltatásnév.
az apim create

Hozzon létre egy API Management szolgáltatáspéldányt.
az apim delete

Töröl egy API Management szolgáltatást.
az apim deletedservice

Helyreállítható módon törölt Azure API Management-szolgáltatások kezelése.
az apim deletedservice list

Listázhatja az összes helyreállíthatóan törölt Api Management-szolgáltatáspéldányt, amely az adott előfizetéshez nem érhető el.
az apim deletedservice purge

Helyreállíthatóan törölt Api Management-szolgáltatáspéldány végleges törlése (törlés nélkül).
az apim deletedservice show

A helyreállíthatóan törölt Api Management-szolgáltatáspéldányok lekérése név alapján történő törlés visszavonása céljából.
az apim list

API Management szolgáltatáspéldányok listázása.
az apim nv

Azure API Management nevesített értékek kezelése.
az apim nv create

Hozzon létre egy API Management névvel ellátott értéket.
az apim nv delete

API Management névvel ellátott érték törlése.
az apim nv list

Névvel ellátott értékek listázása API Management.
az apim nv show

API Management elnevezett érték részleteinek megjelenítése.
az apim nv show-secret

Lekéri egy API Management nevesített érték titkos kódját.
az apim nv update

API Management névvel ellátott érték frissítése.
az apim nv wait

Helyezze a parancssori felületet várakozási állapotba, amíg egy apim nevű érték feltételének nem felel meg.
az apim product

Az Azure API Management Product's kezelése.
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

Meglévő termékadatok frissítése.
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 restore

Visszaállítja az aktuális szolgáltatás ApiManagementService_Backup műveletével létrehozott API Management szolgáltatás biztonsági másolatát. Ez egy hosszú ideig futó művelet, és eltarthat néhány percig.
az apim show

Egy API Management-szolgáltatáspéldány részleteinek megjelenítése.
az apim update

Frissítsen egy API Management-szolgáltatáspéldányt.
az apim wait

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

az apim apply-network-updates

Szerkesztés

Frissítse a virtuális hálózaton futó API Management erőforrást a frissített hálózati beállítások kiválasztásához.

az apim apply-network-updates --name
                              --resource-group
                              [--location]
                              [--no-wait]

Példák

A API Management szolgáltatáspéldány virtuális hálózati beállításainak frissítése

az apim apply-network-updates --name MyApim -g MyResourceGroup

Kötelező paraméterek

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

--location -l

Tartózkodási hely beállításnál. Értékek innen: az account list-locations. Az alapértelmezett helyet a használatával az configure --defaults location=<location>konfigurálhatja.

--no-wait

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

az apim backup

Szerkesztés

Biztonsági másolatot készít a API Management szolgáltatásról az adott Azure Storage-fiókba. Ez a művelet hosszú ideig fut, és eltarthat néhány percig.

az apim backup --backup-name
               --container-name
               --name
               --resource-group
               --storage-account-key
               --storage-account-name
               [--no-wait]

Példák

A API Management szolgáltatáspéldány biztonsági másolatának létrehozása

az apim backup --name MyApim -g MyResourceGroup --backup-name myBackup              --storage-account-name mystorageaccount --storage-account-container backups              --storage-account-key Ay2ZbdxLnD4OJPT29F6jLPkB6KynOzx85YCObhrw==

Kötelező paraméterek

--backup-name

A létrehozandó biztonsági mentési fájl neve.

--container-name --storage-account-container

A biztonsági mentés elhelyezéséhez használt tárfióktároló neve.

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

--storage-account-key

A biztonsági mentés elhelyezéséhez használt tárfiók hozzáférési kulcsa.

--storage-account-name

A biztonsági mentés elhelyezéséhez használt tárfiók neve.

Opcionális paraméterek

--no-wait

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

az apim check-name

Szerkesztés

Ellenőrzi, hogy elérhető-e a szolgáltatásnév.

az apim check-name --name

Kötelező paraméterek

--name -n

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

az apim create

Szerkesztés

Hozzon létre egy API Management szolgáltatáspéldányt.

az apim create --name
               --publisher-email
               --publisher-name
               --resource-group
               [--enable-client-certificate {false, true}]
               [--enable-managed-identity {false, true}]
               [--location]
               [--no-wait]
               [--sku-capacity]
               [--sku-name {Basic, Consumption, Developer, Isolated, Premium, Standard}]
               [--tags]
               [--virtual-network {External, Internal, None}]

Példák

Hozzon létre egy fejlesztői szintű API Management szolgáltatást.

az apim create --name MyApim -g MyResourceGroup -l eastus --publisher-email email@mydomain.com --publisher-name Microsoft

Hozzon létre egy használatalapú réteget API Management szolgáltatást.

az apim create --name MyApim -g MyResourceGroup -l eastus --sku-name Consumption --enable-client-certificate \
    --publisher-email email@mydomain.com --publisher-name Microsoft

Kötelező paraméterek

--name -n

A létrehozandó szolgáltatáspéldány egyedi neve.

--publisher-email

Az összes rendszerértesítés fogadásához szükséges e-mail-cím.

--publisher-name

A fejlesztői portálon használható szervezet neve és e-mail értesítések.

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

--enable-client-certificate

Kikényszeríti, hogy az ügyféltanúsítványt minden egyes, az átjárónak küldött kérésnél meg kell jeleníteni, és lehetővé teszi a tanúsítvány hitelesítését az átjáró házirendjében.

elfogadott értékek: false, true
--enable-managed-identity

Hozzon létre egy felügyelt identitást a API Management szolgáltatás számára más Azure-erőforrások eléréséhez.

elfogadott értékek: false, true
--location -l

Tartózkodási hely beállításnál. Értékek innen: az account list-locations. Az alapértelmezett helyet a használatával az configure --defaults location=<location>konfigurálhatja.

--no-wait

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

--sku-capacity

A termékváltozat üzembe helyezett egységeinek száma.

alapértelmezett érték: 1
--sku-name

Az API Management-példány termékváltozata.

elfogadott értékek: Basic, Consumption, Developer, Isolated, Premium, Standard
alapértelmezett érték: Developer
--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.

--virtual-network -v

A virtuális hálózat típusa.

elfogadott értékek: External, Internal, None
alapértelmezett érték: None

az apim delete

Szerkesztés

Töröl egy API Management szolgáltatást.

az apim delete --name
               --resource-group
               [--no-wait]
               [--yes]

Példák

Töröljön egy API Management szolgáltatást.

az apim delete -n MyApim -g MyResourceGroup

Kötelező paraméterek

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

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

Szerkesztés

API Management szolgáltatáspéldányok listázása.

az apim list [--resource-group]

Opcionális 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.

az apim restore

Szerkesztés

Visszaállítja az aktuális szolgáltatás ApiManagementService_Backup műveletével létrehozott API Management szolgáltatás biztonsági másolatát. Ez egy hosszú ideig futó művelet, és eltarthat néhány percig.

az apim restore --backup-name
                --container-name
                --name
                --resource-group
                --storage-account-key
                --storage-account-name
                [--no-wait]

Példák

Visszaállítja a API Management szolgáltatáspéldány biztonsági másolatát

az apim restore --name MyApim -g MyResourceGroup --backup-name myBackup              --storage-account-name mystorageaccount --storage-account-container backups              --storage-account-key Ay2ZbdxLnD4OJPT29F6jLPkB6KynOzx85YCObhrw==

Kötelező paraméterek

--backup-name

A visszaállítani kívánt biztonsági mentési fájl neve.

--container-name --storage-account-container

Annak a tárfióknak a neve, amelyből a biztonsági másolat lekérhető.

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

--storage-account-key

A biztonsági másolat lekéréséhez használt tárfiók hozzáférési kulcsa.

--storage-account-name

A biztonsági másolat lekéréséhez használt tárfiók neve.

Opcionális paraméterek

--no-wait

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

az apim show

Szerkesztés

Egy API Management-szolgáltatáspéldány részleteinek megjelenítése.

az apim show --name
             --resource-group

Kötelező paraméterek

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

az apim update

Szerkesztés

Frissítsen egy API Management-szolgáltatáspéldányt.

az apim update --name
               --resource-group
               [--add]
               [--enable-client-certificate {false, true}]
               [--enable-managed-identity {false, true}]
               [--force-string]
               [--no-wait]
               [--publisher-email]
               [--publisher-name]
               [--remove]
               [--set]
               [--sku-capacity]
               [--sku-name {Basic, Consumption, Developer, Isolated, Premium, Standard}]
               [--tags]
               [--virtual-network {External, Internal, None}]

Kötelező paraméterek

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

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

--enable-client-certificate

Kikényszeríti, hogy az ügyféltanúsítványt minden egyes, az átjárónak küldött kérésnél meg kell jeleníteni, és lehetővé teszi a tanúsítvány hitelesítését az átjáró házirendjében.

elfogadott értékek: false, true
--enable-managed-identity

Hozzon létre egy felügyelt identitást a API Management szolgáltatás számára más Azure-erőforrások eléréséhez.

elfogadott értékek: false, true
--force-string

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

--no-wait

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

--publisher-email

Az összes rendszerértesítés fogadásához szükséges e-mail-cím.

--publisher-name

A fejlesztői portálon használható szervezet neve és e-mail értesítések.

--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 a beállítandó tulajdonság elérési útjának és értékének megadásával. Példa: --set property1.property2=.

--sku-capacity

A termékváltozat üzembe helyezett egységeinek száma.

--sku-name

Az API Management-példány termékváltozata.

elfogadott értékek: Basic, Consumption, Developer, Isolated, Premium, Standard
--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.

--virtual-network -v

A virtuális hálózat típusa.

elfogadott értékek: External, Internal, None

az apim wait

Szerkesztés

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

az apim wait --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-feltétel nem teljesül. (automatikusan létrehozott)

az apim wait --created --name MyApim --resource-group MyResourceGroup

Kötelező paraméterek

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