Dela via

az apic metadata

  • Referens

Not

Den här referensen är en del av apic-extension-tillägget för Azure CLI (version 2.57.0 eller senare). Tillägget installeras automatiskt första gången du kör ett az apic metadata kommando. Läs mer om tillägg.

Kommandon för att hantera metadatascheman i API Center.

Kommandon

Name Description Typ Status
az apic metadata create

Skapa ett nytt metadataschema eller uppdatera ett befintligt metadataschema.

 Förlängning GA
az apic metadata delete

Ta bort angivet metadataschema.

 Förlängning GA
az apic metadata export

Exporterar metadataschemat.

 Förlängning GA
az apic metadata list

Lista en samling metadatascheman.

 Förlängning GA
az apic metadata show

Hämta information om metadataschemat.

 Förlängning GA
az apic metadata update

Uppdatera befintligt metadataschema.

 Förlängning GA

az apic metadata create

Skapa ett nytt metadataschema eller uppdatera ett befintligt metadataschema.

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

Exempel

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

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

Skapa metadata med json-filschema och tilldelningsexempel

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

Obligatoriska parametrar

--assignments

Definierar tilldelningsomfånget för anpassade metadata, t.ex. "[{entity:api,required:true,deprecated:false}]". De tillgängliga entitetsvärdena är: api, distribution, miljö. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

--metadata-name

Namnet på metadataschemat.

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--schema

JSON-schema som definierar typen.

--service-name -n

Namnet på Azure API Center-tjänsten.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer information och exempel finns i http://jmespath.org/.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az apic metadata delete

Ta bort angivet metadataschema.

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

Exempel

Ta bort metadataschema

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

Ta bort schema

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

Valfria parametrar

--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--metadata-name

Namnet på metadataschemat.

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--service-name -n

Namnet på Azure API Center-tjänsten.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--yes -y

Fråga inte efter bekräftelse.

Standardvärde: False
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer information och exempel finns i http://jmespath.org/.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az apic metadata export

Exporterar metadataschemat.

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]

Exempel

Exportera metadataschema som tilldelats api

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

Exportera metadataschema som tilldelats distribution

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

Exportera metadataschema som tilldelats miljön

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

Exportera endast anpassat metadataschema

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

Obligatoriska parametrar

--assignments

En entitet som metadataschemat begärs för.

Godkända värden: api, deployment, environment
--file-name

Namnet på filen där metadataschemat ska exporteras till.

Valfria parametrar

--custom-metadata-only

Exportera endast anpassade metadata.

Godkända värden: 0, 1, f, false, n, no, t, true, y, yes
--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

Godkända värden: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--service-name -n

Namnet på API Center-tjänsten.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer information och exempel finns i http://jmespath.org/.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az apic metadata list

Lista en samling metadatascheman.

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

Exempel

Lista scheman

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

Obligatoriska parametrar

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--service-name -n

Namnet på Azure API Center-tjänsten.

Valfria parametrar

--filter

OData-filterparameter.

--max-items

Totalt antal objekt som ska returneras i kommandots utdata. Om det totala antalet tillgängliga objekt är mer än det angivna värdet anges en token i kommandots utdata. Om du vill återuppta sidnumreringen anger du tokenvärdet i --next-token argument för ett efterföljande kommando.

--next-token

Token för att ange var sidnumrering ska börja. Detta är tokenvärdet från ett tidigare trunkerat svar.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer information och exempel finns i http://jmespath.org/.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az apic metadata show

Hämta information om metadataschemat.

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

Exempel

Visa schemainformation 1

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

Visa schemainformation 2

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

Valfria parametrar

--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--metadata-name

Namnet på metadataschemat.

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--service-name -n

Namnet på Azure API Center-tjänsten.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer information och exempel finns i http://jmespath.org/.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az apic metadata update

Uppdatera befintligt metadataschema.

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]

Exempel

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

Uppdatera schema med hjälp av schema-json-fil

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

Valfria parametrar

--add

Lägg till ett objekt i en lista över objekt genom att ange en sökväg och nyckelvärdepar. Exempel: --add property.listProperty <key=value, string or JSON string>.

--assignments

Definierar tilldelningsomfånget för anpassade metadata, t.ex. "[{entity:api,required:true,deprecated:false}]". De tillgängliga entitetsvärdena är: api, distribution, miljö. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

--force-string

När du använder "set" eller "add" bevarar du strängliteraler i stället för att försöka konvertera till JSON.

Godkända värden: 0, 1, f, false, n, no, t, true, y, yes
--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--metadata-name

Namnet på metadataschemat.

--remove

Ta bort en egenskap eller ett element från en lista. Exempel: --remove property.list <indexToRemove> ELLER --remove propertyToRemove.

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--schema

YAML-schema som definierar typen.

--service-name -n

Namnet på Azure API Center-tjänsten.

--set

Uppdatera ett objekt genom att ange en egenskapssökväg och ett värde som ska anges. Exempel: --set property1.property2=<value>.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer information och exempel finns i http://jmespath.org/.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.