Så här använder du aliastillägget i Azure CLI

Artikel
06/05/2024

Med aliastillägget kan användare definiera anpassade kommandon för Azure CLI med hjälp av befintliga kommandon. Alias hjälper dig att hålla ditt arbetsflöde enkelt genom att tillåta genvägar. Jinja2-mallmotorn driver Azure CLI-alias och erbjuder avancerad argumentbearbetning.

Kommentar

Aliastillägget finns i den allmänt tillgängliga förhandsversionen. Funktionerna och konfigurationsfilformatet kan ändras.

Installera aliastillägget

Den tidigaste versionen av Azure CLI som krävs för att använda aliastillägget är 2.0.28. Kör az --version för att kontrollera CLI-versionen. Om du behöver uppdatera din installation kan du följa instruktionerna i Installera Azure CLI.

Installera aliastillägget med kommandot az extension add .

az extension add --name alias

Verifiera installationen av tillägget med az extension list. Om aliastillägget har installerats korrekt visas det i kommandoradens utdata.

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

Name
------
alias

Håll aliastillägget uppdaterat

Aliastillägget håller fortfarande på att utvecklas och nya versioner släpps regelbundet. Nya versioner installeras inte när du uppdaterar CLI. Installera uppdateringar för tillägget med kommandot az extension update.

az extension update --name alias

Hantera alias för Azure CLI

Med aliastillägget kan du skapa och hantera alias för andra CLI-kommandon. Kör aliaskommandon med --help för att visa alla tillgängliga kommandon och parameterinformation.

az alias --help

Skapa enkla aliaskommandon

Alias kan bland annat användas för att förkorta befintliga kommandogrupper eller kommandonamn. Du kan till exempel förkorta kommandogruppen group till rg och kommandot list till ls.

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

Dessa nya alias kan sedan användas överallt där definitionen gäller.

az rg list
az rg ls
az vm ls

Inkludera az inte som en del av aliaskommandot.

Alias kan även fungera som genvägar för fullständiga kommandon. I nästa exempel visas tillgängliga resursgrupper och deras platser i tabellutdata:

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

Nu kan ls-groups köras som alla andra CLI-kommandon.

az ls-groups

Skapa ett aliaskommando med argument

Du kan även lägga till positionsargument till ett aliaskommando genom att ta med dem som {{ arg_name }} i aliasnamnet. Blankstegen i parenteserna är nödvändiga.

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

Nästa exempelalias visar hur du använder positionsargument för att hämta den offentliga IP-adressen för en virtuell dator.

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"

När du kör det här kommandot ger du värden till positionsargumenten.

az get-vm-ip MyResourceGroup MyVM

Du kan också använda miljövariabler i aliaskommandon och som utvärderas vid körning. Nästa exempel lägger till aliaset create-rg som skapar en resursgrupp i eastus och lägger till en owner-tagg. Den här taggen tilldelas värdet för den lokala miljövariabeln USER.

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

Dollartecknet $ får inte inkluderas om miljövariablerna i kommandots alias ska registreras.

Processargument använder Jinja2-mallar

Jinja2 utför argumentersättningen i aliastillägget. Med Jinja2-mallar kan du ändra argumenten.

Du kan skriva alias som tar andra typer av argument än det underliggande kommandot med hjälp av Jinja2-mallar. Du kan till exempel skapa ett alias som tar en lagrings-URL. Sedan tolkas denna URL för att överföra namnen på kontot och containern till lagringskommandot.

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] }}"

Läs om motorn för Jinja2-mallar i Jinja2-dokumentationen.

Aliaskonfigurationsfil

Du kan även ändra aliaskonfigurationsfilen för att skapa och ändra alias. Definitioner för aliaskommandon skrivs till en konfigurationsfil som finns i $AZURE_CONFIG_DIR/alias. Standardvärdet för AZURE_CONFIG_DIR är $HOME/.azure på macOS och Linux och %USERPROFILE%\.azure på Windows. Aliaskonfigurationsfilen skrivs i INI-konfigurationsfilformatet. Formatet för aliaskommandon är:

[alias_name]
command = invoked_commands

Formatet för aliaskommandon för alias som innehåller positionsargument är:

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

Skapa ett aliaskommando med argument via aliaskonfigurationsfilen

I nästa exempel visas ett alias för ett kommando med argument. Det här kommandot hämtar den offentliga IP-adressen för en virtuell dator. Alla aliaskommandon måste finnas på en enda rad och använda alla argument i aliasnamnet.

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

Avinstallera aliastillägget

Avinstallera tillägget med kommandot az extension remove.

az extension remove --name alias

Om du har avinstallerat på grund av ett fel eller något annat problem med tillägget så kan du skicka in ett GitHub-ärende så att vi kan arbeta med att ta fram en lösning.

Dela via