az apic metadata

Note

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.	Extension	GA
az apic metadata delete	Odstraňte zadané schéma metadat.	Extension	GA
az apic metadata export	Exportuje schéma metadat.	Extension	GA
az apic metadata list	Vypíše kolekci schémat metadat.	Extension	GA
az apic metadata show	Získejte podrobnosti o schématu metadat.	Extension	GA
az apic metadata update	Aktualizujte existující schéma metadat.	Extension	GA

az apic metadata create

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

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

Příklady

Vytvoření metadat – příklad 1

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

Vytvoření metadat – příklad 2

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

Příklad vytvoření metadat pomocí schématu souborů JSON a přiřazení

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

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.

Vlastnost	Hodnota
Skupina parametrů:	Properties Arguments

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

Vlastnost	Hodnota
Skupina parametrů:	Properties Arguments

--service-name -n

Název služby Azure API Center.

Globální parametry

--debug

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

Vlastnost	Hodnota
Default value:	False

--help -h

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

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost	Hodnota
Default value:	False

--output -o

Výstupní formát

Vlastnost	Hodnota
Default value:	json
Přípustné hodnoty:	json, jsonc, none, table, tsv, yaml, yamlc

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

Vlastnost	Hodnota
Default value:	False

az apic metadata delete

Odstraňte zadané schéma metadat.

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

Příklady

Odstranit schéma metadat

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

Odstranění schématu

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

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--ids

Jedno nebo více ID prostředků (oddělené 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 buď argumenty --ids, nebo jiné argumenty 'ID prostředku'.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--metadata-name

Název schématu metadat.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--resource-group -g

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

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--service-name -n

Název služby Azure API Center.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--subscription

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

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--yes -y

Nevyzývejte k potvrzení.

Vlastnost	Hodnota
Default value:	False

Globální parametry

--debug

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

Vlastnost	Hodnota
Default value:	False

--help -h

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

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost	Hodnota
Default value:	False

--output -o

Výstupní formát

Vlastnost	Hodnota
Default value:	json
Přípustné hodnoty:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Vlastnost	Hodnota
Default value:	False

az apic metadata export

Exportuje schéma metadat.

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říklady

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

az apic metadata export -g api-center-test -n 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 -n 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 -n contosoeuap --assignments environment --file-name filename.json

Exportovat pouze vlastní schéma metadat

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

Povinné parametry

--assignments

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

Vlastnost	Hodnota
Skupina parametrů:	Payload Arguments
Přípustné hodnoty:	api, deployment, environment

--file-name

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

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--custom-metadata-only

Exportujte pouze vlastní metadata.

Vlastnost	Hodnota
Přípustné hodnoty:	0, 1, f, false, n, no, t, true, y, yes

--ids

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--no-wait

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

Vlastnost	Hodnota
Přípustné 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>.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--service-name -n

Název služby API Center.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--subscription

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

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

Globální parametry

--debug

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

Vlastnost	Hodnota
Default value:	False

--help -h

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

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost	Hodnota
Default value:	False

--output -o

Výstupní formát

Vlastnost	Hodnota
Default value:	json
Přípustné hodnoty:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Vlastnost	Hodnota
Default value:	False

az apic metadata list

Vypíše kolekci schémat metadat.

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

Příklady

Výpis schémat

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

Povinné parametry

--resource-group -g

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

--service-name -n

Název služby Azure API Center.

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--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. Pokud chcete pokračovat ve stránkování, zadejte hodnotu tokenu v --next-token argumentu následného příkazu.

Vlastnost	Hodnota
Skupina parametrů:	Pagination Arguments

--next-token

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

Vlastnost	Hodnota
Skupina parametrů:	Pagination Arguments

Globální parametry

--debug

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

Vlastnost	Hodnota
Default value:	False

--help -h

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

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost	Hodnota
Default value:	False

--output -o

Výstupní formát

Vlastnost	Hodnota
Default value:	json
Přípustné hodnoty:	json, jsonc, none, table, tsv, yaml, yamlc

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

Vlastnost	Hodnota
Default value:	False

az apic metadata show

Získejte podrobnosti o schématu metadat.

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

Příklady

Zobrazit podrobnosti schématu 1

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

Zobrazit podrobnosti schématu 2

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

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--ids

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--metadata-name

Název schématu metadat.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--resource-group -g

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

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--service-name -n

Název služby Azure API Center.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--subscription

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

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

Globální parametry

--debug

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

Vlastnost	Hodnota
Default value:	False

--help -h

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

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost	Hodnota
Default value:	False

--output -o

Výstupní formát

Vlastnost	Hodnota
Default value:	json
Přípustné hodnoty:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Vlastnost	Hodnota
Default value:	False

az apic metadata update

Aktualizujte existující schéma metadat.

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říklady

Aktualizace schématu

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

Aktualizace schématu pomocí souboru JSON schématu

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

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--add

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

Vlastnost	Hodnota
Skupina parametrů:	Generic Update Arguments

--assignments

Vlastnost	Hodnota
Skupina parametrů:	Properties Arguments

--force-string

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

Vlastnost	Hodnota
Skupina parametrů:	Generic Update Arguments
Přípustné hodnoty:	0, 1, f, false, n, no, t, true, y, yes

--ids

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--metadata-name

Název schématu metadat.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--remove

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

Vlastnost	Hodnota
Skupina parametrů:	Generic Update Arguments

--resource-group -g

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

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--schema

Schéma YAML definující typ.

Vlastnost	Hodnota
Skupina parametrů:	Properties Arguments

--service-name -n

Název služby Azure API Center.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--set

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

Vlastnost	Hodnota
Skupina parametrů:	Generic Update Arguments

--subscription

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

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

Globální parametry

--debug

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

Vlastnost	Hodnota
Default value:	False

--help -h

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

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost	Hodnota
Default value:	False

--output -o

Výstupní formát

Vlastnost	Hodnota
Default value:	json
Přípustné hodnoty:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Vlastnost	Hodnota
Default value:	False

Váš názor

Byla tato stránka užitečná?

Sdílet prostřednictvím

az apic metadata

Příkazy

az apic metadata create

Příklady

Povinné parametry

az apic metadata delete

Příklady

Volitelné parametry

az apic metadata export

Příklady

Povinné parametry

Volitelné parametry

az apic metadata list

Příklady

Povinné parametry

Volitelné parametry

az apic metadata show

Příklady

Volitelné parametry

az apic metadata update

Příklady

Volitelné parametry

Váš názor