az apic metadata

Note

This reference is part of the apic-extension extension for the Azure CLI (version 2.57.0 or higher). A bővítmény automatikusan telepíti az az apic metadata parancs első futtatásakor. Learn more about extensions.

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.	Extension	GA
az apic metadata delete	A megadott metaadat-séma törlése.	Extension	GA
az apic metadata export	Exportálja a metaadat-sémát.	Extension	GA
az apic metadata list	Metaadat-sémák gyűjteményének listázása.	Extension	GA
az apic metadata show	A metaadatséma részleteinek lekérése.	Extension	GA
az apic metadata update	Meglévő metaadat-séma frissítése.	Extension	GA

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

Metaadatok létrehozása json-fájlséma és -hozzárendelések használatával

az apic metadata create --resource-group api-center-test --service-name contoso --metadata-name "test" --schema '@schema.json' --assignments '@assignments.json'

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.

Tulajdonság	Érték
Parameter group:	Properties Arguments

--metadata-name

A metaadat-séma neve.

--resource-group -g

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

--schema

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

Tulajdonság	Érték
Parameter group:	Properties Arguments

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

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

Output format.

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

Delete schema

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

Opcionális paraméterek

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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
Parameter group:	Resource Id Arguments

--metadata-name

A metaadat-séma neve.

Tulajdonság	Érték
Parameter group:	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
Parameter group:	Resource Id Arguments

--service-name -n

Az Azure API Center szolgáltatás neve.

Tulajdonság	Érték
Parameter group:	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
Parameter group:	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

Output format.

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

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

az apic metadata export --assignments {api, deployment, environment}
                        --file-name
                        [--custom-metadata-only {0, 1, f, false, n, no, t, true, y, yes}]
                        [--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

Csak egyéni metaadat-séma exportálása

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

Kötelező paraméterek

--assignments

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

Tulajdonság	Érték
Parameter group:	Payload Arguments
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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--custom-metadata-only

Csak egyéni metaadatok exportálása.

Tulajdonság	Érték
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
Parameter group:	Resource Id Arguments

--no-wait

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

Tulajdonság	Érték
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 a az configure --defaults group=<name>használatával konfigurálhatja.

Tulajdonság	Érték
Parameter group:	Resource Id Arguments

--service-name -n

Az API Center szolgáltatás neve.

Tulajdonság	Érték
Parameter group:	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
Parameter group:	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

Output format.

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

List schemas

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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
Parameter group:	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
Parameter group:	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

Output format.

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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
Parameter group:	Resource Id Arguments

--metadata-name

A metaadat-séma neve.

Tulajdonság	Érték
Parameter group:	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
Parameter group:	Resource Id Arguments

--service-name -n

Az Azure API Center szolgáltatás neve.

Tulajdonság	Érték
Parameter group:	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
Parameter group:	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

Output format.

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

Update schema

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]+$"}'

Séma frissítése séma json-fájllal

az apic metadata update --resource-group api-center-test --service-name contoso --metadata-name "test1" --schema '@schema.json'

Opcionális paraméterek

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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
Parameter group:	Generic Update Arguments

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

Tulajdonság	Érték
Parameter group:	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
Parameter group:	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
Parameter group:	Resource Id Arguments

--metadata-name

A metaadat-séma neve.

Tulajdonság	Érték
Parameter group:	Resource Id 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
Parameter group:	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
Parameter group:	Resource Id Arguments

--schema

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

Tulajdonság	Érték
Parameter group:	Properties Arguments

--service-name -n

Az Azure API Center szolgáltatás neve.

Tulajdonság	Érték
Parameter group:	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
Parameter group:	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
Parameter group:	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

Output format.

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