Freigeben über

Wie man die Azure CLI-Alias-Erweiterung verwendet

Mit der Aliaserweiterung können Benutzer benutzerdefinierte Befehle für die Azure CLI mithilfe vorhandener Befehle definieren. Aliase helfen, den Workflow zu vereinfachen, indem sie Abkürzungen ermöglichen. Das Jinja2-Vorlagenmodul unterstützt Azure CLI-Aliase und bietet eine erweiterte Argumentverarbeitung.

Hinweis

Die Aliaserweiterung befindet sich in der öffentlichen Vorschau. Die Features und das Konfigurationsdateiformat können sich ändern.

Installieren der Aliaserweiterung

Die mindestens erforderliche Azure CLI-Version für die Verwendung der Aliaserweiterung ist 2.0.28. Führen Sie zum Überprüfen der CLI-Version az --version aus. Wenn Sie Ihre Installation aktualisieren müssen, befolgen Sie die Anweisungen unter Installieren der Azure CLI.

Installieren Sie die Aliaserweiterung mit dem Befehl "az extension add" .

az extension add --name alias

Überprüfen Sie die Installation der Erweiterung mit az Erweiterungsliste. Wenn die Aliaserweiterung ordnungsgemäß installiert wird, wird sie in der Befehlsausgabe angezeigt.

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

Name
------
alias

Beibehalten der Aliaserweiterung up-to-date

Die Aliaserweiterung befindet sich in der aktiven Entwicklung und neue Versionen werden regelmäßig veröffentlicht. Neue Versionen werden jedoch nicht installiert, wenn Sie die CLI aktualisieren. Installieren Sie die Updates für die Erweiterung mit az Extension Update.

az extension update --name alias

Verwalten von Aliasen für die Azure CLI

Mit der Aliaserweiterung können Sie Aliase für andere CLI-Befehle erstellen und verwalten. Um alle verfügbaren Befehle und Parameterdetails anzuzeigen, führen Sie den Alias-Befehl mit --help aus.

az alias --help

Erstellen einfacher Aliasbefehle

Eine Verwendung von Aliasen dient zum Kürzen vorhandener Befehlsgruppen oder Befehlsnamen. Sie können z. B. die group Befehlsgruppe zu rg und den list Befehl zu ls verkürzen.

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

Sie können diese neu definierten Aliase jetzt überall verwenden, wo ihre Definitionen gelten.

az rg list
az rg ls
az vm ls

Schließen Sie nicht az als Teil des Aliasbefehls ein.

Aliase können auch Abkürzungen für komplette Befehle sein. Im nächsten Beispiel werden die verfügbaren Ressourcengruppen und deren Standorte in einer tabellarischen Auflistung aufgelistet.

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

Jetzt ls-groups kann wie jeder andere CLI-Befehl ausgeführt werden.

az ls-groups

Erstellen eines Aliasbefehls mit Argumenten

Sie können einem Aliasbefehl auch Positionsargumente hinzufügen, indem Sie sie wie {{ arg_name }} im Aliasnamen einfügen. Ein Leerzeichen innerhalb der geschweiften Klammern ist erforderlich.

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

Im nächsten Beispielalias wird gezeigt, wie Sie Positionsargumente verwenden, um die öffentliche IP-Adresse eines virtuellen Computers abzurufen.

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"

Wenn Sie diesen Befehl ausführen, geben Sie den Positionsargumenten Werte.

az get-vm-ip MyResourceGroup MyVM

Sie können auch Umgebungsvariablen in aliasierten Befehlen verwenden, die zur Laufzeit ausgewertet werden. Im nächsten Beispiel wird der create-rg Alias hinzugefügt, welcher eine Ressourcengruppe in eastus erstellt und ein owner-Tag hinzufügt. Diesem Tag wird der Wert der lokalen Umgebungsvariablen USERzugewiesen.

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

Um Umgebungsvariablen innerhalb des Aliasbefehls zu registrieren, müssen Sie das Dollarzeichen ($) escapen.

Verarbeiten von Argumenten mithilfe von Jinja2-Vorlagen

Jinja2 führt die Ersetzung von Argumenten in der Alias-Erweiterung durch. Jinja2-Vorlagen ermöglichen das Bearbeiten der Argumente.

Mit Jinja2-Vorlagen können Sie Aliase schreiben, die unterschiedliche Arten von Argumenten als den zugrunde liegenden Befehl verwenden. Sie können beispielsweise einen Alias erstellen, der eine Speicher-URL verwendet. Anschließend wird diese URL analysiert, um die Konto- und Containernamen an den Speicherbefehl zu übergeben.

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

Informationen zum Jinja2-Vorlagenmodul finden Sie in der Jinja2-Dokumentation.

Aliaskonfigurationsdatei

Eine weitere Möglichkeit zum Erstellen und Ändern von Aliasen besteht darin, die Aliaskonfigurationsdatei zu ändern. Aliasbefehlsdefinitionen werden in eine Konfigurationsdatei geschrieben, die sich unter $AZURE_CONFIG_DIR/alias befindet. Der Standardwert ist AZURE_CONFIG_DIR$HOME/.azure unter macOS und Linux und %USERPROFILE%\.azure unter Windows. Die Aliaskonfigurationsdatei wird im INI-Konfigurationsdateiformat geschrieben. Das Format für Aliasbefehle lautet:

[alias_name]
command = invoked_commands

Bei Aliasen mit Positionsargumenten lautet das Format für Aliasbefehle:

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

Erstellen eines Aliasbefehls mit Argumenten über die Aliaskonfigurationsdatei

Das nächste Beispiel zeigt einen Alias für einen Befehl mit Argumenten. Dieser Befehl ruft die öffentliche IP-Adresse für einen virtuellen Computer ab. Aliasbefehle müssen sich alle in einer einzelnen Zeile befinden und alle Argumente im Aliasnamen verwenden.

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

Deinstallieren der Aliaserweiterung

Verwenden Sie den Befehl " az extension remove ", um die Erweiterung zu deinstallieren.

az extension remove --name alias

Wenn Sie aufgrund eines Fehlers oder eines anderen Problems mit der Erweiterung deinstalliert haben, geben Sie ein GitHub-Problem an, damit wir eine Lösung bereitstellen können.