az apic api

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 API-parancs első futtatásakor. További információ a bővítményekről.

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

Parancsok

Name	Description	Típus	Állapot
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 api create

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

az apic api create --api-id
                   --resource-group
                   --service-name
                   --title
                   --type {graphql, grpc, rest, soap, webhook, websocket}
                   [--acquire-policy-token]
                   [--change-reference]
                   [--contacts]
                   [--custom-properties]
                   [--description]
                   [--external-documentation]
                   [--license]
                   [--summary]

Példák

API létrehozása

az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST

API létrehozása egyéni tulajdonságokkal

az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST --custom-properties '{"public-facing":true}'

API létrehozása egyéni tulajdonságokkal json-fájl használatával

az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST --custom-properties '@customProperties.json'

Kötelező paraméterek

--api-id

Az API azonosítója.

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

--title

API-cím.

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

--type

Az API típusa.

Tulajdonság	Érték
Paramétercsoport:	Properties Arguments
Elfogadott értékek:	graphql, grpc, rest, soap, webhook, websocket

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

--contacts

Az API kapcsolattartási adatai. 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.

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

--custom-properties

Az API-katalógus entitásaihoz definiált egyéni metaadatok. 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.

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

--description

Az API leírása.

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

--external-documentation

Az API további külső dokumentációja. 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.

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

--license

Az API licencadatai. 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.

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

--summary

Az API rövid leírása.

Tulajdonság	Érték
Paramétercsoport:	Properties 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/ .

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

A megadott API törlése.

az apic api delete [--acquire-policy-token]
                   [--api-id]
                   [--change-reference]
                   [--ids]
                   [--resource-group]
                   [--service-name]
                   [--subscription]
                   [--yes]

Példák

API törlése

az apic api delete -g contoso-resources -n contoso --api-id echo-api

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

--api-id

Az API azonosítója.

Tulajdonság	Érték
Paramétercsoport:	Resource Id 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

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

--service-name -n

Az AZURE API Center szolgáltatás neve.

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

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

az apic api list --resource-group
                 --service-name
                 [--filter]
                 [--max-items]
                 [--next-token]

Példák

API-k listázása

az apic api list -g contoso-resources -n contoso

API-k listázása szűrővel

az apic api list -g contoso-resources -n contoso --filter "kind eq 'rest'"

Kötelező paraméterek

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

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.

--filter

OData szűrőparaméter.

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

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

Előnézet

Ez a parancs előzetes verzióban és fejlesztés alatt áll. Referencia- és támogatási szintek: https://aka.ms/CLI_refstatus

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.

az apic api register --api-location
                     --resource-group
                     --service-name
                     [--acquire-policy-token]
                     [--change-reference]
                     [--environment-id]

Példák

Api regisztrálása spec fájl megadásával.

az apic api register -g api-center-test -n contosoeuap --api-location "examples/cli-examples/spec-examples/openai.json" --environment-id public
az apic api register -g api-center-test -n contosoeuap --api-location "examples/cli-examples/spec-examples/openai.yml" --environment-id public

Api regisztrálása spec URL-cím megadásával.

az apic api register -g api-center-test -n contosoeuap --api-location "https://petstore.swagger.io/v2/swagger.json" --environment-id public
az apic api register -g api-center-test -n contosoeuap --api-location "https://petstore.swagger.io/v2/swagger.yaml" --environment-id public

Kötelező paraméterek

--api-location -l

A spec fájl helye.

--resource-group -g

Az erőforráscsoport neve.

--service-name -n

APICenter-katalógus vagy szolgáltatásnév.

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

--environment-id

A korábban létrehozott környezet azonosítója.

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

Az API részleteinek lekérése.

az apic api show [--api-id]
                 [--ids]
                 [--resource-group]
                 [--service-name]
                 [--subscription]

Példák

API részleteinek megjelenítése

az apic api show -g contoso-resources -n contoso --api-id echo-api

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.

--api-id

Az API azonosítója.

Tulajdonság	Érték
Paramétercsoport:	Resource Id 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

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

--service-name -n

Az AZURE API Center szolgáltatás neve.

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

Meglévő API frissítése.

az apic api update [--acquire-policy-token]
                   [--add]
                   [--api-id]
                   [--change-reference]
                   [--contacts]
                   [--custom-properties]
                   [--description]
                   [--external-documentation]
                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                   [--ids]
                   [--license]
                   [--remove]
                   [--resource-group]
                   [--service-name]
                   [--set]
                   [--subscription]
                   [--summary]
                   [--title]
                   [--type {graphql, grpc, rest, soap, webhook, websocket}]

Példák

API frissítése

az apic api update -g contoso-resources -n contoso --api-id echo-api --summary "Basic REST API service"

Egyéni tulajdonságok frissítése

az apic api update -g contoso-resources -n contoso --api-id echo-api --custom-properties '{"public-facing":true}'

Egyéni tulajdonságok frissítése json-fájllal

az apic api update -g contoso-resources -n contoso --api-id echo-api --custom-properties '@customProperities.json'

Egyéni metaadatok frissítése

az apic api update -g contoso-resources -n contoso --api-id echo-api --set customProperties.internal=false

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

--api-id

Az API azonosítója.

Tulajdonság	Érték
Paramétercsoport:	Resource Id 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

--contacts

Az API kapcsolattartási adatai. 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.

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

--custom-properties

Az API-katalógus entitásaihoz definiált egyéni metaadatok. 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.

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

--description

Az API leírása.

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

--external-documentation

Az API további külső dokumentációja. 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.

Tulajdonság	Érték
Paramétercsoport:	Properties 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

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

--license

Az API licencadatai. 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.

Tulajdonság	Érték
Paramétercsoport:	Properties 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

--service-name -n

Az AZURE API Center szolgáltatás neve.

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

--summary

Az API rövid leírása.

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

--title

API-cím.

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

--type

Az API típusa.

Tulajdonság	Érték
Paramétercsoport:	Properties Arguments
Elfogadott értékek:	graphql, grpc, rest, soap, webhook, websocket

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