Sdílet prostřednictvím

az apim api versionset

Správa sady verzí rozhraní API služby Azure API Management

Příkazy

Name Description Typ Stav
az apim api versionset create

Vytvoří sadu verzí rozhraní API.

 Core GA
az apim api versionset delete

Odstraní konkrétní sadu verzí rozhraní API.

 Core GA
az apim api versionset list

Vypíše kolekci sad verzí rozhraní API v zadané instanci služby.

 Core GA
az apim api versionset show

Získá podrobnosti o sadě verzí rozhraní API určené jeho identifikátorem.

 Core GA
az apim api versionset update

Aktualizuje podrobnosti sady verzí rozhraní API určené jeho identifikátorem.

 Core GA

az apim api versionset create

Upravit

Vytvoří sadu verzí rozhraní API.

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]

Příklady

Vytvoří sadu verzí rozhraní API se schématem verze jako hlavičkou.

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

Vytvoří sadu verzí rozhraní API se schématem verze jako dotaz.

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

Povinné parametry

--display-name

Required. Název sady verzí rozhraní API

--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--service-name -n

Název instance služby API Management.

--versioning-scheme

Required. Hodnota, která určuje, kde bude identifikátor verze rozhraní API umístěn v požadavku HTTP. Mezi možné hodnoty patří: Segment, Query, Header.

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--description

Popis sady verzí rozhraní API

--if-match

ETag of the Entity.

--version-header-name

Název parametru hlavičky HTTP, který označuje verzi rozhraní API, pokud je vlastnost versioningScheme nastavená na header.

--version-query-name

Název parametru dotazu, který označuje verzi rozhraní API, pokud je správa verzí nastavena na query.

--version-set-id

Identifikátor prostředku pro související sadu ApiVersionSet.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False

az apim api versionset delete

Upravit

Odstraní konkrétní sadu verzí rozhraní API.

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

Příklady

Odstraní konkrétní sadu verzí rozhraní API.

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

Povinné parametry

--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--service-name -n

Název instance služby API Management.

--version-set-id

Identifikátor prostředku pro související sadu ApiVersionSet.

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--if-match

ETag of the Entity.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False

az apim api versionset list

Upravit

Vypíše kolekci sad verzí rozhraní API v zadané instanci služby.

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

Příklady

Vypíše kolekci sad verzí rozhraní API v zadané instanci služby.

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

Povinné parametry

--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--service-name -n

Název instance služby API Management.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False

az apim api versionset show

Upravit

Získá podrobnosti o sadě verzí rozhraní API určené jeho identifikátorem.

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

Příklady

Získá podrobnosti o sadě verzí rozhraní API určené jeho identifikátorem.

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

Povinné parametry

--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--service-name -n

Název instance služby API Management.

--version-set-id

Identifikátor prostředku pro související sadu ApiVersionSet.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False

az apim api versionset update

Upravit

Aktualizuje podrobnosti sady verzí rozhraní API určené jeho identifikátorem.

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]

Příklady

Aktualizuje popis zobrazovaný název sady verzí rozhraní API určený jeho identifikátorem.

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

Aktualizuje schéma verze sady verzí rozhraní API určené jeho identifikátorem.

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

Povinné parametry

--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--service-name -n

Název instance služby API Management.

--version-set-id

Identifikátor prostředku pro související sadu ApiVersionSet.

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--add

Přidejte objekt do seznamu objektů zadáním párů cest a klíč-hodnota. Příklad: --add property.listProperty <key=value, string or JSON string>.

Vlastnost Hodnota
Skupina parametrů: Generic Update Arguments
Default value: []
--description

Popis sady verzí rozhraní API

--display-name

Required. Název sady verzí rozhraní API

--force-string

Při použití set nebo add zachovávejte řetězcové literály místo pokusu o převod na JSON.

Vlastnost Hodnota
Skupina parametrů: Generic Update Arguments
Default value: False
--if-match

ETag of the Entity.

--remove

Odeberte vlastnost nebo prvek ze seznamu. Příklad: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Vlastnost Hodnota
Skupina parametrů: Generic Update Arguments
Default value: []
--set

Aktualizujte objekt zadáním cesty vlastnosti a hodnoty, která se má nastavit. Příklad: --set property1.property2=<value>.

Vlastnost Hodnota
Skupina parametrů: Generic Update Arguments
Default value: []
--version-header-name

Název parametru hlavičky HTTP, který označuje verzi rozhraní API, pokud je vlastnost versioningScheme nastavená na header.

--version-query-name

Název parametru dotazu, který označuje verzi rozhraní API, pokud je správa verzí nastavena na query.

--versioning-scheme

Required. Hodnota, která určuje, kde bude identifikátor verze rozhraní API umístěn v požadavku HTTP. Mezi možné hodnoty patří: Segment, Query, Header.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False