Delen via

az apic metadata

  • Referentie

Notitie

Deze verwijzing maakt deel uit van de extensie apic-extension voor de Azure CLI (versie 2.57.0 of hoger). De extensie installeert automatisch de eerste keer dat u een az apic metadata-opdracht uitvoert. Meer informatie over extensies.

Opdrachten voor het beheren van metagegevensschema's in API Center.

Opdracht

Name Description Type Status
az apic metadata create

Maak een nieuw metagegevensschema of werk een bestaand metagegevensschema bij.

 Toestel GA
az apic metadata delete

Verwijder het opgegeven metagegevensschema.

 Toestel GA
az apic metadata export

Hiermee exporteert u het metagegevensschema.

 Toestel GA
az apic metadata list

Een verzameling metagegevensschema's weergeven.

 Toestel GA
az apic metadata show

Details van het metagegevensschema ophalen.

 Toestel GA
az apic metadata update

Het bestaande metagegevensschema bijwerken.

 Toestel GA

az apic metadata create

Maak een nieuw metagegevensschema of werk een bestaand metagegevensschema bij.

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

Voorbeelden

Voorbeeld van metagegevens maken 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}]'

Voorbeeld van metagegevens maken 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}]'

Vereiste parameters

--assignments

Definieert het toewijzingsbereik voor de aangepaste metagegevens, bijvoorbeeld '[{entity:api,required:true,afgeschaft:false}]'. De beschikbare entiteitswaarden zijn: API, implementatie, omgeving. Ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

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

De naam van het metagegevensschema.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--schema

JSON-schema waarmee het type wordt gedefinieerd.

--service --service-name -s

De naam van de API Center-service.

Optionele parameters

--file-name

De naam van het bestand dat het metagegevensschema bevat.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az apic metadata delete

Verwijder het opgegeven metagegevensschema.

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

Voorbeelden

Metagegevensschema verwijderen

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

Schema verwijderen

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

Optionele parameters

--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. Geef de argumenten --id's of andere resource-id's op.

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

De naam van het metagegevensschema.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--service --service-name -s

De naam van de API Center-service.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--yes -y

Niet vragen om bevestiging.

standaardwaarde: False
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az apic metadata export

Hiermee exporteert u het metagegevensschema.

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]

Voorbeelden

Metagegevensschema exporteren dat is toegewezen aan api

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

Metagegevensschema exporteren dat is toegewezen aan implementatie

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

Metagegevensschema exporteren dat is toegewezen aan de omgeving

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

Vereiste parameters

--assignments

Een entiteit waarvoor het metagegevensschema is aangevraagd.

geaccepteerde waarden: api, deployment, environment
--file-name

De naam van het bestand waarnaar het metagegevensschema moet worden geëxporteerd.

Optionele parameters

--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. Geef de argumenten --id's of andere resource-id's op.

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

De naam van de API Center-service.

--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

geaccepteerde waarden: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az apic metadata list

Een verzameling metagegevensschema's weergeven.

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

Voorbeelden

Schema's weergeven

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

Vereiste parameters

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--service --service-name -s

De naam van de API Center-service.

Optionele parameters

--filter

OData-filterparameter.

--max-items

Totaal aantal items dat moet worden geretourneerd in de uitvoer van de opdracht. Als het totale aantal beschikbare items groter is dan de opgegeven waarde, wordt een token opgegeven in de uitvoer van de opdracht. Als u paginering wilt hervatten, geeft u de tokenwaarde op in --next-token het argument van een volgende opdracht.

--next-token

Token om op te geven waar paginering moet worden gestart. Dit is de tokenwaarde van een eerder afgekapt antwoord.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az apic metadata show

Details van het metagegevensschema ophalen.

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

Voorbeelden

Schemadetails weergeven 1

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

Schemadetails weergeven 2

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

Optionele parameters

--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. Geef de argumenten --id's of andere resource-id's op.

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

De naam van het metagegevensschema.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--service --service-name -s

De naam van de API Center-service.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az apic metadata update

Het bestaande metagegevensschema bijwerken.

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]

Voorbeelden

Schema bijwerken

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

Optionele parameters

--add

Voeg een object toe aan een lijst met objecten door een pad- en sleutelwaardeparen op te geven. Voorbeeld: --add property.listProperty <key=value, string of JSON string>.

--assignments

Definieert het toewijzingsbereik voor de aangepaste metagegevens, bijvoorbeeld '[{entity:api,required:true,afgeschaft:false}]'. De beschikbare entiteitswaarden zijn: API, implementatie, omgeving. Ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

--file-name

De naam van het bestand dat het metagegevensschema bevat.

--force-string

Wanneer u 'set' of 'toevoegen' gebruikt, behoudt u letterlijke tekenreeksen in plaats van te converteren naar JSON.

geaccepteerde waarden: 0, 1, f, false, n, no, t, true, y, yes
--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. Geef de argumenten --id's of andere resource-id's op.

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

De naam van het metagegevensschema.

--remove

Een eigenschap of element uit een lijst verwijderen. Voorbeeld: --remove property.list OR --remove propertyToRemove.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--schema

YAML-schema waarmee het type wordt gedefinieerd.

--service --service-name -s

De naam van de API Center-service.

--set

Werk een object bij door een eigenschapspad en waarde op te geven die u wilt instellen. Voorbeeld: --set property1.property2=.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.