az apic api version

Note

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

Kommandon för att hantera API-versioner i API Center.

Kommandon

Name Description Typ Status
az apic api version create

Skapa en ny API-version eller uppdatera en befintlig API-version.

 Extension GA
az apic api version delete

Ta bort angiven API-version.

 Extension GA
az apic api version list

Visa en lista över en samling API-versioner.

 Extension GA
az apic api version show

Hämta information om API-versionen.

 Extension GA
az apic api version update

Uppdatera befintlig API-version.

 Extension GA

az apic api version create

Skapa en ny API-version eller uppdatera en befintlig API-version.

az apic api version create --api-id
                           --lifecycle-stage {deprecated, design, development, preview, production, retired, testing}
                           --resource-group
                           --service-name
                           --title
                           --version-id
                           [--acquire-policy-token]
                           [--change-reference]

Exempel

Skapa API-version

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

Obligatoriska parametrar

--api-id

ID:t för API:et.

--lifecycle-stage

Aktuell livscykelfas för API:et.

Egenskap Värde
Parametergrupp: Properties Arguments
Godkända värden: deprecated, design, development, preview, production, retired, testing
--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.

--title

API-version.

Egenskap Värde
Parametergrupp: Properties Arguments
--version-id

ID:t för API-versionen.

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--acquire-policy-token

Hämtar en Azure Policy token automatiskt för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--change-reference

Det relaterade ändringsreferens-ID:t för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
Globala parametrar
--debug

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

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

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

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

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

Egenskap Värde
Standardvärde: False

az apic api version delete

Ta bort angiven API-version.

az apic api version delete [--acquire-policy-token]
                           [--api-id]
                           [--change-reference]
                           [--ids]
                           [--resource-group]
                           [--service-name]
                           [--subscription]
                           [--version-id]
                           [--yes]

Exempel

Ta bort API-version

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

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--acquire-policy-token

Hämtar en Azure Policy token automatiskt för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--api-id

ID:t för API:et.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--change-reference

Det relaterade ändringsreferens-ID:t för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--ids

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

Egenskap Värde
Parametergrupp: Resource Id Arguments
--resource-group -g

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

Egenskap Värde
Parametergrupp: Resource Id Arguments
--service-name -n

Namnet på Azure API Center-tjänsten.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--subscription

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

Egenskap Värde
Parametergrupp: Resource Id Arguments
--version-id

ID:t för API-versionen.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--yes -y

Fråga inte efter bekräftelse.

Egenskap Värde
Standardvärde: False
Globala parametrar
--debug

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

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

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

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

--verbose

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

Egenskap Värde
Standardvärde: False

az apic api version list

Visa en lista över en samling API-versioner.

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

Exempel

Lista API-versioner

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

Obligatoriska parametrar

--api-id

ID:t för API:et.

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

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

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

Egenskap Värde
Parametergrupp: Pagination Arguments
--next-token

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

Egenskap Värde
Parametergrupp: Pagination Arguments
Globala parametrar
--debug

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

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

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

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

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

Egenskap Värde
Standardvärde: False

az apic api version show

Hämta information om API-versionen.

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

Exempel

Visa information om API-version

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

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--api-id

ID:t för API:et.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--ids

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

Egenskap Värde
Parametergrupp: Resource Id Arguments
--resource-group -g

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

Egenskap Värde
Parametergrupp: Resource Id Arguments
--service-name -n

Namnet på Azure API Center-tjänsten.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--subscription

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

Egenskap Värde
Parametergrupp: Resource Id Arguments
--version-id

ID:t för API-versionen.

Egenskap Värde
Parametergrupp: Resource Id Arguments
Globala parametrar
--debug

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

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

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

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

--verbose

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

Egenskap Värde
Standardvärde: False

az apic api version update

Uppdatera befintlig API-version.

az apic api version update [--acquire-policy-token]
                           [--add]
                           [--api-id]
                           [--change-reference]
                           [--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]

Exempel

Uppdatera API-version

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

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--acquire-policy-token

Hämtar en Azure Policy token automatiskt för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--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>.

Egenskap Värde
Parametergrupp: Generic Update Arguments
--api-id

ID:t för API:et.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--change-reference

Det relaterade ändringsreferens-ID:t för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--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.

Egenskap Värde
Parametergrupp: Generic Update Arguments
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 'resurs-ID' argumenten. Du bör ange antingen --id eller andra "Resurs-ID"-argument.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--lifecycle-stage

Aktuell livscykelfas för API:et.

Egenskap Värde
Parametergrupp: Properties Arguments
Godkända värden: deprecated, design, development, preview, production, retired, testing
--remove

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

Egenskap Värde
Parametergrupp: Generic Update Arguments
--resource-group -g

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

Egenskap Värde
Parametergrupp: Resource Id Arguments
--service-name -n

Namnet på Azure API Center-tjänsten.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--set

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

Egenskap Värde
Parametergrupp: Generic Update Arguments
--subscription

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

Egenskap Värde
Parametergrupp: Resource Id Arguments
--title

API-version.

Egenskap Värde
Parametergrupp: Properties Arguments
--version-id

ID:t för API-versionen.

Egenskap Värde
Parametergrupp: Resource Id Arguments
Globala parametrar
--debug

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

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

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

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

--verbose

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

Egenskap Värde
Standardvärde: False