az apim api schema
Az Azure API Management API-sémák kezelése.
Parancsok
Name | Description | Típus | Állapot |
---|---|---|---|
az apim api schema create |
Hozzon létre egy API Management API-sémát. |
Alapvető | FE |
az apim api schema delete |
API Management API-séma törlése. |
Alapvető | FE |
az apim api schema get-etag |
Api Management API-séma etagjének lekérése. |
Alapvető | FE |
az apim api schema list |
Az API Management API-sémák listázása. |
Alapvető | FE |
az apim api schema show |
Az API Management API-séma részleteinek megjelenítése. |
Alapvető | FE |
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. |
Alapvető | FE |
az apim api schema create
Hozzon létre egy API Management API-sémát.
az apim api schema create --api-id
--resource-group
--schema-id
--schema-type
--service-name
[--no-wait]
[--resource-type]
[--schema-content]
[--schema-name]
[--schema-path]
Példák
API-séma létrehozása.
az apim api schema create --service-name MyApim -g MyResourceGroup --api-id MyApi --schema-id schemaId --schema-type schemaType --schema-path schemaFilePath
Kötelező paraméterek
Annak az API-nak az egyedi neve, amelyhez sémát kell létrehozni.
API-változat azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat rendelkezik ; rev=n utótagként, ahol n a változat száma.
Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>
: .
A létrehozandó API-séma egyedi neve.
Sémaazonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.
Sématípus (pl. application/json, application/vnd.ms-azure-apim.graphql.schema).
Az RFC 2616-ban meghatározott Tartalomtípus fejlécben használt érvényes médiatípusnak kell lennie. A sémadokumentum médiatípusa.
Az API Management szolgáltatáspéldány neve.
Opcionális paraméterek
Ne várja meg, amíg a hosszú ideig futó művelet befejeződik.
Az erőforrás típusa. Például "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts".
A Json megmenekült sztringet, amely a sémát képviselő dokumentumot definiálja.
Adja meg a --schema-path vagy a --schema-content nem mindkettőt.
A sémaerőforrás neve.
Az API sémájának importálásához megadott fájl elérési útja.
Adja meg a --schema-path vagy a --schema-content nem mindkettőt.
Globális paraméterek
Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.
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.
Kimeneti formátum.
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 konfigurálhatja a következővel az account set -s NAME_OR_ID
: .
A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.
az apim api schema delete
API Management API-séma törlése.
az apim api schema delete --api-id
--resource-group
--schema-id
--service-name
[--if-match]
[--no-wait]
[--yes]
Példák
API-séma törlése.
az apim api schema delete --service-name MyApim -g MyResourceGroup --api-id MyApi --schema-id schemaId
Kötelező paraméterek
API-azonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat rendelkezik ; rev=n utótagként, ahol n a változat száma.
Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>
: .
Sémaazonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat rendelkezik ; rev=n utótagként, ahol n a változat száma.
Az API Management szolgáltatáspéldány neve.
Opcionális paraméterek
Az entitás ETagje.
Ne várja meg, amíg a hosszú ideig futó művelet befejeződik.
Ne kérje a megerősítést.
Globális paraméterek
Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.
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.
Kimeneti formátum.
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 konfigurálhatja a következővel az account set -s NAME_OR_ID
: .
A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.
az apim api schema get-etag
Api Management API-séma etagjének lekérése.
az apim api schema get-etag --api-id
--resource-group
--schema-id
--service-name
Példák
sémaentitási címke lekérése.
az apim api schema get-etag --service-name MyApim -g MyResourceGroup --api-id MyApi --schema-id schemaId
Kötelező paraméterek
API-azonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat rendelkezik ; rev=n utótagként, ahol n a változat száma.
Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>
: .
Sémaazonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat rendelkezik ; rev=n utótagként, ahol n a változat száma.
Az API Management szolgáltatáspéldány neve.
Globális paraméterek
Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.
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.
Kimeneti formátum.
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 konfigurálhatja a következővel az account set -s NAME_OR_ID
: .
A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.
az apim api schema list
Az API Management API-sémák listázása.
az apim api schema list --api-id
--resource-group
--service-name
[--filter-display-name]
[--skip]
[--top]
Példák
Az API-azonosítóhoz társított sémák listájának lekérése.
az apim api schema list --service-name MyApim -g MyResourceGroup --api-id MyApi
Kötelező paraméterek
API-azonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat rendelkezik ; rev=n utótagként, ahol n a változat száma.
Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>
: .
Az API Management szolgáltatáspéldány neve.
Opcionális paraméterek
API-k szűrése a displayName alapján.
Kihagyandó rekordok száma.
A visszaadni kívánt rekordok száma.
Globális paraméterek
Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.
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.
Kimeneti formátum.
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 konfigurálhatja a következővel az account set -s NAME_OR_ID
: .
A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.
az apim api schema show
Az API Management API-séma részleteinek megjelenítése.
az apim api schema show --api-id
--resource-group
--schema-id
--service-name
Példák
API-séma lekérése.
az apim api schema show --service-name MyApim -g MyResourceGroup --api-id MyApi --schema-id schemaId
Kötelező paraméterek
API-azonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat rendelkezik ; rev=n utótagként, ahol n a változat száma.
Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>
: .
Sémaazonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat rendelkezik ; rev=n utótagként, ahol n a változat száma.
Az API Management szolgáltatáspéldány neve.
Globális paraméterek
Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.
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.
Kimeneti formátum.
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 konfigurálhatja a következővel az account set -s NAME_OR_ID
: .
A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.
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.
az apim api schema wait --api-id
--name
--resource-group
--schema-id
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]
Példák
Helyezze a parancssori felületet várakozási állapotba, amíg egy apim API-séma valamely feltétele teljesül.
az apim api schema wait --created --api-id MyApi --name MyApim --schema-id schemaId -g MyResourceGroup
Kötelező paraméterek
API-változat azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat rendelkezik ; rev=n utótagként, ahol n a változat száma. Szükséges.
Az api management szolgáltatáspéldány neve.
Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>
: .
Sémaazonosító azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. Szükséges.
Opcionális paraméterek
Várjon, amíg létre nem jön a "provisioningState" a "Sikeres" helyen.
Várjon, amíg a feltétel megfelel egy egyéni JMESPath-lekérdezésnek. Pl. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running"?.
Várjon a törlésig.
Várjon, amíg az erőforrás létezik.
Lekérdezési időköz másodpercben.
Maximális várakozás másodpercben.
Várjon, amíg frissül a provisioningState a következő helyen: "Sikeres".
Globális paraméterek
Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.
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.
Kimeneti formátum.
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 konfigurálhatja a következővel az account set -s NAME_OR_ID
: .
A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.