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

Článek
09/23/2023

Rozšíření Alias umožňuje uživatelům pomocí stávajících příkazů definovat vlastní příkazy pro Azure CLI. Aliasy pomáhají zjednodušit pracovní postupy, protože umožňují použití zkratek. Modul šablon Jinja2 využívá aliasy Azure CLI a nabízí pokročilé zpracování argumentů.

Poznámka

Rozšíření Alias je ve verzi Public Preview. Funkce a formát konfiguračního souboru se mohou změnit.

Instalace rozšíření Alias

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

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

az extension add --name alias

K ověření instalace rozšíření použijte az extension list. Pokud se rozšíření Alias nainstalovalo správně, je uvedené ve výstupu tohoto příkazu.

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

Name
------
alias

Udržování rozšíření aliasu v aktualizovaném stavu

Rozšíření Alias se aktivně vyvíjí a pravidelně se vydávají nové verze. Když aktualizujete rozhraní příkazového řádku, nové verze se neinstalují. K instalaci aktualizací tohoto rozšíření použijte 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 ostatní příkazy rozhraní příkazového řádku. Pokud chcete zobrazit všechny dostupné příkazy a podrobnosti o parametrech, spusťte příkaz alias s parametrem --help.

az alias --help

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

Jedním z využití aliasů je zkrácení stávajících skupin nebo názvů příkazů. Například skupinu příkazů group můžete zkrátit na rg a příkaz list 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 všude, kde by byla jejich definice.

az rg list
az rg ls
az vm ls

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

Aliasy také mohou být zkratky místo kompletních příkazů. Následující příklad zobrazuje seznam dostupných skupin 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"

ls-groups se teď dá spustit jako kterýkoli jiný příkaz rozhraní CLI.

az ls-groups

Vytvoření příkazu alias s argumenty

K příkazu alias můžete doplnit poziční argumenty, pokud je v názvu aliasu uvedete jako {{ arg_name }}. Mezery uvnitř závorek jsou povinné.

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

Další ukázkový příkaz alias ukazuje, jak použít poziční argumenty k získání veřejné IP adresy 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áváte hodnoty pozičních argumentů.

az get-vm-ip MyResourceGroup MyVM

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

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

Pokud chcete v příkazu aliasu zaregistrovat proměnné prostředí, musí být symbol dolaru ($) uvozený.

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é využívají jiné typy argumentů než příslušný základní příkaz. Můžete například vytvořit alias, který využívá adresu URL úložiště. Tato adresa URL se zpracuje a příkazu storage se předá název účtu a kontejneru.

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

Konfigurační soubor aliasu

Dalším způsobem, jak vytvářet a upravovat aliasy, je úprava konfiguračního souboru aliasu. Definice příkazů alias jsou zapsané do konfiguračního souboru, který je umístěný v $AZURE_CONFIG_DIR/alias. Výchozí hodnota pro AZURE_CONFIG_DIR je $HOME/.azure v Linuxu a macOS a %USERPROFILE%\.azure ve Windows. Konfigurační soubor pro Alias je napsaný ve formátu konfiguračního souboru INI. Formát pro příkazy alias:

[alias_name]
command = invoked_commands

Formát pro příkazy alias pro aliasy s pozičními argumenty:

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

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

Další příklad ukazuje alias pro příkaz s argumenty. Tento příkaz získá veřejnou IP adresu pro virtuální počítač. Příkazy s aliasy musí být na jednom řádku a musí využí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

Odinstalace rozšíření Alias

Pokud chcete toto rozšíření odinstalovat, použijte příkaz az extension remove.

az extension remove --name alias

Pokud jste toto rozšíření odinstalovali kvůli chybě nebo jiným potížím, založte problém na GitHubu, abychom mohli zajistit opravu.

Sdílet prostřednictvím