az apic api version

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 API-versieopdracht uitvoert. Meer informatie over extensies.

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

Opdracht

Name	Description	Type	Status
az apic api version create	Maak een nieuwe API-versie of werk een bestaande API-versie bij.	Toestel	GA
az apic api version delete	Verwijder de opgegeven API-versie.	Toestel	GA
az apic api version list	Een verzameling API-versies weergeven.	Toestel	GA
az apic api version show	Details van de API-versie ophalen.	Toestel	GA
az apic api version update	Bestaande API-versie bijwerken.	Toestel	GA

az apic api version create

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

az apic api version create --api-id
                           --lifecycle-stage {deprecated, design, development, preview, production, retired, testing}
                           --resource-group
                           --service-name
                           --title
                           --version-id

Voorbeelden

API-versie maken

az apic api version create -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --title "2023-01-01" --lifecycle-stage production

Vereiste parameters

--api-id

De id van de API.

--lifecycle-stage

Huidige levenscyclusfase van de API.

Geaccepteerde waarden: deprecated, design, development, preview, production, retired, testing

--resource-group -g

De naam van de 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

De API-versie.

--version-id

De id van de API-versie.

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

Default value: 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 api version delete

Verwijder de opgegeven API-versie.

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

Voorbeelden

API-versie verwijderen

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

Optionele parameters

--api-id

De id van de API.

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

--resource-group -g

De naam van de 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.

--subscription

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

--version-id

De id van de API-versie.

--yes -y

Niet vragen om bevestiging.

Default value: 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

Default value: 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 api version list

Een verzameling API-versies weergeven.

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

Voorbeelden

API-versies weergeven

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

Vereiste parameters

--api-id

De id van de API.

--resource-group -g

De naam van de 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.

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

Default value: 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 api version show

Details van de API-versie ophalen.

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

Voorbeelden

Api-versiedetails weergeven

az apic api version show -g api-center-test -n contoso --api-id echo-api --version-id 2023-01-01

Optionele parameters

--api-id

De id van de API.

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

--resource-group -g

De naam van de 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.

--subscription

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

--version-id

De id van de API-versie.

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

Default value: 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 api version update

Bestaande API-versie bijwerken.

az apic api version update [--add]
                           [--api-id]
                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                           [--ids]
                           [--lifecycle-stage {deprecated, design, development, preview, production, retired, testing}]
                           [--remove]
                           [--resource-group]
                           [--service-name]
                           [--set]
                           [--subscription]
                           [--title]
                           [--version-id]

Voorbeelden

API-versie bijwerken

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

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

--api-id

De id van de API.

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

--lifecycle-stage

Huidige levenscyclusfase van de API.

Geaccepteerde waarden: deprecated, design, development, preview, production, retired, testing

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

--service-name -n

De naam van de Azure 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.

--title

De API-versie.

--version-id

De id van de API-versie.

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

Default value: 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.