az apim api schema

Az Azure API Management API-sémák kezelése.

Parancsok

az apim api schema create	Hozzon létre egy API Management API-sémát.
az apim api schema delete	Töröljön egy API Management API-sémát.
az apim api schema get-etag	Egy API Management API-séma etagjének lekérése.
az apim api schema list	API Management API-sémák listázása.
az apim api schema show	Egy API Management API-séma részleteinek megjelenítése.
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 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

Hozzon létre egy API-sémát.

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

--api-id

Annak az API-nak az egyedi neve, amelyhez sémát kell létrehozni.

--resource-group -g

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

--schema-id

A létrehozandó API-séma egyedi neve.

--schema-type

Séma típusa (pl. application/json, application/vnd.ms-azure-apim.graphql.schema).

--service-name -n

A API Management szolgáltatáspéldány neve.

Opcionális paraméterek

--no-wait

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

--resource-type

Az erőforrás típusa. Például"Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts".

--schema-content

A sémát képviselő dokumentumot meghatározó Json-sztring.

--schema-name

A sémaerőforrás neve.

--schema-path

Az API sémájának importálásához megadott fájlelérési út.

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.

--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 használatával az account set -s NAME_OR_IDkonfigurálhatja.

--verbose

Növelje a naplózás részletességét. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az apim api schema delete

Töröljön egy API Management API-sémát.

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

API-azonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat utótagja ;rev=n, ahol n a változat száma.

--resource-group -g

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

--schema-id

Sémaazonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat utótagja ;rev=n, ahol n a változat száma.

--service-name -n

A API Management szolgáltatáspéldány neve.

Opcionális paraméterek

--if-match

Az entitás ETagje.

--no-wait

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

--yes -y

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

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.

--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 használatával az account set -s NAME_OR_IDkonfigurálhatja.

--verbose

Növelje a naplózás részletességét. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az apim api schema get-etag

Egy 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ás-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-id

API-azonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat utótagja ;rev=n, ahol n a változat száma.

--resource-group -g

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

--schema-id

Sémaazonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat utótagja ;rev=n, ahol n a változat száma.

--service-name -n

A API Management szolgáltatáspéldány neve.

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.

--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 használatával az account set -s NAME_OR_IDkonfigurálhatja.

--verbose

Növelje a naplózás részletességét. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az apim api schema list

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

Lekérheti az API-azonosítóhoz társított sémák listáját.

az apim api schema list --service-name MyApim -g MyResourceGroup --api-id MyApi

Kötelező paraméterek

--api-id

API-azonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat utótagja ;rev=n, ahol n a változat száma.

--resource-group -g

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

--service-name -n

A API Management szolgáltatáspéldány neve.

Opcionális paraméterek

--filter-display-name

API-k szűrése a displayName alapján.

--skip

Kihagyandó rekordok száma.

--top

A visszaadandó rekordok száma.

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.

--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 használatával az account set -s NAME_OR_IDkonfigurálhatja.

--verbose

Növelje a naplózás részletességét. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az apim api schema show

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

API-azonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat utótagja ;rev=n, ahol n a változat száma.

--resource-group -g

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

--schema-id

Sémaazonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat utótagja ;rev=n, ahol n a változat száma.

--service-name -n

A API Management szolgáltatáspéldány neve.

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.

--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 használatával az account set -s NAME_OR_IDkonfigurálhatja.

--verbose

Növelje a naplózás részletességét. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az apim api schema wait

Helyezze a parancssori felületet várakozó állapotba, amíg egy APIM API-séma valamelyik feltétele nem 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ó állapotba, amíg egy apim API-séma valamely feltétele nem teljesül.

az apim api schema wait --created --api-id MyApi --name MyApim --schema-id schemaId -g MyResourceGroup

Kötelező paraméterek

--api-id

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 utótagja ;rev=n, ahol n a változat száma.

--name -n

Az API Management szolgáltatáspéldány neve.

--resource-group -g

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

--schema-id

Sémaazonosító azonosítója. Egyedinek kell lennie az aktuális API Management szolgáltatáspéldányban.

Opcionális paraméterek

--created

Várjon, amíg létre nem jön a "provisioningState" a "Succeeded" helyen.

--custom

Várja meg, amíg a feltétel megfelel egy egyéni JMESPath-lekérdezésnek. Például provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running"?.

--deleted

Várja meg a törlést.

--exists

Várjon, amíg az erőforrás létezik.

--interval

Lekérdezési időköz másodpercben.

alapértelmezett érték: 30

--timeout

Maximális várakozás másodpercben.

alapértelmezett érték: 3600

--updated

Várjon, amíg frissül a provisioningState a "Succeeded" (Sikeres) időpontban.

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.

--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 használatával az account set -s NAME_OR_IDkonfigurálhatja.

--verbose

Növelje a naplózás részletességét. Használja a --debug parancsot a teljes hibakeresési naplókhoz.