az apic api

Referencia

Feljegyzés

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 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.	Mellék	FE
az apic api definition	Parancsok az API-definíciók kezeléséhez az API Centerben.	Mellék	FE
az apic api definition create	Hozzon létre egy új API-definíciót, vagy frissítsen egy meglévő API-definíciót.	Mellék	FE
az apic api definition delete	Törölje a megadott API-definíciót.	Mellék	FE
az apic api definition export-specification	Exportálja az API-specifikációt.	Mellék	FE
az apic api definition import-specification	Importálja az API-specifikációt.	Mellék	FE
az apic api definition list	Api-definíciók gyűjteményének listázása.	Mellék	FE
az apic api definition show	Az API-definíció részleteinek lekérése.	Mellék	FE
az apic api definition update	Frissítse a meglévő API-definíciót.	Mellék	FE
az apic api delete	A megadott API törlése.	Mellék	FE
az apic api deployment	Parancsok az API-üzemelő példányok kezeléséhez az API Centerben.	Mellék	FE
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.	Mellék	FE
az apic api deployment delete	API-telepítés törlése.	Mellék	FE
az apic api deployment list	Az API-üzemelő példányok gyűjteményének listázása.	Mellék	FE
az apic api deployment show	Az API-telepítés részleteinek lekérése.	Mellék	FE
az apic api deployment update	Meglévő API-telepítés frissítése.	Mellék	FE
az apic api list	Api-k gyűjteményének listázása.	Mellék	FE
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.	Mellék	Előnézet
az apic api show	Az API részleteinek lekérése.	Mellék	FE
az apic api update	Meglévő API frissítése.	Mellék	FE
az apic api version	Parancsok az API-verziók kezeléséhez az API Centerben.	Mellék	FE
az apic api version create	Hozzon létre egy új API-verziót, vagy frissítsen egy meglévő API-verziót.	Mellék	FE
az apic api version delete	Törölje a megadott API-verziót.	Mellék	FE
az apic api version list	Az API-verziók gyűjteményének listázása.	Mellék	FE
az apic api version show	Az API-verzió részleteinek lekérése.	Mellék	FE
az apic api version update	Frissítse a meglévő API-verziót.	Mellék	FE

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}
                   [--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}'

Kötelező paraméterek

--api-id

Az API azonosítója.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>: .

--service-name -n

Az Azure API Center szolgáltatás neve.

--title

API-cím.

--type

Az API típusa.

Elfogadott értékek: graphql, grpc, rest, soap, webhook, websocket

Opcionális paraméterek

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

--custom-properties

Az API-katalógus entitásaihoz definiált egyéni metaadatok. Json-fájl és yaml-fájl támogatása.

--description

Az API leírása.

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

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

--summary

Az API rövid leírása.

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

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

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

A megadott API törlése.

az apic api delete [--api-id]
                   [--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

--api-id

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

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>: .

--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 konfigurálhatja a következővel az account set -s NAME_OR_ID: .

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

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

--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 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 konfigurálhatja a következővel az configure --defaults group=<name>: .

--service-name -n

Az Azure API Center szolgáltatás neve.

Opcionális paraméterek

--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 egy későbbi parancs argumentumában --next-token .

--next-token

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

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

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

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

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

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

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

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

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

--api-id

Az API azonosítója.

--ids

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>: .

--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 konfigurálhatja a következővel az account set -s NAME_OR_ID: .

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

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

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

Meglévő API frissítése.

az apic api update [--add]
                   [--api-id]
                   [--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}'

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

--api-id

Az API azonosítója.

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

--custom-properties

Az API-katalógus entitásaihoz definiált egyéni metaadatok. Json-fájl és yaml-fájl támogatása.

--description

Az API leírása.

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

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

--ids

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

--remove

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

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>: .

--service-name -n

Az Azure API Center szolgáltatás neve.

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

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

--summary

Az API rövid leírása.

--title

API-cím.

--type

Az API típusa.

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.

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

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

--verbose

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

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

az apic api

Parancsok

az apic api create

Példák

Kötelező paraméterek

Opcionális paraméterek

az apic api delete

Példák

Opcionális paraméterek

az apic api list

Példák

Kötelező paraméterek

Opcionális paraméterek

az apic api register

Példák

Kötelező paraméterek

Opcionális paraméterek

az apic api show

Példák

Opcionális paraméterek

az apic api update

Példák

Opcionális paraméterek

További források