az apic api definition

Poznámka:

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 definition . Zjistěte více o rozšířeních.

Příkazy pro správu definic rozhraní API v centru API.

Příkazy

Name	Description	Typ	Stav
az apic api definition create	Vytvořte novou definici rozhraní API nebo aktualizujte existující definici rozhraní API.	Prodloužení	GA
az apic api definition delete	Odstraňte zadanou definici rozhraní API.	Prodloužení	GA
az apic api definition export-specification	Exportuje specifikaci rozhraní API.	Prodloužení	GA
az apic api definition import-specification	Importuje specifikaci rozhraní API.	Prodloužení	GA
az apic api definition list	Vypíše kolekci definic rozhraní API.	Prodloužení	GA
az apic api definition show	Získejte podrobnosti o definici rozhraní API.	Prodloužení	GA
az apic api definition update	Aktualizujte existující definici rozhraní API.	Prodloužení	GA

az apic api definition create

Vytvořte novou definici rozhraní API nebo aktualizujte existující definici rozhraní API.

az apic api definition create --api-id
                              --definition-id
                              --resource-group
                              --service-name
                              --title
                              --version-id
                              [--description]

Příklady

Vytvoření definice rozhraní API

az apic api definition create -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi" --title "OpenAPI"

Povinné parametry

--api-id

ID rozhraní API.

--definition-id

ID definice 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 služby Azure API Center.

--title

Verze rozhraní API.

Vlastnost	Hodnota
Skupina parametrů:	Properties Arguments

--version-id

ID verze rozhraní API.

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 definice rozhraní API

Vlastnost	Hodnota
Skupina parametrů:	Properties Arguments

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 apic api definition delete

Odstraňte zadanou definici rozhraní API.

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

Příklady

Odstranění definice rozhraní API

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

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.

--api-id

ID rozhraní API.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--definition-id

ID definice rozhraní API.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--ids

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

--resource-group -g

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

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--service-name -n

Název služby Azure API Center.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--subscription

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

--version-id

ID verze rozhraní API.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--yes -y

Nevyzývejte k potvrzení.

Vlastnost	Hodnota
Default value:	False

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.

--verbose

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 definition export-specification

Exportuje specifikaci rozhraní API.

az apic api definition export-specification --file-name
                                            [--api-id]
                                            [--definition-id]
                                            [--ids]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--service-name]
                                            [--subscription]
                                            [--version-id]

Příklady

Specifikace exportu

az apic api definition export-specification -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id default --file-name filename.json

Povinné parametry

--file-name

Název souboru, do kterého se má specifikace exportovat.

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.

--api-id

ID rozhraní API.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--definition-id

ID definice rozhraní API.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--ids

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--no-wait

Nečekejte na dokončení dlouhotrvající operace.

Vlastnost	Hodnota
Přípustné hodnoty:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--service-name -n

Název služby Azure API Center.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--subscription

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

--version-id

ID verze rozhraní API.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

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.

--verbose

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 definition import-specification

Importuje specifikaci rozhraní API.

az apic api definition import-specification --format {inline, link}
                                            --specification
                                            --value
                                            [--api-id]
                                            [--definition-id]
                                            [--ids]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--service-name]
                                            [--subscription]
                                            [--version-id]

Příklady

Příklad specifikace importu 1

az apic api definition import-specification -g api-center-test -n contosoeuap --api-id echo-api-2 --version-id 2023-08-01 --definition-id openapi3 --format "inline" --value '{"openapi":"3.0.1","info":{"title":"httpbin.org","description":"API Management facade for a very handy and free online HTTP tool.","version":"1.0"}}' --specification '{"name":"openapi","version":"3.0.0"}'

Příklad specifikace importu 2

az apic api definition import-specification -g api-center-test -n contoso --api-id echo-api --version-id 2023-11-01 --definition-id openapi --format "link" --value 'https://petstore3.swagger.io/api/v3/openapi.json' --specification '{"name":"openapi","version":"3.0.0"}'

Příklad importu specifikace ze souboru

az apic api definition import-specification -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-08-01 --definition-id openapi --format "inline" --value '@petstore.json'

Povinné parametry

--format

Formát zdroje specifikace rozhraní API

Vlastnost	Hodnota
Skupina parametrů:	Payload Arguments
Přípustné hodnoty:	inline, link

--specification

Podrobnosti specifikace rozhraní API Podpora zkratky syntaxe, json-file a yaml-file Zkuste "??" zobrazit více.

Vlastnost	Hodnota
Skupina parametrů:	Payload Arguments

--value

Hodnota zdroje specifikace rozhraní API

Vlastnost	Hodnota
Skupina parametrů:	Payload Arguments

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.

--api-id

ID rozhraní API.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--definition-id

ID definice rozhraní API.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--ids

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--no-wait

Nečekejte na dokončení dlouhotrvající operace.

Vlastnost	Hodnota
Přípustné hodnoty:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--service-name -n

Název služby Azure API Center.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--subscription

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

--version-id

ID verze rozhraní API.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

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.

--verbose

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

Vypíše kolekci definic rozhraní API.

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

Příklady

Výpis definic rozhraní API

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

Povinné parametry

--api-id

ID 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 služby Azure API Center.

--version-id

ID verze rozhraní API.

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.

--filter

Parametr filtru OData.

--max-items

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

--next-token

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

--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 apic api definition show

Získejte podrobnosti o definici rozhraní API.

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

Příklady

Zobrazení podrobností definice rozhraní API

az apic api definition show -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi"

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.

--api-id

ID rozhraní API.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--definition-id

ID definice rozhraní API.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--ids

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--resource-group -g

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

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--service-name -n

Název služby Azure API Center.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--subscription

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

--version-id

ID verze rozhraní API.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

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.

--verbose

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

Aktualizujte existující definici rozhraní API.

az apic api definition update [--add]
                              [--api-id]
                              [--definition-id]
                              [--description]
                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                              [--ids]
                              [--remove]
                              [--resource-group]
                              [--service-name]
                              [--set]
                              [--subscription]
                              [--title]
                              [--version-id]

Příklady

Aktualizace definice rozhraní API

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

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

--api-id

ID rozhraní API.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--definition-id

ID definice rozhraní API.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--description

Popis definice rozhraní API

Vlastnost	Hodnota
Skupina parametrů:	Properties Arguments

--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
Přípustné hodnoty:	0, 1, f, false, n, no, t, true, y, yes

--ids

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--remove

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

Vlastnost	Hodnota
Skupina parametrů:	Generic Update Arguments

--resource-group -g

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

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--service-name -n

Název služby Azure API Center.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

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

--subscription

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

--title

Název verze rozhraní API

Vlastnost	Hodnota
Skupina parametrů:	Properties Arguments

--version-id

ID verze rozhraní API.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

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.

--verbose

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

Vlastnost	Hodnota
Default value:	False

Váš názor

Byla tato stránka užitečná?

Sdílet prostřednictvím

az apic api definition

Příkazy

az apic api definition create

Příklady

Povinné parametry

Volitelné parametry

az apic api definition delete

Příklady

Volitelné parametry

az apic api definition export-specification

Příklady

Povinné parametry

Volitelné parametry

az apic api definition import-specification

Příklady

Povinné parametry

Volitelné parametry

az apic api definition list

Příklady

Povinné parametry

Volitelné parametry

az apic api definition show

Příklady

Volitelné parametry

az apic api definition update

Příklady

Volitelné parametry

Váš názor