az apim
Azure API Management szolgáltatások kezelése.
Parancsok
| Name | Description | Típus | Állapot |
|---|---|---|---|
| az apim api |
Azure API Management API-k kezelése. |
Core | GA |
| az apim api create |
Hozzon létre egy API Management API-t. |
Core | GA |
| az apim api delete |
API Management API törlése. |
Core | GA |
| az apim api export |
API Management API exportálása. |
Core | GA |
| az apim api import |
API Management API importálása. |
Core | GA |
| az apim api list |
Az API Management API-k listázása. |
Core | GA |
| az apim api operation |
Azure API Management API-műveletek kezelése. |
Core | GA |
| az apim api operation create |
Új műveletet hoz létre az API-ban. |
Core | GA |
| az apim api operation delete |
Törli a megadott műveletet az API-ban. |
Core | GA |
| az apim api operation list |
Adja meg a megadott API műveleteinek gyűjteményét. |
Core | GA |
| az apim api operation show |
Lekéri az azonosító által megadott API-művelet részleteit. |
Core | GA |
| az apim api operation update |
Frissíti a művelet részleteit az api-ban, amelyet az azonosítója határoz meg. |
Core | GA |
| az apim api release |
Azure API Management API-kiadás kezelése. |
Core | GA |
| az apim api release create |
Létrehoz egy új kiadást az API-hoz. |
Core | GA |
| az apim api release delete |
Törli a megadott kiadást az API-ban. |
Core | GA |
| az apim api release list |
Az API összes kiadásának listája. |
Core | GA |
| az apim api release show |
Egy API-kiadás részleteit adja vissza. |
Core | GA |
| az apim api release update |
Frissíti az azonosító által megadott API kiadásának részleteit. |
Core | GA |
| az apim api revision |
Azure API Management API-változat kezelése. |
Core | GA |
| az apim api revision create |
API-változat létrehozása. |
Core | GA |
| az apim api revision list |
Egy API összes változatának listája. |
Core | GA |
| az apim api schema |
Azure API Management API-séma kezelése. |
Core | GA |
| az apim api schema create |
Hozzon létre egy API Management API-sémát. |
Core | GA |
| az apim api schema delete |
API Management API-séma törlése. |
Core | GA |
| az apim api schema get-etag |
Api Management API-séma etagjének lekérése. |
Core | GA |
| az apim api schema list |
Az API Management API-sémák listázása. |
Core | GA |
| az apim api schema show |
Az API Management API-séma részleteinek megjelenítése. |
Core | GA |
| 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. |
Core | GA |
| az apim api show |
Az API Management API részleteinek megjelenítése. |
Core | GA |
| az apim api update |
Api Management API frissítése. |
Core | GA |
| az apim api versionset |
Azure API Management API-verziókészlet kezelése. |
Core | GA |
| az apim api versionset create |
Létrehoz egy API-verziókészletet. |
Core | GA |
| az apim api versionset delete |
Törli a megadott API-verziókészletet. |
Core | GA |
| az apim api versionset list |
Az API-verziókészletek gyűjteményét sorolja fel a megadott szolgáltatáspéldányban. |
Core | GA |
| az apim api versionset show |
Lekéri az api-verziókészlet azonosítója által megadott adatait. |
Core | GA |
| az apim api versionset update |
Frissíti az Api VersionSet azonosító által megadott adatait. |
Core | GA |
| 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. |
Core | GA |
| 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. |
Core | GA |
| az apim backend |
Azure API Management háttérrendszerek kezelése. |
Core | GA |
| az apim backend create |
API Management-háttérrendszer létrehozása vagy frissítése. |
Core | GA |
| az apim backend delete |
API Management-háttérrendszer törlése. |
Core | GA |
| az apim backend list |
API Management-háttérrendszerek listázása. |
Core | GA |
| az apim backend show |
Az API Management háttérrendszer részleteinek megjelenítése. |
Core | GA |
| az apim backend update |
Api Management-háttérrendszer frissítése. |
Core | GA |
| az apim backup |
Létrehoz egy biztonsági másolatot az API Management szolgáltatásról az adott Azure Storage-fiókba. Ez hosszú ideig futó művelet, és több percig is eltarthat. |
Core | GA |
| az apim check-name |
Ellenőrzi, hogy elérhető-e a szolgáltatásnév. |
Core | GA |
| az apim create |
Hozzon létre egy API Management szolgáltatáspéldányt. |
Core | GA |
| az apim delete |
Egy API Management-szolgáltatás törlése. |
Core | GA |
| az apim deletedservice |
Helyreállíthatóan törölt Azure API Management szolgáltatások kezelése. |
Core | GA |
| az apim deletedservice list |
Felsorolja 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. |
Core | GA |
| az apim deletedservice purge |
Törölje a helyreállíthatóan törölt Api Management szolgáltatáspéldányt (a törlési lehetőség nélkül törli). |
Core | GA |
| az apim deletedservice show |
A helyreállíthatóan törölt Api Management-szolgáltatáspéldányokat név szerint lekérheti a törléshez. |
Core | GA |
| az apim graphql |
Azure API Management GraphQL API-k kezelése. |
Core | GA |
| az apim graphql resolver |
Azure API Management GraphQL API feloldóinak kezelése. |
Core | GA |
| az apim graphql resolver create |
Hozzon létre egy új feloldót a GraphQL API-ban, vagy frissítsen egy meglévőt. |
Core | GA |
| az apim graphql resolver delete |
Törölje a megadott feloldót a GraphQL API-ban. |
Core | GA |
| az apim graphql resolver list |
Listázhatja a megadott GraphQL API feloldóinak gyűjteményét. |
Core | GA |
| az apim graphql resolver policy |
A GraphQL API feloldószabályzatainak kezelése Azure API Management. |
Core | GA |
| az apim graphql resolver policy create |
Szabályzatkonfiguráció létrehozása vagy frissítése a GraphQL API Resolver szintjéhez. |
Core | GA |
| az apim graphql resolver policy delete |
Törölje a szabályzatkonfigurációt a GraphQL Api Resolverben. |
Core | GA |
| az apim graphql resolver policy list |
Kérje le a szabályzatkonfigurációk listáját a GraphQL API Resolver szintjén. |
Core | GA |
| az apim graphql resolver policy show |
Kérje le a szabályzatkonfigurációt a GraphQL API Resolver szintjén. |
Core | GA |
| az apim graphql resolver show |
Az azonosító által megadott GraphQL API Resolver részleteinek lekérése. |
Core | GA |
| az apim list |
API Management-szolgáltatáspéldányok listázása. |
Core | GA |
| az apim nv |
Azure API Management elnevezett értékek kezelése. |
Core | GA |
| az apim nv create |
Hozzon létre egy API Management Named Value értéket. |
Core | GA |
| az apim nv delete |
Törölje a névvel ellátott API Management-értéket. |
Core | GA |
| az apim nv list |
Az API Management névvel ellátott értékeinek listázása. |
Core | GA |
| az apim nv show |
Az API Management named Value részleteinek megjelenítése. |
Core | GA |
| az apim nv show-secret |
Lekéri az API Management named Value titkos kódját. |
Core | GA |
| az apim nv update |
Api Management named Value frissítése. |
Core | GA |
| az apim nv wait |
Helyezze a parancssori felületet várakozási állapotba, amíg egy apim által elnevezett érték feltételének nem teljesül. |
Core | GA |
| az apim product |
Azure API Management Termék kezelése. |
Core | GA |
| az apim product api |
Azure API Management termék API-inak kezelése. |
Core | GA |
| az apim product api add |
Adjon hozzá egy API-t a megadott termékhez. |
Core | GA |
| 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. |
Core | GA |
| az apim product api delete |
Törli a megadott API-t a megadott termékből. |
Core | GA |
| az apim product api list |
A termékhez társított API-k gyűjteményét sorolja fel. |
Core | GA |
| az apim product create |
Létrehoz egy terméket. |
Core | GA |
| az apim product delete |
Termék törlése. |
Core | GA |
| az apim product list |
A megadott szolgáltatáspéldányban található termékek gyűjteményét sorolja fel. |
Core | GA |
| az apim product show |
Lekéri az azonosító által megadott termék részleteit. |
Core | GA |
| az apim product update |
Frissítse a meglévő termékadatokat. |
Core | GA |
| az apim product wait |
Helyezze a parancssori felületet várakozási állapotba, amíg egy apim-termék valamely feltétele teljesül. |
Core | GA |
| 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 több percig is eltarthat. |
Core | GA |
| az apim show |
Az API Management szolgáltatáspéldány részleteinek megjelenítése. |
Core | GA |
| az apim update |
API Management szolgáltatáspéldány frissítése. |
Core | GA |
| az apim wait |
Helyezze a parancssori felületet várakozási állapotba, amíg az apim egy feltételének nem teljesül. |
Core | GA |
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 apply-network-updates --name
--resource-group
[--acquire-policy-token]
[--change-reference]
[--location]
[--no-wait]
Példák
Az 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
Az api management szolgáltatáspéldány neve.
Az erőforráscsoport neve. Az alapértelmezett csoportot a az configure --defaults group=<name>használatával konfigurálhatja.
Opcionális paraméterek
Az alábbi paraméterek megadása nem kötelező, de a környezettől függően előfordulhat, hogy a parancs sikeres végrehajtásához egy vagy több is szükséges lehet.
Az erőforrásművelethez automatikusan beszerez egy Azure Policy-jogkivonatot.
| Tulajdonság | Érték |
|---|---|
| Paramétercsoport: | Global Policy Arguments |
Az erőforrásművelet kapcsolódó változáshivatkozás-azonosítója.
| Tulajdonság | Érték |
|---|---|
| Paramétercsoport: | Global Policy Arguments |
Location. Értékek: az account list-locations. Az alapértelmezett helyet a következővel az configure --defaults location=<location>konfigurálhatja: .
Ne várja meg, amíg a hosszú ideig futó művelet befejeződik.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |
Globális paraméterek
Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |
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.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |
Kimeneti formátum.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | json |
| Elfogadott értékek: | json, jsonc, none, table, tsv, yaml, yamlc |
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 a az account set -s NAME_OR_IDhasználatával konfigurálhatja.
A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |
az apim backup
Létrehoz egy biztonsági másolatot az API Management szolgáltatásról az adott Azure Storage-fiókba. Ez hosszú ideig futó művelet, és több percig is eltarthat.
az apim backup --backup-name
--container-name --storage-account-container
--name
--resource-group
--storage-account-key
--storage-account-name
[--acquire-policy-token]
[--change-reference]
[--no-wait]
Példák
Az 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
A létrehozni kívánt biztonsági mentési fájl neve.
A biztonsági mentés elhelyezéséhez használt tárfiók tárolójának neve.
Az api management szolgáltatáspéldány neve.
Az erőforráscsoport neve. Az alapértelmezett csoportot a az configure --defaults group=<name>használatával konfigurálhatja.
A biztonsági mentés elhelyezéséhez használt tárfiók hozzáférési kulcsa.
| Tulajdonság | Érték |
|---|---|
| Paramétercsoport: | Storage Arguments |
A biztonsági mentés elhelyezéséhez használt tárfiók neve.
| Tulajdonság | Érték |
|---|---|
| Paramétercsoport: | Storage Arguments |
Opcionális paraméterek
Az alábbi paraméterek megadása nem kötelező, de a környezettől függően előfordulhat, hogy a parancs sikeres végrehajtásához egy vagy több is szükséges lehet.
Az erőforrásművelethez automatikusan beszerez egy Azure Policy-jogkivonatot.
| Tulajdonság | Érték |
|---|---|
| Paramétercsoport: | Global Policy Arguments |
Az erőforrásművelet kapcsolódó változáshivatkozás-azonosítója.
| Tulajdonság | Érték |
|---|---|
| Paramétercsoport: | Global Policy Arguments |
Ne várja meg, amíg a hosszú ideig futó művelet befejeződik.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |
Globális paraméterek
Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |
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.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |
Kimeneti formátum.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | json |
| Elfogadott értékek: | json, jsonc, none, table, tsv, yaml, yamlc |
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 a az account set -s NAME_OR_IDhasználatával konfigurálhatja.
A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |
az apim check-name
Ellenőrzi, hogy elérhető-e a szolgáltatásnév.
az apim check-name --name
[--acquire-policy-token]
[--change-reference]
Kötelező paraméterek
Az api management szolgáltatáspéldány neve.
Opcionális paraméterek
Az alábbi paraméterek megadása nem kötelező, de a környezettől függően előfordulhat, hogy a parancs sikeres végrehajtásához egy vagy több is szükséges lehet.
Az erőforrásművelethez automatikusan beszerez egy Azure Policy-jogkivonatot.
| Tulajdonság | Érték |
|---|---|
| Paramétercsoport: | Global Policy Arguments |
Az erőforrásművelet kapcsolódó változáshivatkozás-azonosítója.
| Tulajdonság | Érték |
|---|---|
| Paramétercsoport: | Global Policy Arguments |
Globális paraméterek
Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |
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.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |
Kimeneti formátum.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | json |
| Elfogadott értékek: | json, jsonc, none, table, tsv, yaml, yamlc |
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 a az account set -s NAME_OR_IDhasználatával konfigurálhatja.
A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |
az apim create
Hozzon létre egy API Management szolgáltatáspéldányt.
az apim create --name
--publisher-email
--publisher-name
--resource-group
[--acquire-policy-token]
[--change-reference]
[--disable-gateway {false, true}]
[--enable-client-certificate {false, true}]
[--enable-managed-identity {false, true}]
[--location]
[--no-wait]
[--public-network-access {false, true}]
[--sku-capacity]
[--sku-name {Basic, Consumption, Developer, Isolated, Premium, Standard}]
[--tags]
[--virtual-network {External, Internal, None}]
Példák
Fejlesztői szintű API Management szolgáltatás létrehozása.
az apim create --name MyApim -g MyResourceGroup -l eastus --publisher-email email@mydomain.com --publisher-name Microsoft
Hozzon létre egy használatalapú 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
A létrehozandó szolgáltatáspéldány egyedi neve.
A névnek globálisan egyedinek kell lennie, mivel az átjáró gazdagépneveként szerepelni fog, például" https://my-api-servicename.azure-api.net". Lásd a példákat.
Az összes rendszerértesítés fogadásához szükséges e-mail-cím.
A szervezet neve a fejlesztői portálon való használatra és az e-mail értesítésekben.
Az erőforráscsoport neve. Az alapértelmezett csoportot a az configure --defaults group=<name>használatával konfigurálhatja.
Opcionális paraméterek
Az alábbi paraméterek megadása nem kötelező, de a környezettől függően előfordulhat, hogy a parancs sikeres végrehajtásához egy vagy több is szükséges lehet.
Az erőforrásművelethez automatikusan beszerez egy Azure Policy-jogkivonatot.
| Tulajdonság | Érték |
|---|---|
| Paramétercsoport: | Global Policy Arguments |
Az erőforrásművelet kapcsolódó változáshivatkozás-azonosítója.
| Tulajdonság | Érték |
|---|---|
| Paramétercsoport: | Global Policy Arguments |
Az átjáró letiltása a főrégióban. Csak több helyen üzembe helyezett Api Management szolgáltatásra érvényes.
| Tulajdonság | Érték |
|---|---|
| Elfogadott értékek: | false, true |
Kikényszeríti az ügyféltanúsítvány bemutatását az átjárónak küldött minden egyes kérésen, és lehetővé teszi a tanúsítvány hitelesítését az átjáró házirendjében.
| Tulajdonság | Érték |
|---|---|
| Elfogadott értékek: | false, true |
Hozzon létre egy felügyelt identitást az API Management szolgáltatás számára más Azure erőforrások eléréséhez. Csak használati termékváltozat-szolgáltatáshoz használható.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |
| Elfogadott értékek: | false, true |
Location. Értékek: az account list-locations. Az alapértelmezett helyet a következővel az configure --defaults location=<location>konfigurálhatja: .
Ne várja meg, amíg a hosszú ideig futó művelet befejeződik.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |
Azt jelzi, hogy engedélyezett-e nyilvános végpont-hozzáférés ehhez az API Management szolgáltatáshoz. Ha igaz értékre van állítva, a privát végpontok a kizárólagos hozzáférési módszer.
| Tulajdonság | Érték |
|---|---|
| Elfogadott értékek: | false, true |
A termékváltozat üzembe helyezett egységeinek száma.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | 1 |
Az API Management-példány termékváltozata.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | Developer |
| Elfogadott értékek: | Basic, Consumption, Developer, Isolated, Premium, Standard |
Szóközzel elválasztott címkék: key[=value] [key[=value] ...]. Meglévő címkék törlése a "" használatával.
A virtuális hálózat típusa.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | None |
| Elfogadott értékek: | External, Internal, None |
Globális paraméterek
Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |
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.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |
Kimeneti formátum.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | json |
| Elfogadott értékek: | json, jsonc, none, table, tsv, yaml, yamlc |
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 a az account set -s NAME_OR_IDhasználatával konfigurálhatja.
A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |
az apim delete
Egy API Management-szolgáltatás törlése.
az apim delete --name
--resource-group
[--acquire-policy-token]
[--change-reference]
[--no-wait]
[--yes]
Példák
API Management-szolgáltatás törlése.
az apim delete -n MyApim -g MyResourceGroup
Kötelező paraméterek
Az api management szolgáltatáspéldány neve.
Az erőforráscsoport neve. Az alapértelmezett csoportot a az configure --defaults group=<name>használatával konfigurálhatja.
Opcionális paraméterek
Az alábbi paraméterek megadása nem kötelező, de a környezettől függően előfordulhat, hogy a parancs sikeres végrehajtásához egy vagy több is szükséges lehet.
Az erőforrásművelethez automatikusan beszerez egy Azure Policy-jogkivonatot.
| Tulajdonság | Érték |
|---|---|
| Paramétercsoport: | Global Policy Arguments |
Az erőforrásművelet kapcsolódó változáshivatkozás-azonosítója.
| Tulajdonság | Érték |
|---|---|
| Paramétercsoport: | Global Policy Arguments |
Ne várja meg, amíg a hosszú ideig futó művelet befejeződik.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |
Ne kérje a megerősítést.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |
Globális paraméterek
Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |
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.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |
Kimeneti formátum.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | json |
| Elfogadott értékek: | json, jsonc, none, table, tsv, yaml, yamlc |
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 a az account set -s NAME_OR_IDhasználatával konfigurálhatja.
A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |
az apim list
API Management-szolgáltatáspéldányok listázása.
az apim list [--resource-group]
Opcionális paraméterek
Az alábbi paraméterek megadása nem kötelező, de a környezettől függően előfordulhat, hogy a parancs sikeres végrehajtásához egy vagy több is szükséges lehet.
Az erőforráscsoport neve. Az alapértelmezett csoportot a az configure --defaults group=<name>használatával konfigurálhatja.
Globális paraméterek
Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |
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.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |
Kimeneti formátum.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | json |
| Elfogadott értékek: | json, jsonc, none, table, tsv, yaml, yamlc |
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 a az account set -s NAME_OR_IDhasználatával konfigurálhatja.
A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |
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 több percig is eltarthat.
az apim restore --backup-name
--container-name --storage-account-container
--name
--resource-group
--storage-account-key
--storage-account-name
[--acquire-policy-token]
[--change-reference]
[--no-wait]
Példák
Visszaállítja az 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
A visszaállítani kívánt biztonsági mentési fájl neve.
A biztonsági mentés lekéréséhez használt tárfiók-tároló neve.
Az api management szolgáltatáspéldány neve.
Az erőforráscsoport neve. Az alapértelmezett csoportot a az configure --defaults group=<name>használatával konfigurálhatja.
A biztonsági mentés lekéréséhez használt tárfiók hozzáférési kulcsa.
| Tulajdonság | Érték |
|---|---|
| Paramétercsoport: | Storage Arguments |
A biztonsági mentés lekéréséhez használt tárfiók neve.
| Tulajdonság | Érték |
|---|---|
| Paramétercsoport: | Storage Arguments |
Opcionális paraméterek
Az alábbi paraméterek megadása nem kötelező, de a környezettől függően előfordulhat, hogy a parancs sikeres végrehajtásához egy vagy több is szükséges lehet.
Az erőforrásművelethez automatikusan beszerez egy Azure Policy-jogkivonatot.
| Tulajdonság | Érték |
|---|---|
| Paramétercsoport: | Global Policy Arguments |
Az erőforrásművelet kapcsolódó változáshivatkozás-azonosítója.
| Tulajdonság | Érték |
|---|---|
| Paramétercsoport: | Global Policy Arguments |
Ne várja meg, amíg a hosszú ideig futó művelet befejeződik.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |
Globális paraméterek
Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |
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.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |
Kimeneti formátum.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | json |
| Elfogadott értékek: | json, jsonc, none, table, tsv, yaml, yamlc |
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 a az account set -s NAME_OR_IDhasználatával konfigurálhatja.
A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |
az apim show
Az API Management szolgáltatáspéldány részleteinek megjelenítése.
az apim show --name
--resource-group
Kötelező paraméterek
Az api management szolgáltatáspéldány neve.
Az erőforráscsoport neve. Az alapértelmezett csoportot a az configure --defaults group=<name>használatával konfigurálhatja.
Globális paraméterek
Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |
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.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |
Kimeneti formátum.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | json |
| Elfogadott értékek: | json, jsonc, none, table, tsv, yaml, yamlc |
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 a az account set -s NAME_OR_IDhasználatával konfigurálhatja.
A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |
az apim update
API Management szolgáltatáspéldány frissítése.
az apim update --name
--resource-group
[--acquire-policy-token]
[--add]
[--change-reference]
[--disable-gateway {false, true}]
[--enable-client-certificate {false, true}]
[--enable-managed-identity {false, true}]
[--force-string]
[--no-wait]
[--public-network-access {false, true}]
[--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
Az api management szolgáltatáspéldány neve.
Az erőforráscsoport neve. Az alapértelmezett csoportot a az configure --defaults group=<name>használatával konfigurálhatja.
Opcionális paraméterek
Az alábbi paraméterek megadása nem kötelező, de a környezettől függően előfordulhat, hogy a parancs sikeres végrehajtásához egy vagy több is szükséges lehet.
Az erőforrásművelethez automatikusan beszerez egy Azure Policy-jogkivonatot.
| Tulajdonság | Érték |
|---|---|
| Paramétercsoport: | Global Policy Arguments |
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>.
| Tulajdonság | Érték |
|---|---|
| Paramétercsoport: | Generic Update Arguments |
| Alapértelmezett érték: | [] |
Az erőforrásművelet kapcsolódó változáshivatkozás-azonosítója.
| Tulajdonság | Érték |
|---|---|
| Paramétercsoport: | Global Policy Arguments |
Az átjáró letiltása a főrégióban. Csak több helyen üzembe helyezett Api Management szolgáltatásra érvényes.
| Tulajdonság | Érték |
|---|---|
| Elfogadott értékek: | false, true |
Kikényszeríti az ügyféltanúsítvány bemutatását az átjárónak küldött minden egyes kérésen, és lehetővé teszi a tanúsítvány hitelesítését az átjáró házirendjében.
| Tulajdonság | Érték |
|---|---|
| Elfogadott értékek: | false, true |
Hozzon létre egy felügyelt identitást az API Management szolgáltatás számára más Azure erőforrások eléréséhez. Csak használati termékváltozat-szolgáltatáshoz használható.
| Tulajdonság | Érték |
|---|---|
| Elfogadott értékek: | false, true |
A "set" vagy a "add" használata esetén a JSON-ra való konvertálás helyett őrizze meg a sztringkonstansokat.
| Tulajdonság | Érték |
|---|---|
| Paramétercsoport: | Generic Update Arguments |
| Alapértelmezett érték: | False |
Ne várja meg, amíg a hosszú ideig futó művelet befejeződik.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |
Azt jelzi, hogy engedélyezett-e nyilvános végpont-hozzáférés ehhez az API Management szolgáltatáshoz. Ha igaz értékre van állítva, a privát végpontok a kizárólagos hozzáférési módszer.
| Tulajdonság | Érték |
|---|---|
| Elfogadott értékek: | false, true |
Az összes rendszerértesítés fogadásához szükséges e-mail-cím.
A szervezet neve a fejlesztői portálon való használatra és az e-mail értesítésekben.
Tulajdonság vagy elem eltávolítása a listából. Példa: --remove property.list <indexToRemove> VAGY --remove propertyToRemove.
| Tulajdonság | Érték |
|---|---|
| Paramétercsoport: | Generic Update Arguments |
| Alapértelmezett érték: | [] |
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>.
| Tulajdonság | Érték |
|---|---|
| Paramétercsoport: | Generic Update Arguments |
| Alapértelmezett érték: | [] |
A termékváltozat üzembe helyezett egységeinek száma.
Az API Management-példány termékváltozata.
| Tulajdonság | Érték |
|---|---|
| Elfogadott értékek: | Basic, Consumption, Developer, Isolated, Premium, Standard |
Szóközzel elválasztott címkék: key[=value] [key[=value] ...]. Meglévő címkék törlése a "" használatával.
A virtuális hálózat típusa.
| Tulajdonság | Érték |
|---|---|
| Elfogadott értékek: | External, Internal, None |
Globális paraméterek
Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |
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.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |
Kimeneti formátum.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | json |
| Elfogadott értékek: | json, jsonc, none, table, tsv, yaml, yamlc |
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 a az account set -s NAME_OR_IDhasználatával konfigurálhatja.
A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |
az apim wait
Helyezze a parancssori felületet várakozási állapotba, amíg az apim egy feltételének nem teljesül.
az apim wait --name
--resource-group
[--acquire-policy-token]
[--change-reference]
[--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. (autogenerated)
az apim wait --created --name MyApim --resource-group MyResourceGroup
Kötelező paraméterek
Az api management szolgáltatáspéldány neve.
Az erőforráscsoport neve. Az alapértelmezett csoportot a az configure --defaults group=<name>használatával konfigurálhatja.
Opcionális paraméterek
Az alábbi paraméterek megadása nem kötelező, de a környezettől függően előfordulhat, hogy a parancs sikeres végrehajtásához egy vagy több is szükséges lehet.
Az erőforrásművelethez automatikusan beszerez egy Azure Policy-jogkivonatot.
| Tulajdonság | Érték |
|---|---|
| Paramétercsoport: | Global Policy Arguments |
Az erőforrásművelet kapcsolódó változáshivatkozás-azonosítója.
| Tulajdonság | Érték |
|---|---|
| Paramétercsoport: | Global Policy Arguments |
Várjon, amíg létre nem jön a "provisioningState" a "Sikeres" helyen.
| Tulajdonság | Érték |
|---|---|
| Paramétercsoport: | Wait Condition Arguments |
| Alapértelmezett érték: | False |
Várjon, amíg a feltétel megfelel egy egyéni JMESPath-lekérdezésnek. Pl. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running"?.
| Tulajdonság | Érték |
|---|---|
| Paramétercsoport: | Wait Condition Arguments |
Várjon a törlésig.
| Tulajdonság | Érték |
|---|---|
| Paramétercsoport: | Wait Condition Arguments |
| Alapértelmezett érték: | False |
Várjon, amíg az erőforrás létezik.
| Tulajdonság | Érték |
|---|---|
| Paramétercsoport: | Wait Condition Arguments |
| Alapértelmezett érték: | False |
Lekérdezési időköz másodpercben.
| Tulajdonság | Érték |
|---|---|
| Paramétercsoport: | Wait Condition Arguments |
| Alapértelmezett érték: | 30 |
Maximális várakozás másodpercben.
| Tulajdonság | Érték |
|---|---|
| Paramétercsoport: | Wait Condition Arguments |
| Alapértelmezett érték: | 3600 |
Várjon, amíg frissül a provisioningState a következő helyen: "Sikeres".
| Tulajdonság | Érték |
|---|---|
| Paramétercsoport: | Wait Condition Arguments |
| Alapértelmezett érték: | False |
Globális paraméterek
Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |
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.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |
Kimeneti formátum.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | json |
| Elfogadott értékek: | json, jsonc, none, table, tsv, yaml, yamlc |
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 a az account set -s NAME_OR_IDhasználatával konfigurálhatja.
A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.
| Tulajdonság | Érték |
|---|---|
| Alapértelmezett érték: | False |