az apim
Správa služeb Azure API Management
Příkazy
Name | Description | Typ | Stav |
---|---|---|---|
az apim api |
Správa rozhraní API služby Azure API Management |
Základ | GA |
az apim api create |
Vytvořte rozhraní API služby API Management. |
Základ | GA |
az apim api delete |
Odstraňte rozhraní API služby API Management. |
Základ | GA |
az apim api export |
Exportujte rozhraní API služby API Management. |
Základ | GA |
az apim api import |
Importujte rozhraní API služby API Management. |
Základ | GA |
az apim api list |
Uveďte seznam rozhraní API služby API Management. |
Základ | GA |
az apim api operation |
Správa operací rozhraní API služby Azure API Management |
Základ | GA |
az apim api operation create |
Vytvoří novou operaci v rozhraní API. |
Základ | GA |
az apim api operation delete |
Odstraní zadanou operaci v rozhraní API. |
Základ | GA |
az apim api operation list |
Vypíše kolekci operací pro zadané rozhraní API. |
Základ | GA |
az apim api operation show |
Získá podrobnosti operace rozhraní API určené jeho identifikátorem. |
Základ | GA |
az apim api operation update |
Aktualizace podrobnosti operace v rozhraní API určeném jeho identifikátorem. |
Základ | GA |
az apim api release |
Správa verze rozhraní API služby Azure API Management |
Základ | GA |
az apim api release create |
Vytvoří novou verzi pro rozhraní API. |
Základ | GA |
az apim api release delete |
Odstraní zadanou verzi v rozhraní API. |
Základ | GA |
az apim api release list |
Zobrazí seznam všech verzí rozhraní API. |
Základ | GA |
az apim api release show |
Vrátí podrobnosti verze rozhraní API. |
Základ | GA |
az apim api release update |
Aktualizace podrobnosti o vydání rozhraní API určeného jeho identifikátorem. |
Základ | GA |
az apim api revision |
Správa revize rozhraní API služby Azure API Management |
Základ | GA |
az apim api revision create |
Vytvoření revize rozhraní API |
Základ | GA |
az apim api revision list |
Zobrazí seznam všech revizí rozhraní API. |
Základ | GA |
az apim api schema |
Správa schématu rozhraní API služby Azure API Management |
Základ | GA |
az apim api schema create |
Vytvoření schématu rozhraní API služby API Management |
Základ | GA |
az apim api schema delete |
Odstraňte schéma rozhraní API služby API Management. |
Základ | GA |
az apim api schema get-etag |
Získejte etag schématu rozhraní API služby API Management. |
Základ | GA |
az apim api schema list |
Výpis schématu rozhraní API služby API Management |
Základ | GA |
az apim api schema show |
Zobrazení podrobností schématu rozhraní API služby API Management |
Základ | GA |
az apim api schema wait |
Umístěte rozhraní příkazového řádku do stavu čekání, dokud nebude splněna podmínka schématu rozhraní APIm. |
Základ | GA |
az apim api show |
Zobrazení podrobností o rozhraní API služby API Management |
Základ | GA |
az apim api update |
Aktualizujte rozhraní API služby API Management. |
Základ | GA |
az apim api versionset |
Správa sady verzí rozhraní API služby Azure API Management |
Základ | GA |
az apim api versionset create |
Vytvoří sadu verzí rozhraní API. |
Základ | GA |
az apim api versionset delete |
Odstraní konkrétní sadu verzí rozhraní API. |
Základ | GA |
az apim api versionset list |
Vypíše kolekci sad verzí rozhraní API v zadané instanci služby. |
Základ | GA |
az apim api versionset show |
Získá podrobnosti o sadě verzí rozhraní API určené jeho identifikátorem. |
Základ | GA |
az apim api versionset update |
Aktualizace podrobnosti o sadě verzí rozhraní API určené identifikátorem. |
Základ | GA |
az apim api wait |
Umístěte rozhraní příkazového řádku do stavu čekání, dokud nebude splněna podmínka rozhraní APIm. |
Základ | GA |
az apim apply-network-updates |
Aktualizujte prostředek služby API Management spuštěný ve virtuální síti a vyberte aktualizované nastavení sítě. |
Základ | GA |
az apim backup |
Vytvoří zálohu služby API Management do daného účtu úložiště Azure. Tato operace je dlouhotrvající a dokončení může trvat několik minut. |
Základ | GA |
az apim check-name |
Zkontroluje, jestli je k dispozici název služby. |
Základ | GA |
az apim create |
Vytvořte instanci služby API Management. |
Základ | GA |
az apim delete |
Odstraní službu API Management. |
Základ | GA |
az apim deletedservice |
Správa obnovitelně odstraněných služeb Azure API Management |
Základ | GA |
az apim deletedservice list |
Vypíše všechny instance služeb Api Management, které jsou pro dané předplatné k dispozici pro obnovitelné odstranění. |
Základ | GA |
az apim deletedservice purge |
Vyprázdnění instance služby Api Management s obnovitelném odstraněním (odstraní ji bez možnosti zrušení odstranění). |
Základ | GA |
az apim deletedservice show |
Získejte obnovitelně odstraněné instance služby Api Management, které jsou k dispozici pro odstranění podle názvu. |
Základ | GA |
az apim graphql |
Správa rozhraní GraphQL API služby Azure API Management |
Základ | GA |
az apim graphql resolver |
Správa překladačů rozhraní GraphQL API služby Azure API Management |
Základ | GA |
az apim graphql resolver create |
Vytvořte nový překladač v rozhraní GraphQL API nebo aktualizujte existující. |
Základ | GA |
az apim graphql resolver delete |
Odstraňte zadaný překladač v rozhraní GraphQL API. |
Základ | GA |
az apim graphql resolver list |
Vypíše kolekci překladačů pro zadané rozhraní GraphQL API. |
Základ | GA |
az apim graphql resolver policy |
Správa zásad překladačů rozhraní GraphQL API služby Azure API Management |
Základ | GA |
az apim graphql resolver policy create |
Vytvoření nebo aktualizace konfigurace zásad pro úroveň překladače rozhraní GraphQL API |
Základ | GA |
az apim graphql resolver policy delete |
Odstraňte konfiguraci zásad v překladači rozhraní GraphQL Api. |
Základ | GA |
az apim graphql resolver policy list |
Získejte seznam konfigurace zásad na úrovni překladače rozhraní GraphQL API. |
Základ | GA |
az apim graphql resolver policy show |
Získejte konfiguraci zásad na úrovni překladače rozhraní GraphQL API. |
Základ | GA |
az apim graphql resolver show |
Získejte podrobnosti o překladače rozhraní GraphQL API určeném jeho identifikátorem. |
Základ | GA |
az apim list |
Výpis instancí služby API Management |
Základ | GA |
az apim nv |
Správa pojmenovaných hodnot služby Azure API Management |
Základ | GA |
az apim nv create |
Vytvořte pojmenovanou hodnotu služby API Management. |
Základ | GA |
az apim nv delete |
Odstraňte pojmenovanou hodnotu služby API Management. |
Základ | GA |
az apim nv list |
Výpis pojmenovaných hodnot služby API Management |
Základ | GA |
az apim nv show |
Zobrazí podrobnosti pojmenované hodnoty služby API Management. |
Základ | GA |
az apim nv show-secret |
Získá tajný kód pojmenované hodnoty služby API Management. |
Základ | GA |
az apim nv update |
Aktualizace pojmenované hodnoty služby API Management |
Základ | GA |
az apim nv wait |
Umístěte rozhraní příkazového řádku do stavu čekání, dokud nebude splněna podmínka pojmenované hodnoty apim. |
Základ | GA |
az apim product |
Správa produktu Azure API Management |
Základ | GA |
az apim product api |
Správa rozhraní API produktu Azure API Management |
Základ | GA |
az apim product api add |
Přidejte rozhraní API do zadaného produktu. |
Základ | GA |
az apim product api check |
Kontroluje, že entita rozhraní API zadaná identifikátorem je přidružená k entitě Product. |
Základ | GA |
az apim product api delete |
Odstraní zadané rozhraní API ze zadaného produktu. |
Základ | GA |
az apim product api list |
Zobrazí kolekci rozhraní API přidružených k produktu. |
Základ | GA |
az apim product create |
Vytvoří produkt. |
Základ | GA |
az apim product delete |
Odstraňte produkt. |
Základ | GA |
az apim product list |
Vypíše kolekci produktů v zadané instanci služby. |
Základ | GA |
az apim product show |
Získá podrobnosti o produktu určeném jeho identifikátorem. |
Základ | GA |
az apim product update |
Aktualizujte existující podrobnosti o produktu. |
Základ | GA |
az apim product wait |
Umístěte rozhraní příkazového řádku do stavu čekání, dokud nebude splněna podmínka produktu apim. |
Základ | GA |
az apim restore |
Obnoví zálohu služby API Management vytvořenou pomocí operace ApiManagementService_Backup v aktuální službě. Jedná se o dlouhotrvající operaci, která může trvat několik minut. |
Základ | GA |
az apim show |
Zobrazí podrobnosti o instanci služby API Management. |
Základ | GA |
az apim update |
Aktualizace instance služby API Management |
Základ | GA |
az apim wait |
Umístěte rozhraní příkazového řádku do stavu čekání, dokud nebude splněna podmínka apim. |
Základ | GA |
az apim apply-network-updates
Aktualizujte prostředek služby API Management spuštěný ve virtuální síti a vyberte aktualizované nastavení sítě.
az apim apply-network-updates --name
--resource-group
[--location]
[--no-wait]
Příklady
Aktualizace nastavení virtuální sítě instance služby API Management
az apim apply-network-updates --name MyApim -g MyResourceGroup
Povinné parametry
Název instance služby API Management.
Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>
.
Volitelné parametry
Umístění. Hodnoty z: az account list-locations
. Výchozí umístění můžete nakonfigurovat pomocí .az configure --defaults location=<location>
Nečekejte na dokončení dlouhotrvající operace.
Globální parametry
Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.
Zobrazte tuto zprávu nápovědy a ukončete ji.
Zobrazují se pouze chyby, potlačení upozornění.
Výstupní formát
Ř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.
az apim backup
Vytvoří zálohu služby API Management do daného účtu úložiště Azure. Tato operace je dlouhotrvající a dokončení může trvat několik minut.
az apim backup --backup-name
--container-name
--name
--resource-group
--storage-account-key
--storage-account-name
[--no-wait]
Příklady
Vytvoření zálohy instance služby API Management
az apim backup --name MyApim -g MyResourceGroup --backup-name myBackup --storage-account-name mystorageaccount --storage-account-container backups --storage-account-key Ay2ZbdxLnD4OJPT29F6jLPkB6KynOzx85YCObhrw==
Povinné parametry
Název záložního souboru, který chcete vytvořit.
Název kontejneru účtu úložiště použitého k umístění zálohy.
Název instance služby API Management.
Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>
.
Přístupový klíč účtu úložiště použitý k umístění zálohy.
Název účtu úložiště použitého k umístění zálohy.
Volitelné parametry
Nečekejte na dokončení dlouhotrvající operace.
Globální parametry
Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.
Zobrazte tuto zprávu nápovědy a ukončete ji.
Zobrazují se pouze chyby, potlačení upozornění.
Výstupní formát
Ř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.
az apim check-name
Zkontroluje, jestli je k dispozici název služby.
az apim check-name --name
Povinné parametry
Název instance služby API Management.
Globální parametry
Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.
Zobrazte tuto zprávu nápovědy a ukončete ji.
Zobrazují se pouze chyby, potlačení upozornění.
Výstupní formát
Ř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.
az apim create
Vytvořte instanci služby API Management.
az apim create --name
--publisher-email
--publisher-name
--resource-group
[--disable-gateway {false, true}]
[--enable-client-certificate {false, true}]
[--enable-managed-identity {false, true}]
[--location]
[--no-wait]
[--public-network-access {false, true}]
[--sku-capacity]
[--sku-name {Basic, Consumption, Developer, Isolated, Premium, Standard}]
[--tags]
[--virtual-network {External, Internal, None}]
Příklady
Vytvořte službu API Management na úrovni vývojáře.
az apim create --name MyApim -g MyResourceGroup -l eastus --publisher-email email@mydomain.com --publisher-name Microsoft
Vytvořte službu API Management úrovně Consumption.
az apim create --name MyApim -g MyResourceGroup -l eastus --sku-name Consumption --enable-client-certificate \
--publisher-email email@mydomain.com --publisher-name Microsoft
Povinné parametry
Jedinečný název instance služby, která se má vytvořit.
Název musí být globálně jedinečný, protože bude zahrnutý jako název hostitele brány, například https://my-api-servicename.azure-api.net". Podívejte se na příklady.
E-mailová adresa pro příjem všech systémových oznámení.
Název vaší organizace pro použití na portálu pro vývojáře a e-mailová oznámení.
Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>
.
Volitelné parametry
Zakažte bránu v hlavní oblasti. Platí pouze pro službu Api Management nasazenou v několika umístěních.
Vynucuje, aby se klientský certifikát zobrazoval na jednotlivých žádostech brány a také umožňuje ověřit certifikát v zásadách brány.
Vytvořte spravovanou identitu pro službu API Management pro přístup k dalším prostředkům Azure. Určeno pouze pro službu SKU Consumption.
Umístění. Hodnoty z: az account list-locations
. Výchozí umístění můžete nakonfigurovat pomocí .az configure --defaults location=<location>
Nečekejte na dokončení dlouhotrvající operace.
Určuje, jestli je pro tuto službu API Management povolený přístup k veřejnému koncovému bodu. Pokud je nastavená hodnota true, privátní koncové body jsou výhradní metodou přístupu.
Počet nasazených jednotek skladové položky.
Skladová položka instance služby API Management.
Značky oddělené mezerami: klíč[=hodnota] [klíč[=hodnota] ...]. K vymazání existujících značek použijte "".
Typ virtuální sítě.
Globální parametry
Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.
Zobrazte tuto zprávu nápovědy a ukončete ji.
Zobrazují se pouze chyby, potlačení upozornění.
Výstupní formát
Ř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.
az apim delete
Odstraní službu API Management.
az apim delete --name
--resource-group
[--no-wait]
[--yes]
Příklady
Odstraňte službu API Management.
az apim delete -n MyApim -g MyResourceGroup
Povinné parametry
Název instance služby API Management.
Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>
.
Volitelné parametry
Nečekejte na dokončení dlouhotrvající operace.
Nezotvádejte výzvu k potvrzení.
Globální parametry
Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.
Zobrazte tuto zprávu nápovědy a ukončete ji.
Zobrazují se pouze chyby, potlačení upozornění.
Výstupní formát
Ř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.
az apim list
Výpis instancí služby API Management
az apim list [--resource-group]
Volitelné parametry
Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>
.
Globální parametry
Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.
Zobrazte tuto zprávu nápovědy a ukončete ji.
Zobrazují se pouze chyby, potlačení upozornění.
Výstupní formát
Ř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.
az apim restore
Obnoví zálohu služby API Management vytvořenou pomocí operace ApiManagementService_Backup v aktuální službě. Jedná se o dlouhotrvající operaci, která může trvat několik minut.
az apim restore --backup-name
--container-name
--name
--resource-group
--storage-account-key
--storage-account-name
[--no-wait]
Příklady
Obnoví zálohu instance služby API Management.
az apim restore --name MyApim -g MyResourceGroup --backup-name myBackup --storage-account-name mystorageaccount --storage-account-container backups --storage-account-key Ay2ZbdxLnD4OJPT29F6jLPkB6KynOzx85YCObhrw==
Povinné parametry
Název záložního souboru, který chcete obnovit.
Název kontejneru účtu úložiště použitého k načtení zálohy.
Název instance služby API Management.
Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>
.
Přístupový klíč účtu úložiště použitý k načtení zálohy.
Název účtu úložiště použitého k načtení zálohy.
Volitelné parametry
Nečekejte na dokončení dlouhotrvající operace.
Globální parametry
Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.
Zobrazte tuto zprávu nápovědy a ukončete ji.
Zobrazují se pouze chyby, potlačení upozornění.
Výstupní formát
Ř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.
az apim show
Zobrazí podrobnosti o instanci služby API Management.
az apim show --name
--resource-group
Povinné parametry
Název instance služby API Management.
Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>
.
Globální parametry
Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.
Zobrazte tuto zprávu nápovědy a ukončete ji.
Zobrazují se pouze chyby, potlačení upozornění.
Výstupní formát
Ř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.
az apim update
Aktualizace instance služby API Management
az apim update --name
--resource-group
[--add]
[--disable-gateway {false, true}]
[--enable-client-certificate {false, true}]
[--enable-managed-identity {false, true}]
[--force-string]
[--no-wait]
[--public-network-access {false, true}]
[--publisher-email]
[--publisher-name]
[--remove]
[--set]
[--sku-capacity]
[--sku-name {Basic, Consumption, Developer, Isolated, Premium, Standard}]
[--tags]
[--virtual-network {External, Internal, None}]
Povinné parametry
Název instance služby API Management.
Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>
.
Volitelné parametry
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>
.
Zakažte bránu v hlavní oblasti. Platí pouze pro službu Api Management nasazenou v několika umístěních.
Vynucuje, aby se klientský certifikát zobrazoval na jednotlivých žádostech brány a také umožňuje ověřit certifikát v zásadách brány.
Vytvořte spravovanou identitu pro službu API Management pro přístup k dalším prostředkům Azure. Určeno pouze pro službu SKU Consumption.
Při použití set nebo add zachovávejte řetězcové literály místo pokusu o převod na JSON.
Nečekejte na dokončení dlouhotrvající operace.
Určuje, jestli je pro tuto službu API Management povolený přístup k veřejnému koncovému bodu. Pokud je nastavená hodnota true, privátní koncové body jsou výhradní metodou přístupu.
E-mailová adresa pro příjem všech systémových oznámení.
Název vaší organizace pro použití na portálu pro vývojáře a e-mailová oznámení.
Odeberte vlastnost nebo prvek ze seznamu. Příklad: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Aktualizujte objekt zadáním cesty vlastnosti a hodnoty, která se má nastavit. Příklad: --set property1.property2=<value>
.
Počet nasazených jednotek skladové položky.
Skladová položka instance služby API Management.
Značky oddělené mezerami: klíč[=hodnota] [klíč[=hodnota] ...]. K vymazání existujících značek použijte "".
Typ virtuální sítě.
Globální parametry
Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.
Zobrazte tuto zprávu nápovědy a ukončete ji.
Zobrazují se pouze chyby, potlačení upozornění.
Výstupní formát
Ř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.
az apim wait
Umístěte rozhraní příkazového řádku do stavu čekání, dokud nebude splněna podmínka apim.
az apim wait --name
--resource-group
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]
Příklady
Umístěte rozhraní příkazového řádku do stavu čekání, dokud nebude splněna podmínka apim. (automaticky vygenerováno)
az apim wait --created --name MyApim --resource-group MyResourceGroup
Povinné parametry
Název instance služby API Management.
Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>
.
Volitelné parametry
Počkejte na vytvoření s 'provisioningState' v 'Succeeded'.
Počkejte, až podmínka splňuje vlastní dotaz JMESPath. Například provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Počkejte na odstranění.
Počkejte, až prostředek existuje.
Interval dotazování v sekundách
Maximální čekání v sekundách.
Počkejte, dokud se neaktualizuje stav zřizování ve stavu Úspěch.
Globální parametry
Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.
Zobrazte tuto zprávu nápovědy a ukončete ji.
Zobrazují se pouze chyby, potlačení upozornění.
Výstupní formát
Ř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.