Jak používat rozšíření aliasů Azure CLI

Rozšíření aliasu umožňuje uživatelům definovat vlastní příkazy pro Azure CLI pomocí existujících příkazů. Aliasy pomáhají udržet pracovní postup jednoduchý tím, že umožňují klávesové zkratky. Modul šablon Jinja2 využívá aliasy Azure CLI a nabízí pokročilé zpracování argumentů.

Poznámka:

Rozšíření aliasu je ve verzi Public Preview. Funkce a formát konfiguračního souboru se můžou změnit.

Nainstalujte rozšíření aliasu

Minimální požadovaná verze Azure CLI pro použití rozšíření aliasu je 2.0.28. Pokud chcete zkontrolovat verzi CLI, spusťte az --version. Pokud potřebujete instalaci aktualizovat, postupujte podle pokynů v tématu Instalace Azure CLI.

Nainstalujte rozšíření aliasu pomocí příkazu az extension add .

az extension add --name alias

Ověřte instalaci rozšíření pomocí příkazu az extension list. Pokud se rozšíření aliasu nainstaluje správně, zobrazí se ve výstupu příkazu.

az extension list --output table --query '[].{Name:name}'

Name
------
alias

Zachovejte rozšíření aliasu up-to-date

Rozšíření aliasů je aktivně vyvíjeno a nové verze jsou vydávány pravidelně. Nové verze se ale při aktualizaci rozhraní příkazového řádku nenainstaluje. Nainstalujte aktualizace rozšíření pomocí příkazu az extension update.

az extension update --name alias

Správa aliasů pro Azure CLI

Rozšíření aliasů umožňuje vytvářet a spravovat aliasy pro další příkazy rozhraní příkazového řádku. Pokud chcete zobrazit všechny dostupné příkazy a podrobnosti parametrů, spusťte příkaz aliasu pomocí --helppříkazu .

az alias --help

Vytvoření jednoduchých příkazů aliasů

Jedním z použití aliasů je zkrácení existujících skupin příkazů nebo názvů příkazů. Můžete například zkrátit group skupinu příkazů na rg příkaz a list příkaz na ls.

az alias create --name rg --command group
az alias create --name ls --command list

Tyto nově definované aliasy teď můžete použít kdekoli, kde se jejich definice použijí.

az rg list
az rg ls
az vm ls

Nezahrnujte az jako součást příkazu aliasu.

Aliasy mohou být také zkratky pro kompletní příkazy. Následující příklad uvádí dostupné skupiny prostředků a jejich umístění ve výstupu tabulky:

az alias create --name ls-groups --command "group list --query '[].{Name:name, Location:location}' --output table"

Teď ls-groups můžete spustit jako jakýkoli jiný příkaz rozhraní příkazového řádku.

az ls-groups

Vytvoření příkazu aliasu s argumenty

Do příkazu aliasu můžete také přidat poziční argumenty tak, že je zahrnete jako {{ arg_name }} do názvu aliasu. Mezery uvnitř složených závorek jsou nutné.

az alias create --name "alias_name {{ arg1 }} {{ arg2 }} ..." --command "invoke_including_args"

Další ukázkový alias ukazuje, jak pomocí pozičních argumentů získat veřejnou IP adresu virtuálního počítače.

az alias create \
    --name "get-vm-ip {{ resourceGroup }} {{ vmName }}" \
    --command "vm list-ip-addresses --resource-group {{ resourceGroup }} --name {{ vmName }}
        --query [0].virtualMachine.network.publicIpAddresses[0].ipAddress"

Při spuštění tohoto příkazu zadáte hodnoty pozičním argumentům.

az get-vm-ip MyResourceGroup MyVM

Proměnné prostředí můžete použít také v aliasovaných příkazech, které se vyhodnocují za běhu. Další příklad přidá create-rg alias, který vytvoří skupinu prostředků v eastus a přidá značku owner. Této značce je přiřazena hodnota místní proměnné prostředí USER.

az alias create \
    --name "create-rg {{ groupName }}" \
    --command "group create --name {{ groupName }} --location eastus --tags owner=\$USER"

Pokud chcete v příkazu 'alias' zaregistrovat proměnné prostředí, musíte escapovat znak dolaru ($).

Zpracování argumentů pomocí šablon Jinja2

Jinja2 provede nahrazení argumentu v rozšíření aliasu. Šablony Jinja2 umožňují manipulaci s argumenty.

Pomocí šablon Jinja2 můžete psát aliasy, které přebírají různé typy argumentů než základní příkaz. Můžete například vytvořit alias, který přebírá adresu URL úložiště. Pak se tato adresa URL analyzuje a předá název účtu a kontejneru do příkazu úložiště.

az alias create \
    --name 'storage-ls {{ url }}' \
    --command "storage blob list
        --account-name {{ url.replace('https://', '').split('.')[0] }}
        --container-name {{ url.replace('https://', '').split('/')[1] }}"

Další informace o modulu šablon Jinja2 najdete v dokumentaci jinja2.

Konfigurační soubor aliasu

Dalším způsobem, jak vytvořit a upravit aliasy, je změnit konfigurační soubor aliasu. Definice příkazů aliasu se zapisují do konfiguračního souboru umístěného v $AZURE_CONFIG_DIR/aliasumístění . Výchozí hodnota AZURE_CONFIG_DIR je $HOME/.azure v systémech macOS a Linux a %USERPROFILE%\.azure ve Windows. Konfigurační soubor aliasu je napsaný ve formátu konfiguračního souboru INI. Formát příkazů aliasu je:

[alias_name]
command = invoked_commands

U aliasů, které mají poziční argumenty, je formát příkazů aliasu:

[alias_name {{ arg1 }} {{ arg2 }} ...]
command = invoked_commands_including_args

Vytvoření příkazu aliasu s argumenty prostřednictvím konfiguračního souboru aliasu

Následující příklad ukazuje alias pro příkaz s argumenty. Tento příkaz získá veřejnou IP adresu virtuálního počítače. Všechny příkazy s aliasy musí být na jednom řádku a musí používat všechny argumenty v názvu aliasu.

[get-vm-ip {{ resourceGroup }} {{ vmName }}]
command = vm list-ip-addresses --resource-group {{ resourceGroup }} --name {{ vmName }} --query [0].virtualMachine.network.publicIpAddresses[0].ipAddress

Odinstalujte rozšíření aliasu

K odinstalaci rozšíření použijte příkaz az extension remove .

az extension remove --name alias

Pokud jste odinstalovali kvůli chybě nebo jinému problému s příponou, vytvořte problém GitHubu , abychom mohli poskytnout opravu.