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

az apic

  • Referencia

Jegyzet

Ez a hivatkozás az Azure CLI apic-extension bővítményének része (2.57.0-s vagy újabb verzió). A bővítmény automatikusan telepíti az az apic parancs első futtatásakor. További a bővítményekről.

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

Parancsok

Name Description Típus Állapot
az apic api

Api-k kezelésére szolgáló parancsok az API Centerben.

 Kiterjesztés GA
az apic api create

Regisztráljon egy új API-t, vagy frissítsen egy meglévő API-t.

 Kiterjesztés GA
az apic api definition

Parancsok az API-definíciók kezeléséhez az API Centerben.

 Kiterjesztés GA
az apic api definition create

Hozzon létre egy új API-definíciót, vagy frissítsen egy meglévő API-definíciót.

 Kiterjesztés GA
az apic api definition delete

Törölje a megadott API-definíciót.

 Kiterjesztés GA
az apic api definition export-specification

Exportálja az API-specifikációt.

 Kiterjesztés GA
az apic api definition import-specification

Importálja az API-specifikációt.

 Kiterjesztés GA
az apic api definition list

Api-definíciók gyűjteményének listázása.

 Kiterjesztés GA
az apic api definition show

Az API-definíció részleteinek lekérése.

 Kiterjesztés GA
az apic api definition update

Frissítse a meglévő API-definíciót.

 Kiterjesztés GA
az apic api delete

A megadott API törlése.

 Kiterjesztés GA
az apic api deployment

Parancsok az API-üzemelő példányok kezeléséhez az API Centerben.

 Kiterjesztés GA
az apic api deployment create

Hozzon létre egy új API-üzemelő példányt, vagy frissítsen egy meglévő API-üzemelő példányt.

 Kiterjesztés GA
az apic api deployment delete

API-telepítés törlése.

 Kiterjesztés GA
az apic api deployment list

Az API-üzemelő példányok gyűjteményének listázása.

 Kiterjesztés GA
az apic api deployment show

Az API-telepítés részleteinek lekérése.

 Kiterjesztés GA
az apic api deployment update

Meglévő API-telepítés frissítése.

 Kiterjesztés GA
az apic api list

Api-k gyűjteményének listázása.

 Kiterjesztés GA
az apic api register

Regisztrál egy új API-t verzióval, definícióval és társított üzembe helyezésekkel a specifikációs fájl használatával az igazság forrásaként. Egyelőre csak az OpenAPI JSON/YAML formátumot támogatjuk.

 Kiterjesztés Előnézet
az apic api show

Az API részleteinek lekérése.

 Kiterjesztés GA
az apic api update

Meglévő API frissítése.

 Kiterjesztés GA
az apic api version

Parancsok az API-verziók kezeléséhez az API Centerben.

 Kiterjesztés GA
az apic api version create

Hozzon létre egy új API-verziót, vagy frissítsen egy meglévő API-verziót.

 Kiterjesztés GA
az apic api version delete

Törölje a megadott API-verziót.

 Kiterjesztés GA
az apic api version list

Az API-verziók gyűjteményének listázása.

 Kiterjesztés GA
az apic api version show

Az API-verzió részleteinek lekérése.

 Kiterjesztés GA
az apic api version update

Frissítse a meglévő API-verziót.

 Kiterjesztés GA
az apic create

Létrehoz egy példányt, vagy frissíti az Azure API Center szolgáltatás meglévő példányát.

 Kiterjesztés GA
az apic delete

Törli az Azure API Center szolgáltatás egy példányát.

 Kiterjesztés GA
az apic environment

Parancsok környezetek kezeléséhez az API Centerben.

 Kiterjesztés GA
az apic environment create

Hozzon létre egy új környezetet, vagy frissítsen egy meglévő környezetet.

 Kiterjesztés GA
az apic environment delete

Törölje a környezetet.

 Kiterjesztés GA
az apic environment list

Környezetek gyűjteményének listázása.

 Kiterjesztés GA
az apic environment show

A környezet részleteinek lekérése.

 Kiterjesztés GA
az apic environment update

Meglévő környezet frissítése.

 Kiterjesztés GA
az apic import

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

 Kiterjesztés GA
az apic import-from-apim

API-kat importál egy Azure API Management szolgáltatáspéldányból.

 Kiterjesztés GA
az apic import aws

Importálja az Amazon API Gateway API-forrását.

 Kiterjesztés Előnézet
az apic integration

Integrációkat kezel az Azure API Centerben.

 Kiterjesztés Előnézet
az apic integration create

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

 Kiterjesztés Előnézet
az apic integration create apim

Adja hozzá az Azure APIM-et API-forrásként.

 Kiterjesztés Előnézet
az apic integration create aws

Adja hozzá az Amazon API Gatewayt API-forrásként.

 Kiterjesztés Előnézet
az apic integration delete

Törölje a megadott API-forrást.

 Kiterjesztés Előnézet
az apic integration list

API-források gyűjteményének listázása.

 Kiterjesztés Előnézet
az apic integration show

Az API-forrás részleteinek lekérése.

 Kiterjesztés Előnézet
az apic list

Az Azure API Center egy Azure-előfizetésen belüli szolgáltatásait sorolja fel.

 Kiterjesztés GA
az apic metadata

Metaadat-sémák kezelésére szolgáló parancsok az API Centerben.

 Kiterjesztés GA
az apic metadata create

Hozzon létre egy új metaadat-sémát, vagy frissítsen egy meglévő metaadatsémát.

 Kiterjesztés GA
az apic metadata delete

A megadott metaadat-séma törlése.

 Kiterjesztés GA
az apic metadata export

Exportálja a metaadat-sémát.

 Kiterjesztés GA
az apic metadata list

Metaadat-sémák gyűjteményének listázása.

 Kiterjesztés GA
az apic metadata show

A metaadatséma részleteinek lekérése.

 Kiterjesztés GA
az apic metadata update

Meglévő metaadat-séma frissítése.

 Kiterjesztés GA
az apic show

Az Azure API Center szolgáltatáspéldány részleteinek megjelenítése.

 Kiterjesztés GA
az apic update

Az Azure API Center szolgáltatás egy példányának frissítése.

 Kiterjesztés GA

az apic create

Létrehoz egy példányt, vagy frissíti az Azure API Center szolgáltatás meglévő példányát.

az apic create --name
               --resource-group
               [--identity]
               [--location]
               [--tags]

Példák

Példa szolgáltatás létrehozása

az apic create -g contoso-resources -n contoso -l eastus

Szolgáltatás létrehozása rendszer által hozzárendelt identitással – példa

az apic create -g contoso-resources -n contoso -l eastus --identity '{type:systemassigned}'

Kötelező paraméterek

--name -n

Az API Center szolgáltatás neve.

--resource-group -g

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

Opcionális paraméterek

--identity

Az erőforráshoz rendelt felügyeltszolgáltatás-identitások. A rövidített szintaxis, a json-file és a yaml-file támogatása. Próbálja ki a "??" elemet a továbbiak megjelenítéséhez.

--location -l

Az a földrajzi hely, ahol az erőforrás él, ha nincs megadva, az erőforráscsoport helye lesz használva.

--tags

Erőforráscímkék. A rövidített szintaxis, a json-file és a yaml-file támogatása. Próbálja ki a "??" elemet a továbbiak megjelenítéséhez.

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 a http://jmespath.org/.

--subscription

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.

--verbose

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

az apic delete

Törli az Azure API Center szolgáltatás egy példányát.

az apic delete [--ids]
               [--name]
               [--resource-group]
               [--subscription]
               [--yes]

Példák

Szolgáltatás törlése

az apic delete -n contoso -g contoso-resources

Opcionális paraméterek

--ids

Egy vagy több erőforrásazonosító (szóközzel tagolt). Teljes erőforrás-azonosítónak kell lennie, amely tartalmazza az "Erőforrás-azonosító" argumentumok összes információját. Adjon meg --ids vagy más "Erőforrás-azonosító" argumentumot.

--name -n

Az API Center szolgáltatás neve.

--resource-group -g

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

--subscription

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.

--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 a http://jmespath.org/.

--subscription

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.

--verbose

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

az apic import-from-apim

API-kat importál egy Azure API Management szolgáltatáspéldányból.

az apic import-from-apim --apim-apis
                         --apim-name
                         [--apim-resource-group]
                         [--apim-subscription]
                         [--ids]
                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                         [--resource-group]
                         [--service-name]
                         [--subscription]

Példák

Az összes API-nak importálása az APIM-ből ugyanabban az erőforráscsoportban

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-name contoso-apim --apim-apis *

Kijelölt API-k importálása az APIM-ből ugyanabban az erőforráscsoportban

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-name contoso-apim --apim-apis [echo,foo]

Az ÖSSZES API importálása APIM-ből egy másik előfizetésben és erőforráscsoportban

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-subscription 00000000-0000-0000-0000-000000000000 --apim-resource-group apim-rg --apim-name contoso-apim --apim-apis *

Kötelező paraméterek

--apim-apis

Az importálandó API-k. A rövidített szintaxis, a json-file és a yaml-file támogatása. Próbálja ki a "??" elemet a továbbiak megjelenítéséhez.

--apim-name

A forrás APIM-példány neve.

Opcionális paraméterek

--apim-resource-group

A forrás APIM-példány erőforráscsoportja.

--apim-subscription

A forrás APIM-példány előfizetés-azonosítója.

--ids

Egy vagy több erőforrásazonosító (szóközzel tagolt). Teljes erőforrás-azonosítónak kell lennie, amely tartalmazza az "Erőforrás-azonosító" argumentumok összes információját. Adjon meg --ids vagy más "Erőforrás-azonosító" argumentumot.

--no-wait

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

Elfogadott értékek: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

--service-name -n

Az Azure API Center szolgáltatás neve.

--subscription

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.

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 a http://jmespath.org/.

--subscription

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.

--verbose

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

az apic list

Az Azure API Center egy Azure-előfizetésen belüli szolgáltatásait sorolja fel.

Ismert probléma, hogy az előfizetés összes erőforrásának felsorolása nem működik. Adja meg az erőforrásokat erőforráscsoport szerint.

az apic list [--max-items]
             [--next-token]
             [--resource-group]

Példák

Szolgáltatások listázása az erőforráscsoportban

az apic list -g contoso-resources

Opcionális paraméterek

--max-items

A parancs kimenetében visszaadandó elemek teljes száma. Ha az elérhető elemek teljes száma meghaladja a megadott értéket, a parancs kimenetében egy jogkivonatot ad meg. A lapozás folytatásához adja meg a jogkivonat értékét --next-token következő parancs argumentumában.

--next-token

Jogkivonat a lapozás indításának helyét adhatja meg. Ez egy korábban csonkolt válasz jogkivonat-értéke.

--resource-group -g

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

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 a http://jmespath.org/.

--subscription

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.

--verbose

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

az apic show

Az Azure API Center szolgáltatáspéldány részleteinek megjelenítése.

az apic show [--ids]
             [--name]
             [--resource-group]
             [--subscription]

Példák

Szolgáltatás részleteinek megjelenítése

az apic show -g contoso-resources -n contoso

Opcionális paraméterek

--ids

Egy vagy több erőforrásazonosító (szóközzel tagolt). Teljes erőforrás-azonosítónak kell lennie, amely tartalmazza az "Erőforrás-azonosító" argumentumok összes információját. Adjon meg --ids vagy más "Erőforrás-azonosító" argumentumot.

--name -n

Az API Center szolgáltatás neve.

--resource-group -g

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

--subscription

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.

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 a http://jmespath.org/.

--subscription

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.

--verbose

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

az apic update

Az Azure API Center szolgáltatás egy példányának frissítése.

az apic update [--add]
               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
               [--identity]
               [--ids]
               [--name]
               [--remove]
               [--resource-group]
               [--set]
               [--subscription]
               [--tags]

Példák

A szolgáltatás részleteinek frissítése

az apic update -g contoso-resources -n contoso

Szolgáltatás frissítése rendszer által hozzárendelt identitással – példa

az apic update -g contoso-resources -n contoso --identity '{type:systemassigned}'

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

--force-string

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

Elfogadott értékek: 0, 1, f, false, n, no, t, true, y, yes
--identity

Az erőforráshoz rendelt felügyeltszolgáltatás-identitások. A rövidített szintaxis, a json-file és a yaml-file támogatása. Próbálja ki a "??" elemet a továbbiak megjelenítéséhez.

--ids

Egy vagy több erőforrásazonosító (szóközzel tagolt). Teljes erőforrás-azonosítónak kell lennie, amely tartalmazza az "Erőforrás-azonosító" argumentumok összes információját. Adjon meg --ids vagy más "Erőforrás-azonosító" argumentumot.

--name -n

Az API Center szolgáltatás neve.

--remove

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

--resource-group -g

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

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

--subscription

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.

--tags

Erőforráscímkék. A rövidített szintaxis, a json-file és a yaml-file támogatása. Próbálja ki a "??" elemet a továbbiak megjelenítéséhez.

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 a http://jmespath.org/.

--subscription

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.

--verbose

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