az apic

Note

Ez a hivatkozás a 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 információ 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.	Extension	GA
az apic api-analysis	Az AZURE API Center szolgáltatás API-elemzési funkcióinak kezelése.	Extension	Preview
az apic api-analysis create	Hozzon létre új vagy frissített API-elemző konfigurációt.	Extension	Preview
az apic api-analysis delete	Az API-elemző konfigurációjának törlése.	Extension	Preview
az apic api-analysis export-ruleset	Exportálja az API-elemző szabálykészletet.	Extension	Preview
az apic api-analysis import-ruleset	Importálja az API-elemző szabálykészletet.	Extension	Preview
az apic api-analysis list	API-elemző konfigurációk listázása.	Extension	Preview
az apic api-analysis show	Az API-elemző konfigurációjának részletei.	Extension	Preview
az apic api-analysis update	Frissítse az új vagy a meglévő API-elemző konfigurációját.	Extension	Preview
az apic api create	Regisztráljon egy új API-t, vagy frissítsen egy meglévő API-t.	Extension	GA
az apic api definition	Parancsok az API-definíciók kezeléséhez az API Centerben.	Extension	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.	Extension	GA
az apic api definition delete	Törölje a megadott API-definíciót.	Extension	GA
az apic api definition export-specification	Exportálja az API-specifikációt.	Extension	GA
az apic api definition import-specification	Importálja az API-specifikációt.	Extension	GA
az apic api definition list	Api-definíciók gyűjteményének listázása.	Extension	GA
az apic api definition show	Az API-definíció részleteinek lekérése.	Extension	GA
az apic api definition update	Frissítse a meglévő API-definíciót.	Extension	GA
az apic api delete	A megadott API törlése.	Extension	GA
az apic api deployment	Parancsok az API-üzemelő példányok kezeléséhez az API Centerben.	Extension	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.	Extension	GA
az apic api deployment delete	API-telepítés törlése.	Extension	GA
az apic api deployment list	Az API-üzemelő példányok gyűjteményének listázása.	Extension	GA
az apic api deployment show	Az API-telepítés részleteinek lekérése.	Extension	GA
az apic api deployment update	Meglévő API-telepítés frissítése.	Extension	GA
az apic api list	Api-k gyűjteményének listázása.	Extension	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.	Extension	Preview
az apic api show	Az API részleteinek lekérése.	Extension	GA
az apic api update	Meglévő API frissítése.	Extension	GA
az apic api version	Parancsok az API-verziók kezeléséhez az API Centerben.	Extension	GA
az apic api version create	Hozzon létre egy új API-verziót, vagy frissítsen egy meglévő API-verziót.	Extension	GA
az apic api version delete	Törölje a megadott API-verziót.	Extension	GA
az apic api version list	Az API-verziók gyűjteményének listázása.	Extension	GA
az apic api version show	Az API-verzió részleteinek lekérése.	Extension	GA
az apic api version update	Frissítse a meglévő API-verziót.	Extension	GA
az apic create	Létrehoz egy példányt, vagy frissíti egy Azure API Center-szolgáltatás meglévő példányát.	Extension	GA
az apic delete	Egy Azure API Center-szolgáltatás egy példányát törli.	Extension	GA
az apic environment	Parancsok környezetek kezeléséhez az API Centerben.	Extension	GA
az apic environment create	Hozzon létre egy új környezetet, vagy frissítsen egy meglévő környezetet.	Extension	GA
az apic environment delete	A környezet törlése.	Extension	GA
az apic environment list	Környezetek gyűjteményének listázása.	Extension	GA
az apic environment show	A környezet részleteinek lekérése.	Extension	GA
az apic environment update	Meglévő környezet frissítése.	Extension	GA
az apic integration	Az integrációkat Azure API Centerben kezeli.	Extension	GA
az apic integration create	Azure API Center-szolgáltatások kezelése.	Extension	GA
az apic integration create apim	Adjon hozzá Azure APIM-et API-forrásként.	Extension	GA
az apic integration create aws	Adja hozzá az Amazon API Gatewayt API-forrásként.	Extension	GA
az apic integration delete	Törölje a megadott API-forrást.	Extension	GA
az apic integration list	API-források gyűjteményének listázása.	Extension	GA
az apic integration show	Az API-forrás részleteinek lekérése.	Extension	GA
az apic list	Egy Azure-előfizetésen belüli Azure API Center-szolgáltatások listája.	Extension	GA
az apic metadata	Metaadat-sémák kezelésére szolgáló parancsok az API Centerben.	Extension	GA
az apic metadata create	Hozzon létre egy új metaadat-sémát, vagy frissítsen egy meglévő metaadatsémát.	Extension	GA
az apic metadata delete	A megadott metaadat-séma törlése.	Extension	GA
az apic metadata export	Exportálja a metaadat-sémát.	Extension	GA
az apic metadata list	Metaadat-sémák gyűjteményének listázása.	Extension	GA
az apic metadata show	A metaadatséma részleteinek lekérése.	Extension	GA
az apic metadata update	Meglévő metaadat-séma frissítése.	Extension	GA
az apic show	Egy Azure API Center szolgáltatáspéldány részleteinek megjelenítése.	Extension	GA
az apic update	Frissítse egy Azure API Center-szolgáltatás egy példányát.	Extension	GA

az apic create

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

az apic create --name
               --resource-group
               [--acquire-policy-token]
               [--change-reference]
               [--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

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.

--acquire-policy-token

Az erőforrásművelethez automatikusan beszerez egy Azure Policy-jogkivonatot.

Tulajdonság	Érték
Paramétercsoport:	Global Policy Arguments

--change-reference

Az erőforrásművelet kapcsolódó változáshivatkozás-azonosítója.

Tulajdonság	Érték
Paramétercsoport:	Global Policy Arguments

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

Tulajdonság	Érték
Alapértelmezett érték:	False

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

Tulajdonság	Érték
Alapértelmezett érték:	False

--output -o

Kimeneti formátum.

Tulajdonság	Érték
Alapértelmezett érték:	json
Elfogadott értékek:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath lekérdezési sztring. További információkért és példákért lásd 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.

Tulajdonság	Érték
Alapértelmezett érték:	False

az apic delete

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

az apic delete [--acquire-policy-token]
               [--change-reference]
               [--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

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.

--acquire-policy-token

Az erőforrásművelethez automatikusan beszerez egy Azure Policy-jogkivonatot.

Tulajdonság	Érték
Paramétercsoport:	Global Policy Arguments

--change-reference

Az erőforrásművelet kapcsolódó változáshivatkozás-azonosítója.

Tulajdonság	Érték
Paramétercsoport:	Global Policy Arguments

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

Tulajdonság	Érték
Paramétercsoport:	Resource Id Arguments

--name -n

Az API Center szolgáltatás neve.

Tulajdonság	Érték
Paramétercsoport:	Resource Id Arguments

--resource-group -g

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

Tulajdonság	Érték
Paramétercsoport:	Resource Id Arguments

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

Tulajdonság	Érték
Paramétercsoport:	Resource Id Arguments

--yes -y

Ne kérje a megerősítést.

Tulajdonság	Érték
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.

Tulajdonság	Érték
Alapértelmezett érték:	False

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

Tulajdonság	Érték
Alapértelmezett érték:	False

--output -o

Kimeneti formátum.

Tulajdonság	Érték
Alapértelmezett érték:	json
Elfogadott értékek:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--verbose

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

Egy Azure-előfizetésen belüli Azure API Center-szolgáltatások listája.

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

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.

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

Tulajdonság	Érték
Paramétercsoport:	Pagination Arguments

--next-token

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

Tulajdonság	Érték
Paramétercsoport:	Pagination Arguments

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

Tulajdonság	Érték
Alapértelmezett érték:	False

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

Tulajdonság	Érték
Alapértelmezett érték:	False

--output -o

Kimeneti formátum.

Tulajdonság	Érték
Alapértelmezett érték:	json
Elfogadott értékek:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath lekérdezési sztring. További információkért és példákért lásd 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.

Tulajdonság	Érték
Alapértelmezett érték:	False

az apic show

Egy 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

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.

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

Tulajdonság	Érték
Paramétercsoport:	Resource Id Arguments

--name -n

Az API Center szolgáltatás neve.

Tulajdonság	Érték
Paramétercsoport:	Resource Id Arguments

--resource-group -g

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

Tulajdonság	Érték
Paramétercsoport:	Resource Id Arguments

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

Tulajdonság	Érték
Paramétercsoport:	Resource Id Arguments

Globális paraméterek

--debug

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

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

Tulajdonság	Érték
Alapértelmezett érték:	False

--output -o

Kimeneti formátum.

Tulajdonság	Érték
Alapértelmezett érték:	json
Elfogadott értékek:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--verbose

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

Frissítse egy Azure API Center-szolgáltatás egy példányát.

az apic update [--acquire-policy-token]
               [--add]
               [--change-reference]
               [--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

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.

--acquire-policy-token

Az erőforrásművelethez automatikusan beszerez egy Azure Policy-jogkivonatot.

Tulajdonság	Érték
Paramétercsoport:	Global Policy Arguments

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

Tulajdonság	Érték
Paramétercsoport:	Generic Update Arguments

--change-reference

Az erőforrásművelet kapcsolódó változáshivatkozás-azonosítója.

Tulajdonság	Érték
Paramétercsoport:	Global Policy Arguments

--force-string

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

Tulajdonság	Érték
Paramétercsoport:	Resource Id Arguments

--name -n

Az API Center szolgáltatás neve.

Tulajdonság	Érték
Paramétercsoport:	Resource Id Arguments

--remove

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

--resource-group -g

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

Tulajdonság	Érték
Paramétercsoport:	Resource Id Arguments

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

Tulajdonság	Érték
Paramétercsoport:	Generic Update Arguments

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

Tulajdonság	Érték
Paramétercsoport:	Resource Id Arguments

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

Tulajdonság	Érték
Alapértelmezett érték:	False

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

Tulajdonság	Érték
Alapértelmezett érték:	False

--output -o

Kimeneti formátum.

Tulajdonság	Érték
Alapértelmezett érték:	json
Elfogadott értékek:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--verbose

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