az apic api version
Note
Tento odkaz je součástí rozšíření apic-extension pro Azure CLI (verze 2.57.0 nebo vyšší). Rozšíření se automaticky nainstaluje při prvním spuštění příkazu az apic api version. Přečtěte si další informace o rozšířeních.
Příkazy pro správu verzí rozhraní API v Centru rozhraní API
Příkazy
| Name | Description | Typ | Stav |
|---|---|---|---|
| az apic api version create |
Vytvořte novou verzi rozhraní API nebo aktualizujte existující verzi rozhraní API. |
Extension | GA |
| az apic api version delete |
Odstraňte zadanou verzi rozhraní API. |
Extension | GA |
| az apic api version list |
Vypíše kolekci verzí rozhraní API. |
Extension | GA |
| az apic api version show |
Získejte podrobnosti o verzi rozhraní API. |
Extension | GA |
| az apic api version update |
Aktualizujte stávající verzi rozhraní API. |
Extension | GA |
az apic api version create
Vytvořte novou verzi rozhraní API nebo aktualizujte existující verzi rozhraní API.
az apic api version create --api-id
--lifecycle-stage {deprecated, design, development, preview, production, retired, testing}
--resource-group
--service-name
--title
--version-id
Příklady
Vytvoření verze rozhraní API
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
Povinné parametry
ID rozhraní API.
Aktuální fáze životního cyklu rozhraní API
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Properties Arguments |
| Přípustné hodnoty: | deprecated, design, development, preview, production, retired, testing |
Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.
Název služby Azure API Center.
Verze rozhraní API.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Properties Arguments |
ID verze rozhraní API.
Globální parametry
Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Zobrazte tuto zprávu nápovědy a ukončete ji.
Zobrazit pouze chyby, potlačit upozornění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Výstupní formát
| Vlastnost | Hodnota |
|---|---|
| Default value: | json |
| Přípustné hodnoty: | json, jsonc, none, table, tsv, yaml, yamlc |
Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.
Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.
Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
az apic api version delete
Odstraňte zadanou verzi rozhraní API.
az apic api version delete [--api-id]
[--ids]
[--resource-group]
[--service-name]
[--subscription]
[--version-id]
[--yes]
Příklady
Odstranění verze rozhraní API
az apic api version delete -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01
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.
ID rozhraní API.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
Jedno nebo více ID prostředků (oddělené mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat buď argumenty --ids, nebo jiné argumenty 'ID prostředku'.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
Název služby Azure API Center.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
ID verze rozhraní API.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
Nevyzývejte k potvrzení.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Globální parametry
Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Zobrazte tuto zprávu nápovědy a ukončete ji.
Zobrazit pouze chyby, potlačit upozornění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Výstupní formát
| Vlastnost | Hodnota |
|---|---|
| Default value: | json |
| Přípustné hodnoty: | json, jsonc, none, table, tsv, yaml, yamlc |
Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.
Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
az apic api version list
Vypíše kolekci verzí rozhraní API.
az apic api version list --api-id
--resource-group
--service-name
[--filter]
[--max-items]
[--next-token]
Příklady
Výpis verzí rozhraní API
az apic api version list -g api-center-test -n contosoeuap --api-id echo-api
Povinné parametry
ID rozhraní API.
Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.
Název služby Azure API Center.
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.
Parametr filtru OData.
Celkový počet položek, které se mají vrátit ve výstupu příkazu Pokud je celkový počet dostupných položek větší než zadaná hodnota, zobrazí se ve výstupu příkazu token. Pokud chcete pokračovat ve stránkování, zadejte hodnotu tokenu v --next-token argumentu následného příkazu.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Pagination Arguments |
Token určující, kde se má stránkování spustit. Toto je hodnota tokenu z dříve zkrácené odpovědi.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Pagination Arguments |
Globální parametry
Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Zobrazte tuto zprávu nápovědy a ukončete ji.
Zobrazit pouze chyby, potlačit upozornění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Výstupní formát
| Vlastnost | Hodnota |
|---|---|
| Default value: | json |
| Přípustné hodnoty: | json, jsonc, none, table, tsv, yaml, yamlc |
Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.
Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.
Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
az apic api version show
Získejte podrobnosti o verzi rozhraní API.
az apic api version show [--api-id]
[--ids]
[--resource-group]
[--service-name]
[--subscription]
[--version-id]
Příklady
Zobrazení podrobností o verzi rozhraní API
az apic api version show -g api-center-test -n contoso --api-id echo-api --version-id 2023-01-01
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.
ID rozhraní API.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
Jedno nebo více ID prostředků (oddělené mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat buď argumenty --ids, nebo jiné argumenty 'ID prostředku'.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
Název služby Azure API Center.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
ID verze rozhraní API.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
Globální parametry
Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Zobrazte tuto zprávu nápovědy a ukončete ji.
Zobrazit pouze chyby, potlačit upozornění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Výstupní formát
| Vlastnost | Hodnota |
|---|---|
| Default value: | json |
| Přípustné hodnoty: | json, jsonc, none, table, tsv, yaml, yamlc |
Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.
Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
az apic api version update
Aktualizujte stávající verzi rozhraní API.
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]
Příklady
Aktualizace verze rozhraní API
az apic api version update -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --title "2023-01-01"
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.
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 |
ID rozhraní API.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
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 |
| Přípustné hodnoty: | 0, 1, f, false, n, no, t, true, y, yes |
Jedno nebo více ID prostředků (oddělené mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat buď argumenty --ids, nebo jiné argumenty 'ID prostředku'.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
Aktuální fáze životního cyklu rozhraní API
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Properties Arguments |
| Přípustné hodnoty: | deprecated, design, development, preview, production, retired, testing |
Odeberte vlastnost nebo prvek ze seznamu. Příklad: --remove property.list <indexToRemove> OR --remove propertyToRemove.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Generic Update Arguments |
Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
Název služby Azure API Center.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
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 |
Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
Verze rozhraní API.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Properties Arguments |
ID verze rozhraní API.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Resource Id Arguments |
Globální parametry
Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Zobrazte tuto zprávu nápovědy a ukončete ji.
Zobrazit pouze chyby, potlačit upozornění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Výstupní formát
| Vlastnost | Hodnota |
|---|---|
| Default value: | json |
| Přípustné hodnoty: | json, jsonc, none, table, tsv, yaml, yamlc |
Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.
Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |