az apic

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 . Přečtěte si další informace o rozšířeních.

Správa služeb Azure API Center

Příkazy

Name	Description	Typ	Stav
az apic api	Příkazy pro správu rozhraní API v centru API.	Extension	GA
az apic api-analysis	Správa funkcí analýzy rozhraní API služby Azure API Center	Extension	Preview
az apic api-analysis create	Vytvořte novou nebo aktualizuje existující konfiguraci analyzátoru rozhraní API.	Extension	Preview
az apic api-analysis delete	Odstranění odstraní konfiguraci analyzátoru rozhraní API.	Extension	Preview
az apic api-analysis export-ruleset	Exportuje sadu pravidel analyzátoru rozhraní API.	Extension	Preview
az apic api-analysis import-ruleset	Importuje sadu pravidel analyzátoru rozhraní API.	Extension	Preview
az apic api-analysis list	Výpis konfigurací analyzátoru rozhraní API	Extension	Preview
az apic api-analysis show	Získejte podrobnosti o konfiguraci analyzátoru rozhraní API.	Extension	Preview
az apic api-analysis update	Aktualizace nové nebo aktualizované stávající konfigurace analyzátoru rozhraní API	Extension	Preview
az apic api create	Zaregistrujte nové rozhraní API nebo aktualizujte existující rozhraní API.	Extension	GA
az apic api definition	Příkazy pro správu definic rozhraní API v centru API.	Extension	GA
az apic api definition create	Vytvořte novou definici rozhraní API nebo aktualizujte existující definici rozhraní API.	Extension	GA
az apic api definition delete	Odstraňte zadanou definici rozhraní API.	Extension	GA
az apic api definition export-specification	Exportuje specifikaci rozhraní API.	Extension	GA
az apic api definition import-specification	Importuje specifikaci rozhraní API.	Extension	GA
az apic api definition list	Vypíše kolekci definic rozhraní API.	Extension	GA
az apic api definition show	Získejte podrobnosti o definici rozhraní API.	Extension	GA
az apic api definition update	Aktualizujte existující definici rozhraní API.	Extension	GA
az apic api delete	Odstranění zadaného rozhraní API	Extension	GA
az apic api deployment	Příkazy pro správu nasazení rozhraní API v centru API.	Extension	GA
az apic api deployment create	Vytvořte nové nasazení rozhraní API nebo aktualizujte existující nasazení rozhraní API.	Extension	GA
az apic api deployment delete	Odstranění nasazení rozhraní API	Extension	GA
az apic api deployment list	Vypíše kolekci nasazení rozhraní API.	Extension	GA
az apic api deployment show	Získejte podrobnosti o nasazení rozhraní API.	Extension	GA
az apic api deployment update	Aktualizujte existující nasazení rozhraní API.	Extension	GA
az apic api list	Vypíše kolekci rozhraní API.	Extension	GA
az apic api register	Zaregistruje nové rozhraní API s verzí, definicí a přidruženými nasazeními pomocí souboru specifikace jako zdroje pravdy. Prozatím podporujeme jenom formát JSON/YAML OpenAPI.	Extension	Preview
az apic api show	Získejte podrobnosti o rozhraní API.	Extension	GA
az apic api update	Aktualizujte existující rozhraní API.	Extension	GA
az apic api version	Příkazy pro správu verzí rozhraní API v Centru rozhraní API	Extension	GA
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 create	Vytvoří instanci nebo aktualizuje existující instanci služby Azure API Center.	Extension	GA
az apic delete	Odstraní instanci služby Azure API Center.	Extension	GA
az apic environment	Příkazy pro správu prostředí ve službě API Center	Extension	GA
az apic environment create	Vytvořte nové prostředí nebo aktualizujte existující prostředí.	Extension	GA
az apic environment delete	Odstraňte prostředí.	Extension	GA
az apic environment list	Vypíše kolekci prostředí.	Extension	GA
az apic environment show	Získejte podrobnosti o prostředí.	Extension	GA
az apic environment update	Aktualizujte existující prostředí.	Extension	GA
az apic integration	Spravuje integrace ve službě Azure API Center.	Extension	GA
az apic integration create	Správa služeb Azure API Center	Extension	GA
az apic integration create apim	Přidejte Azure APIM jako zdroj rozhraní API.	Extension	GA
az apic integration create aws	Přidejte Amazon API Gateway jako zdroj rozhraní API.	Extension	GA
az apic integration delete	Odstranění zadaného zdroje rozhraní API	Extension	GA
az apic integration list	Vypíše kolekci zdrojů rozhraní API.	Extension	GA
az apic integration show	Získejte podrobnosti o zdroji rozhraní API.	Extension	GA
az apic list	Vypíše služby Azure API Center v rámci předplatného Azure.	Extension	GA
az apic metadata	Příkazy pro správu schémat metadat v Centru rozhraní API	Extension	GA
az apic metadata create	Vytvořte nové schéma metadat nebo aktualizujte existující schéma metadat.	Extension	GA
az apic metadata delete	Odstraňte zadané schéma metadat.	Extension	GA
az apic metadata export	Exportuje schéma metadat.	Extension	GA
az apic metadata list	Vypíše kolekci schémat metadat.	Extension	GA
az apic metadata show	Získejte podrobnosti o schématu metadat.	Extension	GA
az apic metadata update	Aktualizujte existující schéma metadat.	Extension	GA
az apic show	Zobrazení podrobností o instanci služby Azure API Center	Extension	GA
az apic update	Aktualizace instance služby Azure API Center	Extension	GA

az apic create

Vytvoří instanci nebo aktualizuje existující instanci služby Azure API Center.

az apic create --name
               --resource-group
               [--identity]
               [--location]
               [--tags]

Příklady

Příklad vytvoření služby

az apic create -g contoso-resources -n contoso -l eastus

Příklad vytvoření služby s přiřazenou identitou systému

az apic create -g contoso-resources -n contoso -l eastus --identity '{type:systemassigned}'

Povinné parametry

--name -n

Název služby API Center.

--resource-group -g

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

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.

--identity

Identity spravované služby přiřazené k tomuto prostředku. Podpora zkratky syntaxe, json-file a yaml-file Zkuste "??" zobrazit více.

--location -l

Geografické umístění, ve kterém se prostředek nachází, pokud není zadaný, se použije umístění skupiny prostředků.

--tags

Značky prostředků Podpora zkratky syntaxe, json-file a yaml-file Zkuste "??" zobrazit více.

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 delete

Odstraní instanci služby Azure API Center.

az apic delete [--ids]
               [--name]
               [--resource-group]
               [--subscription]
               [--yes]

Příklady

Odstranění služby

az apic delete -n contoso -g contoso-resources

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.

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

--name -n

Název služby API Center.

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

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

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

Vypíše služby Azure API Center v rámci předplatného Azure.

Existuje známý problém, který výpis všech prostředků v rámci předplatného nefunguje. Uveďte prostředky podle skupiny prostředků.

az apic list [--max-items]
             [--next-token]
             [--resource-group]

Příklady

Výpis služeb ve skupině prostředků

az apic list -g contoso-resources

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.

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

--resource-group -g

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

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 show

Zobrazení podrobností o instanci služby Azure API Center

az apic show [--ids]
             [--name]
             [--resource-group]
             [--subscription]

Příklady

Zobrazit podrobnosti o službě

az apic show -g contoso-resources -n contoso

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.

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

--name -n

Název služby API Center.

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

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

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 update

Aktualizace instance služby Azure API Center

az apic update [--add]
               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
               [--identity]
               [--ids]
               [--name]
               [--remove]
               [--resource-group]
               [--set]
               [--subscription]
               [--tags]

Příklady

Aktualizace podrobností o službě

az apic update -g contoso-resources -n contoso

Příklad aktualizace služby s přiřazenou systémem

az apic update -g contoso-resources -n contoso --identity '{type:systemassigned}'

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

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

--identity

Identity spravované služby přiřazené k tomuto prostředku. Podpora zkratky syntaxe, json-file a yaml-file Zkuste "??" zobrazit více.

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

--name -n

Název služby API Center.

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

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

--tags

Značky prostředků Podpora zkratky syntaxe, json-file a yaml-file Zkuste "??" zobrazit více.

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