Verwenden von Erweiterungen mit Azure CLI 2.0

Erweiterungen sind einzelne Module, die nicht mit der Azure CLI bereitgestellt werden und die Ihnen das Hinzufügen von Funktionen mit neuen Befehlen ermöglichen. Dies können experimentelle oder Vorabangebote, spezielle Tools, die Microsoft zur Erfüllung Ihrer Anforderungen bereitstellt, oder auch von Ihnen selbst geschriebene Erweiterungen sein. Erweiterungen ermöglichen das flexible Anpassen der CLI an Ihre eigenen Anforderungen, ohne dass Sie viele zusätzliche Pakete mitliefern müssen, die nicht als Teil des Kernfeaturesatzes angesehen werden.

In diesem Artikel wird beschrieben, wie Sie Erweiterungen für die CLI installieren, aktualisieren und entfernen. Außerdem werden häufige Fragen zum Verhalten von Erweiterungen beantwortet.

Suchen nach Erweiterungen

Um zu ermitteln, welche Erweiterungen verfügbar sind, können Sie az extension list-available verwenden. Mit diesem Befehl werden die verfügbaren offiziellen Erweiterungen aufgelistet, die von Microsoft bereitgestellt und unterstützt werden.

Installieren von Erweiterungen

Nachdem Sie eine zu installierende Erweiterung gefunden haben, können Sie az extension add verwenden, um sie abzurufen. Wenn die Erweiterung eine offizielle Microsoft-Erweiterung ist, die bei Ausführung von az extension list-available aufgeführt wird, können Sie die Erweiterung anhand des Namens installieren.

az extension add --name <extension-name>

Wenn die Erweiterung von einer externen Ressource stammt oder Sie über einen direkten Link dafür verfügen, können Sie die Quell-URL oder den lokalen Pfad angeben. Dies muss eine kompilierte Python-Wheeldatei sein.

az extension add --source <URL-or-path>

Nach der Installation einer Erweiterung befindet sich diese unter dem Wert der Shellvariablen $AZURE_EXTENSION_DIR. Wenn diese Variable nicht festgelegt ist, befindet sich der Wert standardmäßig unter $HOME/.azure/cliextensions (Linux und macOS) bzw. %USERPROFILE%\.azure\cliextensions (Windows).

Aktualisieren von Erweiterungen

Erweiterungen können nur anhand des Namens aktualisiert werden:

az extension update --name <extension-name>

Wenn ein Erweiterungsname aus einem bestimmten Grund für die CLI nicht aufgelöst werden kann, sollten Sie die Erweiterung neu installieren, um sie zu aktualisieren. Außerdem ist es möglich, dass die Erweiterung nicht mehr als Vorschauversion verfügbar und zu einem integrierten Befehl für die CLI geworden ist. Aktualisieren Sie in diesem Fall die CLI, und deinstallieren Sie die Erweiterung.

Deinstallieren von Erweiterungen

Wenn Sie eine Erweiterung nicht mehr benötigen, können Sie sie mit az extension remove entfernen.

az extension remove --name <extension-name>

Sie können eine Erweiterung auch manuell entfernen, indem Sie sie am Installationsspeicherort löschen. Dies ist der Wert der Shellvariablen $AZURE_EXTENSION_DIR. Wenn diese Variable nicht festgelegt ist, befindet sich der Wert standardmäßig unter $HOME/.azure/cliextensions (Linux und macOS) bzw. %USERPROFILE%\.azure\cliextensions (Windows).

rm -rf $AZURE_EXTENSION_DIR/<extension-name>

Es wird empfohlen, die Deinstallation mit az extension remove durchzuführen.

Häufig gestellte Fragen

Hier sind einige Antworten auf andere häufig gestellte Fragen zu CLI-Erweiterungen aufgeführt.

Welche Dateiformate sind für die Installation zulässig?

Derzeit können nur kompilierte Python-Wheels als Erweiterungen installiert werden.

Können Erweiterungen vorhandene Befehle ersetzen?

Ja. Erweiterungen können vorhandene Befehle ersetzen, aber vor dem Ausführen eines ersetzten Befehls wird von der CLI eine Warnung ausgegeben.

Woran erkenne ich, dass es sich bei einer Erweiterung um eine Vorabversion handelt?

Für eine Erweiterung sollte in der dazugehörigen Dokumentation und in den Versionsinformationen angegeben sein, wenn es sich um eine Vorabversion handelt. Es kommt auch häufiger vor, dass Microsoft Vorschauversionen von Befehlen für die CLI als Erweiterungen veröffentlicht, die nach der Vorschauphase des Produkts in die Hauptoberfläche der CLI integriert werden sollen.

Können Erweiterungen voneinander abhängig sein?

Nein. Erweiterungen müssen einzelne Pakete sein, die nicht voneinander abhängig sind. Dies liegt daran, dass für die CLI nicht garantiert ist, wann Erweiterungen geladen werden. Es kann also nicht sichergestellt werden, dass die Anforderungen von Abhängigkeiten erfüllt werden. Bei der Installation einer Erweiterung wird nur die jeweilige Erweiterung installiert, und sie sollte auch dann funktionieren, wenn Sie andere Erweiterungen entfernen.

Werden Erweiterungen zusammen mit der CLI aktualisiert?

Nein. Erweiterungen müssen separat aktualisiert werden, wie im Abschnitt Aktualisieren von Erweiterungen beschrieben.