az apim api versionset

  • Referens

Hantera Versionsuppsättning för Azure API Management API.

Kommandon

Name Description Typ Status
az apim api versionset create

Skapar en API-versionsuppsättning.

 Kärna Allmän tillgänglighet
az apim api versionset delete

Tar bort specifika API-versionsuppsättningar.

 Kärna Allmän tillgänglighet
az apim api versionset list

Visar en samling API-versionsuppsättningar i den angivna tjänstinstansen.

 Kärna Allmän tillgänglighet
az apim api versionset show

Hämtar information om api-versionsuppsättningen som anges av dess identifierare.

 Kärna Allmän tillgänglighet
az apim api versionset update

Uppdateringar information om API VersionSet som anges av dess identifierare.

 Kärna Allmän tillgänglighet

az apim api versionset create

Redigera

Skapar en API-versionsuppsättning.

az apim api versionset create --display-name
                              --resource-group
                              --service-name
                              --versioning-scheme
                              [--description]
                              [--if-match]
                              [--version-header-name]
                              [--version-query-name]
                              [--version-set-id]

Exempel

Skapar en API-versionsuppsättning med versionsschemat som rubrik.

az apim api versionset create --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --display-name MyDisplayName --versioning-scheme "Header" --description MyDescription --version-header-name MyHeaderName

Skapar en API-versionsuppsättning med versionsschema som fråga.

az apim api versionset create --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --display-name MyDisplayName --versioning-scheme "Query" --description MyDescription --version-query-name MyQueryName

Obligatoriska parametrar

--display-name

Obligatoriska. Namn på API-versionsuppsättning.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--service-name -n

Namnet på API Management-tjänstinstansen.

--versioning-scheme

Obligatoriska. Ett värde som avgör var API-versionen identifer ska finnas i en HTTP-begäran. Möjliga värden är: 'Segment', 'Query', 'Header'.

Valfria parametrar

--description

Beskrivning av API-versionsuppsättning.

--if-match

ETag för entiteten.

--version-header-name

Namnet på HTTP-huvudparametern som anger API-versionen om versionshanteringScheme är inställt på header.

--version-query-name

Namnet på frågeparametern som anger API-versionen om versionshanteringScheme är inställt på query.

--version-set-id

En resursidentifierare för den relaterade ApiVersionSet.

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.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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

az apim api versionset delete

Redigera

Tar bort specifika API-versionsuppsättningar.

az apim api versionset delete --resource-group
                              --service-name
                              --version-set-id
                              [--if-match]

Exempel

Tar bort specifika API-versionsuppsättningar.

az apim api versionset delete --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId

Obligatoriska parametrar

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--service-name -n

Namnet på API Management-tjänstinstansen.

--version-set-id

En resursidentifierare för den relaterade ApiVersionSet.

Valfria parametrar

--if-match

ETag för entiteten.

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.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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

az apim api versionset list

Redigera

Visar en samling API-versionsuppsättningar i den angivna tjänstinstansen.

az apim api versionset list --resource-group
                            --service-name

Exempel

Visar en samling API-versionsuppsättningar i den angivna tjänstinstansen.

az apim api versionset list --resource-group MyResourceGroup --service-name MyServiceName

Obligatoriska parametrar

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--service-name -n

Namnet på API Management-tjänstinstansen.

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.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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

az apim api versionset show

Redigera

Hämtar information om api-versionsuppsättningen som anges av dess identifierare.

az apim api versionset show --resource-group
                            --service-name
                            --version-set-id

Exempel

Hämtar information om api-versionsuppsättningen som anges av dess identifierare.

az apim api versionset show --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId

Obligatoriska parametrar

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--service-name -n

Namnet på API Management-tjänstinstansen.

--version-set-id

En resursidentifierare för den relaterade ApiVersionSet.

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.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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

az apim api versionset update

Redigera

Uppdateringar information om API VersionSet som anges av dess identifierare.

az apim api versionset update --resource-group
                              --service-name
                              --version-set-id
                              [--add]
                              [--description]
                              [--display-name]
                              [--force-string]
                              [--if-match]
                              [--remove]
                              [--set]
                              [--version-header-name]
                              [--version-query-name]
                              [--versioning-scheme]

Exempel

Uppdateringar beskrivningen, visningsnamnet för API VersionSet som anges av dess identifierare.

az apim api versionset update --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --display-name MyNewDisplayName --description MyNewDescription

Uppdateringar versionsschemat för API VersionSet som anges av dess identifierare.

az apim api versionset update --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --versioning-scheme "Query" --version-query-name MyNewQueryName

Obligatoriska parametrar

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--service-name -n

Namnet på API Management-tjänstinstansen.

--version-set-id

En resursidentifierare för den relaterade ApiVersionSet.

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

standardvärde: []
--description

Beskrivning av API-versionsuppsättning.

--display-name

Obligatoriska. Namn på API-versionsuppsättning.

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

standardvärde: False
--if-match

ETag för entiteten.

--remove

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

standardvärde: []
--set

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

standardvärde: []
--version-header-name

Namnet på HTTP-huvudparametern som anger API-versionen om versionshanteringScheme är inställt på header.

--version-query-name

Namnet på frågeparametern som anger API-versionen om versionshanteringScheme är inställt på query.

--versioning-scheme

Obligatoriska. Ett värde som avgör var API-versionen identifer ska finnas i en HTTP-begäran. Möjliga värden är: 'Segment', 'Query', 'Header'.

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.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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