Sdílet prostřednictvím

az apic metadata

  • Reference

Poznámka:

Tento odkaz je součástí rozšíření apic-extension pro Azure CLI (verze 2.57.0 nebo vyšší). Rozšíření se automaticky nainstaluje při prvním spuštění příkazu az apic metadata . Přečtěte si další informace o rozšířeních.

Příkazy pro správu schémat metadat v Centru rozhraní API

Příkazy

Name Description Typ Stav
az apic metadata create

Vytvořte nové schéma metadat nebo aktualizujte existující schéma metadat.

 Rozšíření GA
az apic metadata delete

Odstraňte zadané schéma metadat.

 Rozšíření GA
az apic metadata export

Exportuje schéma metadat.

 Rozšíření GA
az apic metadata list

Vypíše kolekci schémat metadat.

 Rozšíření GA
az apic metadata show

Získejte podrobnosti o schématu metadat.

 Rozšíření GA
az apic metadata update

Aktualizujte existující schéma metadat.

 Rozšíření GA

az apic metadata create

Vytvořte nové schéma metadat nebo aktualizujte existující schéma metadat.

az apic metadata create --assignments
                        --metadata-schema
                        --resource-group
                        --schema
                        --service
                        [--file-name]

Příklady

Vytvoření metadat – příklad 1

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

Vytvoření metadat – příklad 2

az apic metadata create --resource-group api-center-test --service-name contoso  --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}]'

Povinné parametry

--assignments

Definuje obor přiřazení pro vlastní metadata, například "[{entity:api,required:true,zastaralé:false}]". Dostupné hodnoty entit jsou: api, nasazení, prostředí. Podpora zkratky syntaxe, json-file a yaml-file Zkuste "??" zobrazit více.

--metadata-schema --metadata-schema-name --name

Název schématu metadat.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--schema

Schéma JSON definující typ.

--service --service-name -s

Název služby API Center.

Volitelné parametry

--file-name

Název souboru, který obsahuje schéma metadat.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

přijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az apic metadata delete

Odstraňte zadané schéma metadat.

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

Příklady

Odstranit schéma metadat

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

Odstranění schématu

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

Volitelné parametry

--ids

Jedno nebo více ID prostředků (oddělených mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat argumenty --ids nebo jiné argumenty ID prostředku.

--metadata-schema --metadata-schema-name --name

Název schématu metadat.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--service --service-name -s

Název služby API Center.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--yes -y

Nezotvádejte výzvu k potvrzení.

výchozí hodnota: False
Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

přijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az apic metadata export

Exportuje schéma metadat.

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

Příklady

Export schématu metadat přiřazeného k rozhraní API

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

Export schématu metadat přiřazeného k nasazení

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

Export schématu metadat přiřazeného k prostředí

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

Povinné parametry

--assignments

Pro entitu je požadováno schéma metadat.

přijímané hodnoty: api, deployment, environment
--file-name

Název souboru, do kterého chcete exportovat schéma metadat.

Volitelné parametry

--ids

Jedno nebo více ID prostředků (oddělených mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat argumenty --ids nebo jiné argumenty ID prostředku.

--name --service --service-name -s

Název služby API Center.

--no-wait

Nečekejte na dokončení dlouhotrvající operace.

přijímané hodnoty: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

přijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az apic metadata list

Vypíše kolekci schémat metadat.

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

Příklady

Výpis schémat

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

Povinné parametry

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--service --service-name -s

Název služby API Center.

Volitelné parametry

--filter

Parametr filtru OData.

--max-items

Celkový počet položek, které se mají vrátit ve výstupu příkazu Pokud je celkový počet dostupných položek větší než zadaná hodnota, zobrazí se ve výstupu příkazu token. Chcete-li obnovit stránkování, zadejte hodnotu tokenu v --next-token argumentu následného příkazu.

--next-token

Token určující, kde se má stránkování spustit. Toto je hodnota tokenu z dříve zkrácené odpovědi.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

přijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az apic metadata show

Získejte podrobnosti o schématu metadat.

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

Příklady

Zobrazit podrobnosti schématu 1

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

Zobrazit podrobnosti schématu 2

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

Volitelné parametry

--ids

Jedno nebo více ID prostředků (oddělených mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat argumenty --ids nebo jiné argumenty ID prostředku.

--metadata-schema --metadata-schema-name --name

Název schématu metadat.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--service --service-name -s

Název služby API Center.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

přijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az apic metadata update

Aktualizujte existující schéma metadat.

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

Příklady

Aktualizace schématu

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

Volitelné parametry

--add

Přidejte objekt do seznamu objektů zadáním párů cest a klíč-hodnota. Příklad: --add property.listProperty <key=value, řetězec nebo řetězec> JSON.

--assignments

Definuje obor přiřazení pro vlastní metadata, například "[{entity:api,required:true,zastaralé:false}]". Dostupné hodnoty entit jsou: api, nasazení, prostředí. Podpora zkratky syntaxe, json-file a yaml-file Zkuste "??" zobrazit více.

--file-name

Název souboru, který obsahuje schéma metadat.

--force-string

Při použití set nebo add zachovávejte řetězcové literály místo pokusu o převod na JSON.

přijímané hodnoty: 0, 1, f, false, n, no, t, true, y, yes
--ids

Jedno nebo více ID prostředků (oddělených mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat argumenty --ids nebo jiné argumenty ID prostředku.

--metadata-schema --metadata-schema-name --name

Název schématu metadat.

--remove

Odeberte vlastnost nebo prvek ze seznamu. Příklad: --remove property.list OR --remove propertyToRemove.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--schema

Schéma YAML definující typ.

--service --service-name -s

Název služby API Center.

--set

Aktualizujte objekt zadáním cesty vlastnosti a hodnoty, která se má nastavit. Příklad: --set property1.property2=.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

přijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.