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

az apic metadata

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

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

Parancsok

Name Description Típus Állapot
az apic metadata create

Hozzon létre egy új metaadat-sémát, vagy frissítsen egy meglévő metaadatsémát.

 Mellék FE
az apic metadata delete

A megadott metaadat-séma törlése.

 Mellék FE
az apic metadata export

Exportálja a metaadat-sémát.

 Mellék FE
az apic metadata list

Metaadat-sémák gyűjteményének listázása.

 Mellék FE
az apic metadata show

A metaadatséma részleteinek lekérése.

 Mellék FE
az apic metadata update

Meglévő metaadat-séma frissítése.

 Mellék FE

az apic metadata create

Hozzon létre egy új metaadat-sémát, vagy frissítsen egy meglévő metaadatsémát.

az apic metadata create --assignments
                        --metadata-name
                        --resource-group
                        --schema
                        --service-name

Példák

Metaadatok létrehozása – 1. példa

az apic metadata create --resource-group api-center-test --service-name contoso --metadata-name "test1" --schema '{"type":"string", "title":"First name", "pattern": "^[a-zA-Z0-9]+$"}' --assignments '[{entity:api,required:true,deprecated:false}]'

Metaadatok létrehozása – 2. példa

az apic metadata create --resource-group api-center-test --service-name contoso  --metadata-name testregion --schema '{"type":"string","title":"testregion","oneOf":[{"const":"Region1","description":""},{"const":"Region2","description":""},{"const":"Region3","description":""}]}' --assignments '[{entity:api,required:true,deprecated:false},{entity:environment,required:true,deprecated:false}]'

Kötelező paraméterek

--assignments

Meghatározza az egyéni metaadatok hozzárendelési hatókörét, például: "[{entity:api,required:true,deprecated:false}]". Az elérhető entitásértékek a következők: api, deployment, environment. 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.

--metadata-name

A metaadat-séma neve.

--resource-group -g

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

--schema

A típust meghatározó JSON-séma.

--service-name -n

Az Azure API Center szolgáltatás 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.

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

A megadott metaadat-séma törlése.

az apic metadata delete [--ids]
                        [--metadata-name]
                        [--resource-group]
                        [--service-name]
                        [--subscription]
                        [--yes]

Példák

Metaadat-séma törlése

az apic metadata delete --resource-group api-center-test --service-name contoso --metadata-name "test1"

Séma törlése

az apic metadata delete -g api-center-test -n contosoeuap --metadata-name "approver"

Opcionális paraméterek

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

--metadata-name

A metaadat-séma neve.

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

Exportálja a metaadat-sémát.

az apic metadata export --assignments {api, deployment, environment}
                        --file-name
                        [--ids]
                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                        [--resource-group]
                        [--service-name]
                        [--subscription]

Példák

Api-hoz rendelt metaadat-séma exportálása

az apic metadata export -g api-center-test -n contosoeuap --assignments api --file-name filename.json

Az üzembe helyezéshez hozzárendelt metaadat-séma exportálása

az apic metadata export -g api-center-test -n contosoeuap --assignments deployment --file-name filename.json

A környezethez rendelt metaadat-séma exportálása

az apic metadata export -g api-center-test -n contosoeuap --assignments environment --file-name filename.json

Kötelező paraméterek

--assignments

Egy entitás, amelyhez a metaadatséma kérhető.

Elfogadott értékek: api, deployment, environment
--file-name

Annak a fájlnak a neve, ahová exportálni szeretné a metaadat-sémát.

Opcionális paraméterek

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

--no-wait

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

Elfogadott értékek: 0, 1, f, false, n, no, t, true, y, yes
--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 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 metadata list

Metaadat-sémák gyűjteményének listázása.

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

Példák

Sémák listázása

az apic metadata list -g api-center-test -n contosoeuap

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

A metaadatséma részleteinek lekérése.

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

Példák

Séma részleteinek megjelenítése 1

az apic metadata show -g api-center-test -n contosoeuap --metadata-name approver

Séma részleteinek megjelenítése 2

az apic metadata show --resource-group api-center-test --service-name contoso --metadata-name "testchoices"

Opcionális paraméterek

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

--metadata-name

A metaadat-séma neve.

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

Meglévő metaadat-séma frissítése.

az apic metadata update [--add]
                        [--assignments]
                        [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                        [--ids]
                        [--metadata-name]
                        [--remove]
                        [--resource-group]
                        [--schema]
                        [--service-name]
                        [--set]
                        [--subscription]

Példák

Séma frissítése

az apic metadata update --resource-group api-center-test --service-name contoso --metadata-name "test1" --schema '{"type":"string", "title":"Last name", "pattern": "^[a-zA-Z0-9]+$"}'

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

--assignments

Meghatározza az egyéni metaadatok hozzárendelési hatókörét, például: "[{entity:api,required:true,deprecated:false}]". Az elérhető entitásértékek a következők: api, deployment, environment. 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

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.

--metadata-name

A metaadat-séma neve.

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

--schema

A típust meghatározó YAML-séma.

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

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.