az apic api definition

Note

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 API definition opdracht uitvoert. Meer informatie over uitbreidingen.

Opdrachten voor het beheren van API-definities in API Center.

Opdracht

Name	Description	Type	Status
az apic api definition create	Maak een nieuwe API-definitie of werk een bestaande API-definitie bij.	Extension	GA
az apic api definition delete	Verwijder de opgegeven API-definitie.	Extension	GA
az apic api definition export-specification	Hiermee exporteert u de API-specificatie.	Extension	GA
az apic api definition import-specification	Hiermee importeert u de API-specificatie.	Extension	GA
az apic api definition list	Een verzameling API-definities weergeven.	Extension	GA
az apic api definition show	Details van de API-definitie ophalen.	Extension	GA
az apic api definition update	Bestaande API-definitie bijwerken.	Extension	GA

az apic api definition create

Maak een nieuwe API-definitie of werk een bestaande API-definitie bij.

az apic api definition create --api-id
                              --definition-id
                              --resource-group
                              --service-name
                              --title
                              --version-id
                              [--description]

Voorbeelden

API-definitie maken

az apic api definition create -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi" --title "OpenAPI"

Vereiste parameters

--api-id

De id van de API.

--definition-id

De id van de API-definitie.

--resource-group -g

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

--service-name -n

De naam van de Azure API Center-service.

--title

API-versie.

Eigenschap	Waarde
Parametergroep:	Properties Arguments

--version-id

De id van de API-versie.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--description

Beschrijving van API-definitie.

Eigenschap	Waarde
Parametergroep:	Properties Arguments

Globale parameters

--debug

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

Eigenschap	Waarde
Default value:	False

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap	Waarde
Default value:	False

--output -o

Uitvoerindeling.

Eigenschap	Waarde
Default value:	json
Geaccepteerde waarden:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

Naam of id van 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.

Eigenschap	Waarde
Default value:	False

az apic api definition delete

Verwijder de opgegeven API-definitie.

az apic api definition delete [--api-id]
                              [--definition-id]
                              [--ids]
                              [--resource-group]
                              [--service-name]
                              [--subscription]
                              [--version-id]
                              [--yes]

Voorbeelden

API-definitie verwijderen

az apic api definition delete -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi"

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--api-id

De id van de API.

Eigenschap	Waarde
Parametergroep:	Resource Id Arguments

--definition-id

De id van de API-definitie.

Eigenschap	Waarde
Parametergroep:	Resource Id Arguments

--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. U moet ofwel --id's of andere 'Resource Id'-argumenten opgeven.

Eigenschap	Waarde
Parametergroep:	Resource Id Arguments

--resource-group -g

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

Eigenschap	Waarde
Parametergroep:	Resource Id Arguments

--service-name -n

De naam van de Azure API Center-service.

Eigenschap	Waarde
Parametergroep:	Resource Id Arguments

--subscription

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

Eigenschap	Waarde
Parametergroep:	Resource Id Arguments

--version-id

De id van de API-versie.

Eigenschap	Waarde
Parametergroep:	Resource Id Arguments

--yes -y

Niet vragen om bevestiging.

Eigenschap	Waarde
Default value:	False

Globale parameters

--debug

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

Eigenschap	Waarde
Default value:	False

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap	Waarde
Default value:	False

--output -o

Uitvoerindeling.

Eigenschap	Waarde
Default value:	json
Geaccepteerde waarden:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Eigenschap	Waarde
Default value:	False

az apic api definition export-specification

Hiermee exporteert u de API-specificatie.

az apic api definition export-specification --file-name
                                            [--api-id]
                                            [--definition-id]
                                            [--ids]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--service-name]
                                            [--subscription]
                                            [--version-id]

Voorbeelden

Exportspecificatie

az apic api definition export-specification -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id default --file-name filename.json

Vereiste parameters

--file-name

Naam van het bestand waarnaar de specificatie moet worden geëxporteerd.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--api-id

De id van de API.

Eigenschap	Waarde
Parametergroep:	Resource Id Arguments

--definition-id

De id van de API-definitie.

Eigenschap	Waarde
Parametergroep:	Resource Id Arguments

--ids

Eigenschap	Waarde
Parametergroep:	Resource Id Arguments

--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

Eigenschap	Waarde
Geaccepteerde waarden:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

Eigenschap	Waarde
Parametergroep:	Resource Id Arguments

--service-name -n

De naam van de Azure API Center-service.

Eigenschap	Waarde
Parametergroep:	Resource Id Arguments

--subscription

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

Eigenschap	Waarde
Parametergroep:	Resource Id Arguments

--version-id

De id van de API-versie.

Eigenschap	Waarde
Parametergroep:	Resource Id Arguments

Globale parameters

--debug

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

Eigenschap	Waarde
Default value:	False

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap	Waarde
Default value:	False

--output -o

Uitvoerindeling.

Eigenschap	Waarde
Default value:	json
Geaccepteerde waarden:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Eigenschap	Waarde
Default value:	False

az apic api definition import-specification

Hiermee importeert u de API-specificatie.

az apic api definition import-specification --format {inline, link}
                                            --specification
                                            --value
                                            [--api-id]
                                            [--definition-id]
                                            [--ids]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--service-name]
                                            [--subscription]
                                            [--version-id]

Voorbeelden

Voorbeeld van importspecificatie 1

az apic api definition import-specification -g api-center-test -n contosoeuap --api-id echo-api-2 --version-id 2023-08-01 --definition-id openapi3 --format "inline" --value '{"openapi":"3.0.1","info":{"title":"httpbin.org","description":"API Management facade for a very handy and free online HTTP tool.","version":"1.0"}}' --specification '{"name":"openapi","version":"3.0.0"}'

Voorbeeld van importspecificatie 2

az apic api definition import-specification -g api-center-test -n contoso --api-id echo-api --version-id 2023-11-01 --definition-id openapi --format "link" --value 'https://petstore3.swagger.io/api/v3/openapi.json' --specification '{"name":"openapi","version":"3.0.0"}'

Specificatie importeren uit bestandsvoorbeeld

az apic api definition import-specification -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-08-01 --definition-id openapi --format "inline" --value '@petstore.json'

Vereiste parameters

--format

Indeling van de API-specificatiebron.

Eigenschap	Waarde
Parametergroep:	Payload Arguments
Geaccepteerde waarden:	inline, link

--specification

Api-specificatiedetails. Ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

Eigenschap	Waarde
Parametergroep:	Payload Arguments

--value

Waarde van de API-specificatiebron.

Eigenschap	Waarde
Parametergroep:	Payload Arguments

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--api-id

De id van de API.

Eigenschap	Waarde
Parametergroep:	Resource Id Arguments

--definition-id

De id van de API-definitie.

Eigenschap	Waarde
Parametergroep:	Resource Id Arguments

--ids

Eigenschap	Waarde
Parametergroep:	Resource Id Arguments

--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

Eigenschap	Waarde
Geaccepteerde waarden:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

Eigenschap	Waarde
Parametergroep:	Resource Id Arguments

--service-name -n

De naam van de Azure API Center-service.

Eigenschap	Waarde
Parametergroep:	Resource Id Arguments

--subscription

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

Eigenschap	Waarde
Parametergroep:	Resource Id Arguments

--version-id

De id van de API-versie.

Eigenschap	Waarde
Parametergroep:	Resource Id Arguments

Globale parameters

--debug

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

Eigenschap	Waarde
Default value:	False

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap	Waarde
Default value:	False

--output -o

Uitvoerindeling.

Eigenschap	Waarde
Default value:	json
Geaccepteerde waarden:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Eigenschap	Waarde
Default value:	False

az apic api definition list

Een verzameling API-definities weergeven.

az apic api definition list --api-id
                            --resource-group
                            --service-name
                            --version-id
                            [--filter]
                            [--max-items]
                            [--next-token]

Voorbeelden

API-definities weergeven

az apic api definition list -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01

Vereiste parameters

--api-id

De id van de API.

--resource-group -g

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

--service-name -n

De naam van de Azure API Center-service.

--version-id

De id van de API-versie.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--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 argument van een volgende opdracht.

Eigenschap	Waarde
Parametergroep:	Pagination Arguments

--next-token

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

Eigenschap	Waarde
Parametergroep:	Pagination Arguments

Globale parameters

--debug

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

Eigenschap	Waarde
Default value:	False

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap	Waarde
Default value:	False

--output -o

Uitvoerindeling.

Eigenschap	Waarde
Default value:	json
Geaccepteerde waarden:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

Naam of id van 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.

Eigenschap	Waarde
Default value:	False

az apic api definition show

Details van de API-definitie ophalen.

az apic api definition show [--api-id]
                            [--definition-id]
                            [--ids]
                            [--resource-group]
                            [--service-name]
                            [--subscription]
                            [--version-id]

Voorbeelden

Details van API-definitie weergeven

az apic api definition show -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi"

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--api-id

De id van de API.

Eigenschap	Waarde
Parametergroep:	Resource Id Arguments

--definition-id

De id van de API-definitie.

Eigenschap	Waarde
Parametergroep:	Resource Id Arguments

--ids

Eigenschap	Waarde
Parametergroep:	Resource Id Arguments

--resource-group -g

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

Eigenschap	Waarde
Parametergroep:	Resource Id Arguments

--service-name -n

De naam van de Azure API Center-service.

Eigenschap	Waarde
Parametergroep:	Resource Id Arguments

--subscription

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

Eigenschap	Waarde
Parametergroep:	Resource Id Arguments

--version-id

De id van de API-versie.

Eigenschap	Waarde
Parametergroep:	Resource Id Arguments

Globale parameters

--debug

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

Eigenschap	Waarde
Default value:	False

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap	Waarde
Default value:	False

--output -o

Uitvoerindeling.

Eigenschap	Waarde
Default value:	json
Geaccepteerde waarden:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Eigenschap	Waarde
Default value:	False

az apic api definition update

Bestaande API-definitie bijwerken.

az apic api definition update [--add]
                              [--api-id]
                              [--definition-id]
                              [--description]
                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                              [--ids]
                              [--remove]
                              [--resource-group]
                              [--service-name]
                              [--set]
                              [--subscription]
                              [--title]
                              [--version-id]

Voorbeelden

API-definitie bijwerken

az apic api definition update -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi" --title "OpenAPI"

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--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 or JSON string>.

Eigenschap	Waarde
Parametergroep:	Generic Update Arguments

--api-id

De id van de API.

Eigenschap	Waarde
Parametergroep:	Resource Id Arguments

--definition-id

De id van de API-definitie.

Eigenschap	Waarde
Parametergroep:	Resource Id Arguments

--description

Beschrijving van API-definitie.

Eigenschap	Waarde
Parametergroep:	Properties Arguments

--force-string

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

Eigenschap	Waarde
Parametergroep:	Generic Update Arguments
Geaccepteerde waarden:	0, 1, f, false, n, no, t, true, y, yes

--ids

Eigenschap	Waarde
Parametergroep:	Resource Id Arguments

--remove

Een eigenschap of element uit een lijst verwijderen. Voorbeeld: --remove property.list <indexToRemove> OF --remove propertyToRemove.

Eigenschap	Waarde
Parametergroep:	Generic Update Arguments

--resource-group -g

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

Eigenschap	Waarde
Parametergroep:	Resource Id Arguments

--service-name -n

De naam van de Azure API Center-service.

Eigenschap	Waarde
Parametergroep:	Resource Id Arguments

--set

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

Eigenschap	Waarde
Parametergroep:	Generic Update Arguments

--subscription

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

Eigenschap	Waarde
Parametergroep:	Resource Id Arguments

--title

Titel van API-versie.

Eigenschap	Waarde
Parametergroep:	Properties Arguments

--version-id

De id van de API-versie.

Eigenschap	Waarde
Parametergroep:	Resource Id Arguments

Globale parameters

--debug

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

Eigenschap	Waarde
Default value:	False

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap	Waarde
Default value:	False

--output -o

Uitvoerindeling.

Eigenschap	Waarde
Default value:	json
Geaccepteerde waarden:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Eigenschap	Waarde
Default value:	False

Feedback

Is deze pagina nuttig?

Delen via

az apic api definition

Opdracht

az apic api definition create

Voorbeelden

Vereiste parameters

Optionele parameters

az apic api definition delete

Voorbeelden

Optionele parameters

az apic api definition export-specification

Voorbeelden

Vereiste parameters

Optionele parameters

az apic api definition import-specification

Voorbeelden

Vereiste parameters

Optionele parameters

az apic api definition list

Voorbeelden

Vereiste parameters

Optionele parameters

az apic api definition show

Voorbeelden

Optionele parameters

az apic api definition update

Voorbeelden

Optionele parameters

Feedback