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	Core	GA
az apim api create	Vytvořte rozhraní API služby API Management.	Core	GA
az apim api delete	Odstraňte rozhraní API služby API Management.	Core	GA
az apim api export	Exportujte rozhraní API služby API Management.	Core	GA
az apim api import	Importujte rozhraní API služby API Management.	Core	GA
az apim api list	Uveďte seznam rozhraní API služby API Management.	Core	GA
az apim api operation	Správa operací rozhraní API služby Azure API Management	Core	GA
az apim api operation create	Vytvoří novou operaci v rozhraní API.	Core	GA
az apim api operation delete	Odstraní zadanou operaci v rozhraní API.	Core	GA
az apim api operation list	Vypíše kolekci operací pro zadané rozhraní API.	Core	GA
az apim api operation show	Získá podrobnosti operace rozhraní API určené jeho identifikátorem.	Core	GA
az apim api operation update	Aktualizuje podrobnosti o operaci v rozhraní API určeném jeho identifikátorem.	Core	GA
az apim api release	Správa verze rozhraní API služby Azure API Management	Core	GA
az apim api release create	Vytvoří novou verzi pro rozhraní API.	Core	GA
az apim api release delete	Odstraní zadanou verzi v rozhraní API.	Core	GA
az apim api release list	Zobrazí seznam všech verzí rozhraní API.	Core	GA
az apim api release show	Vrátí podrobnosti verze rozhraní API.	Core	GA
az apim api release update	Aktualizuje podrobnosti o vydání rozhraní API určeného jeho identifikátorem.	Core	GA
az apim api revision	Správa revize rozhraní API služby Azure API Management	Core	GA
az apim api revision create	Vytvoření revize rozhraní API	Core	GA
az apim api revision list	Zobrazí seznam všech revizí rozhraní API.	Core	GA
az apim api schema	Správa schématu rozhraní API služby Azure API Management	Core	GA
az apim api schema create	Vytvoření schématu rozhraní API služby API Management	Core	GA
az apim api schema delete	Odstraňte schéma rozhraní API služby API Management.	Core	GA
az apim api schema get-etag	Získejte etag schématu rozhraní API služby API Management.	Core	GA
az apim api schema list	Výpis schématu rozhraní API služby API Management	Core	GA
az apim api schema show	Zobrazení podrobností schématu rozhraní API služby API Management	Core	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.	Core	GA
az apim api show	Zobrazení podrobností o rozhraní API služby API Management	Core	GA
az apim api update	Aktualizujte rozhraní API služby API Management.	Core	GA
az apim api versionset	Správa sady verzí rozhraní API služby Azure API Management	Core	GA
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 wait	Umístěte rozhraní příkazového řádku do stavu čekání, dokud nebude splněna podmínka rozhraní APIm.	Core	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ě.	Core	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.	Core	GA
az apim check-name	Zkontroluje, jestli je k dispozici název služby.	Core	GA
az apim create	Vytvořte instanci služby API Management.	Core	GA
az apim delete	Odstraní službu API Management.	Core	GA
az apim deletedservice	Správa obnovitelně odstraněných služeb Azure API Management	Core	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í.	Core	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í).	Core	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.	Core	GA
az apim graphql	Správa rozhraní GraphQL API služby Azure API Management	Core	GA
az apim graphql resolver	Správa překladačů rozhraní GraphQL API služby Azure API Management	Core	GA
az apim graphql resolver create	Vytvořte nový překladač v rozhraní GraphQL API nebo aktualizujte existující.	Core	GA
az apim graphql resolver delete	Odstraňte zadaný překladač v rozhraní GraphQL API.	Core	GA
az apim graphql resolver list	Vypíše kolekci překladačů pro zadané rozhraní GraphQL API.	Core	GA
az apim graphql resolver policy	Správa zásad překladačů rozhraní GraphQL API služby Azure API Management	Core	GA
az apim graphql resolver policy create	Vytvoření nebo aktualizace konfigurace zásad pro úroveň překladače rozhraní GraphQL API	Core	GA
az apim graphql resolver policy delete	Odstraňte konfiguraci zásad v překladači rozhraní GraphQL Api.	Core	GA
az apim graphql resolver policy list	Získejte seznam konfigurace zásad na úrovni překladače rozhraní GraphQL API.	Core	GA
az apim graphql resolver policy show	Získejte konfiguraci zásad na úrovni překladače rozhraní GraphQL API.	Core	GA
az apim graphql resolver show	Získejte podrobnosti o překladače rozhraní GraphQL API určeném jeho identifikátorem.	Core	GA
az apim list	Výpis instancí služby API Management	Core	GA
az apim nv	Správa pojmenovaných hodnot služby Azure API Management	Core	GA
az apim nv create	Vytvořte pojmenovanou hodnotu služby API Management.	Core	GA
az apim nv delete	Odstraňte pojmenovanou hodnotu služby API Management.	Core	GA
az apim nv list	Výpis pojmenovaných hodnot služby API Management	Core	GA
az apim nv show	Zobrazí podrobnosti pojmenované hodnoty služby API Management.	Core	GA
az apim nv show-secret	Získá tajný kód pojmenované hodnoty služby API Management.	Core	GA
az apim nv update	Aktualizace pojmenované hodnoty služby API Management	Core	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.	Core	GA
az apim product	Správa produktu Azure API Management	Core	GA
az apim product api	Správa rozhraní API produktu Azure API Management	Core	GA
az apim product api add	Přidejte rozhraní API do zadaného produktu.	Core	GA
az apim product api check	Kontroluje, že entita rozhraní API zadaná identifikátorem je přidružená k entitě Product.	Core	GA
az apim product api delete	Odstraní zadané rozhraní API ze zadaného produktu.	Core	GA
az apim product api list	Zobrazí kolekci rozhraní API přidružených k produktu.	Core	GA
az apim product create	Vytvoří produkt.	Core	GA
az apim product delete	Odstraňte produkt.	Core	GA
az apim product list	Vypíše kolekci produktů v zadané instanci služby.	Core	GA
az apim product show	Získá podrobnosti o produktu určeném jeho identifikátorem.	Core	GA
az apim product update	Aktualizujte existující podrobnosti o produktu.	Core	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.	Core	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.	Core	GA
az apim show	Zobrazí podrobnosti o instanci služby API Management.	Core	GA
az apim update	Aktualizace instance služby API Management	Core	GA
az apim wait	Umístěte rozhraní příkazového řádku do stavu čekání, dokud nebude splněna podmínka apim.	Core	GA

az apim apply-network-updates

Upravit

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

--name -n

Název instance služby API Management.

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

--location -l

Location. Hodnoty z: az account list-locations. Výchozí umístění můžete nakonfigurovat pomocí .az configure --defaults location=<location>

--no-wait

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

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.

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

Upravit

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 --storage-account-container
               --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

--backup-name

Název záložního souboru, který chcete vytvořit.

--container-name --storage-account-container

Název kontejneru účtu úložiště použitého k umístění zálohy.

--name -n

Název instance služby API Management.

--resource-group -g

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

--storage-account-key

Přístupový klíč účtu úložiště použitý k umístění zálohy.

Vlastnost	Hodnota
Skupina parametrů:	Storage Arguments

--storage-account-name

Název účtu úložiště použitého k umístění zálohy.

Vlastnost	Hodnota
Skupina parametrů:	Storage 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.

--no-wait

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

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.

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

Upravit

Zkontroluje, jestli je k dispozici název služby.

az apim check-name --name

Povinné parametry

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

Upravit

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

--name -n

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 jako https://my-api-servicename.azure-api.net'. Podívejte se na příklady.

--publisher-email

E-mailová adresa pro příjem všech systémových oznámení.

--publisher-name

Název vaší organizace pro použití na portálu pro vývojáře a e-mailová oznámení.

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

--disable-gateway

Zakažte bránu v hlavní oblasti. Platí pouze pro službu Api Management nasazenou v několika umístěních.

Vlastnost	Hodnota
Přípustné hodnoty:	false, true

--enable-client-certificate

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.

Vlastnost	Hodnota
Přípustné hodnoty:	false, true

--enable-managed-identity

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.

Vlastnost	Hodnota
Default value:	False
Přípustné hodnoty:	false, true

--location -l

Location. Hodnoty z: az account list-locations. Výchozí umístění můžete nakonfigurovat pomocí .az configure --defaults location=<location>

--no-wait

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

Vlastnost	Hodnota
Default value:	False

--public-network-access

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.

Vlastnost	Hodnota
Přípustné hodnoty:	false, true

--sku-capacity

Počet nasazených jednotek skladové položky.

Vlastnost	Hodnota
Default value:	1

--sku-name

Skladová položka instance služby API Management.

Vlastnost	Hodnota
Default value:	Developer
Přípustné hodnoty:	Basic, Consumption, Developer, Isolated, Premium, Standard

--tags

Značky oddělené mezerami: klíč[=hodnota] [klíč[=hodnota] ...]. K vymazání existujících značek použijte "".

--virtual-network -v

Typ virtuální sítě.

Vlastnost	Hodnota
Default value:	None
Přípustné hodnoty:	External, Internal, None

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 delete

Upravit

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

--name -n

Název instance služby API Management.

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

--no-wait

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

Vlastnost	Hodnota
Default value:	False

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

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

Upravit

Výpis instancí služby API Management

az apim list [--resource-group]

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.

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

Upravit

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 --storage-account-container
                --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

--backup-name

Název záložního souboru, který chcete obnovit.

--container-name --storage-account-container

Název kontejneru účtu úložiště použitého k načtení zálohy.

--name -n

Název instance služby API Management.

--resource-group -g

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

--storage-account-key

Přístupový klíč účtu úložiště použitý k načtení zálohy.

Vlastnost	Hodnota
Skupina parametrů:	Storage Arguments

--storage-account-name

Název účtu úložiště použitého k načtení zálohy.

Vlastnost	Hodnota
Skupina parametrů:	Storage 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.

--no-wait

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

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.

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

Upravit

Zobrazí podrobnosti o instanci služby API Management.

az apim show --name
             --resource-group

Povinné parametry

--name -n

Název instance služby API Management.

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

Upravit

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

--name -n

Název instance služby API Management.

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

--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:	[]

--disable-gateway

Zakažte bránu v hlavní oblasti. Platí pouze pro službu Api Management nasazenou v několika umístěních.

Vlastnost	Hodnota
Přípustné hodnoty:	false, true

--enable-client-certificate

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.

Vlastnost	Hodnota
Přípustné hodnoty:	false, true

--enable-managed-identity

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.

Vlastnost	Hodnota
Přípustné hodnoty:	false, true

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

--no-wait

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

Vlastnost	Hodnota
Default value:	False

--public-network-access

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.

Vlastnost	Hodnota
Přípustné hodnoty:	false, true

--publisher-email

E-mailová adresa pro příjem všech systémových oznámení.

--publisher-name

Název vaší organizace pro použití na portálu pro vývojáře a e-mailová oznámení.

--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:	[]

--sku-capacity

Počet nasazených jednotek skladové položky.

--sku-name

Skladová položka instance služby API Management.

Vlastnost	Hodnota
Přípustné hodnoty:	Basic, Consumption, Developer, Isolated, Premium, Standard

--tags

Značky oddělené mezerami: klíč[=hodnota] [klíč[=hodnota] ...]. K vymazání existujících značek použijte "".

--virtual-network -v

Typ virtuální sítě.

Vlastnost	Hodnota
Přípustné hodnoty:	External, Internal, None

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 wait

Upravit

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. (autogenerated)

az apim wait --created --name MyApim --resource-group MyResourceGroup

Povinné parametry

--name -n

Název instance služby API Management.

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

--created

Počkejte na vytvoření s 'provisioningState' v 'Succeeded'.

Vlastnost	Hodnota
Skupina parametrů:	Wait Condition Arguments
Default value:	False

--custom

Počkejte, až podmínka splňuje vlastní dotaz JMESPath. Například provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Vlastnost	Hodnota
Skupina parametrů:	Wait Condition Arguments

--deleted

Počkejte na odstranění.

Vlastnost	Hodnota
Skupina parametrů:	Wait Condition Arguments
Default value:	False

--exists

Počkejte, až prostředek existuje.

Vlastnost	Hodnota
Skupina parametrů:	Wait Condition Arguments
Default value:	False

--interval

Interval dotazování v sekundách

Vlastnost	Hodnota
Skupina parametrů:	Wait Condition Arguments
Default value:	30

--timeout

Maximální čekání v sekundách.

Vlastnost	Hodnota
Skupina parametrů:	Wait Condition Arguments
Default value:	3600

--updated

Počkejte, dokud se neaktualizuje stav zřizování ve stavu Úspěch.

Vlastnost	Hodnota
Skupina parametrů:	Wait Condition Arguments
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.

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

Váš názor

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

Sdílet prostřednictvím

az apim

Příkazy

az apim apply-network-updates

Příklady

Povinné parametry

Volitelné parametry

az apim backup

Příklady

Povinné parametry

Volitelné parametry

az apim check-name

Povinné parametry

az apim create

Příklady

Povinné parametry

Volitelné parametry

az apim delete

Příklady

Povinné parametry

Volitelné parametry

az apim list

Volitelné parametry

az apim restore

Příklady

Povinné parametry

Volitelné parametry

az apim show

Povinné parametry

az apim update

Povinné parametry

Volitelné parametry

az apim wait

Příklady

Povinné parametry

Volitelné parametry

Váš názor