Använda och hantera tillägg med Azure CLI

Du kan läsa in tillägg med Azure CLI. Tillägg för Azure CLI betecknas som Python-hjul som inte levereras som en del av CLI men som körs som CLI-kommandon. Med tillägg får du åtkomst till experiment- och förhandsversioner av kommandon tillsammans med möjligheten att skriva egna CLI-gränssnitt. Den här artikeln beskriver hur du hanterar tillägg och ger svar på vanliga frågor om deras användning.

Så här hittar du tillägg

Om du vill se azure CLI-tillägg som tillhandahålls och underhålls av Microsoft använder du kommandot az extension list-available.

az extension list-available --output table

Det finns även en lista över tillägg på dokumentationswebbplatsen.

Så här installerar du tillägg

Installera tillägg manuellt

När du har hittat ett tillägg som du vill installera använder du az extension add för att hämta det. Om tillägget finns i listan i az extension list-available kan du installera tillägget efter dess namn.

az extension add --name <extension-name>

Om tillägget kommer från en extern resurs eller om du har en direktlänk till det anger du käll-URL eller lokal sökväg. Tillägget måste vara en kompilerad Python-hjulfil.

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

Du kan också skapa ett privat tilläggsindex enligt formatet iindex.jspåoch sedan ange url:en för tilläggsindexet som används av Azure CLI till det med början från version 2.20.0 . Därefter kan du installera tillägget efter namn från det privata tilläggsindexet.

az config set extension.index_url=<URL>
az extension add --name <extension-name>

När du har installerat ett tillägg finns det under värdet för $AZURE_EXTENSION_DIR-gränssnittsvariabeln. Om den här variabeln är odefinierad blir värdet som standard $HOME/.azure/cliextensions på Linux och macOS, och %USERPROFILE%\.azure\cliextensions på Windows.

Installera tillägg automatiskt

När du kör ett tilläggskommando som inte är installerat kan Azure CLI identifiera det kommando som du kör och automatiskt installera tillägget för dig med början från version 2.10.0 . Den här funktionen, som kallas dynamisk installation, är aktiverad som standard sedan 2.12.0 . Du kan också aktivera det via konfiguration för tidigare versioner som stöds.

az config set extension.use_dynamic_install=yes_prompt

Använd följande konfigurationskommando för att aktivera dynamisk installation utan att fråga.

az config set extension.use_dynamic_install=yes_without_prompt

Använd följande konfigurationskommando för att inaktivera funktionen för dynamisk installation för att återgå till standardbeteendet. Tilläggskommandot returnerar ett kommando-not-found-fel om tillägget inte är installerat.

az config set extension.use_dynamic_install=no

Som standard fortsätter ett tilläggskommando som frågar dynamisk installation att köras när tillägget har installerats. Du kan ändra standardbeteendet och göra så att kommandot avslutas utan att köra om genom att ange run_after_dynamic_install egenskapen till no .

az config set extension.run_after_dynamic_install=no

Så här uppdaterar du tillägg

Om ett tillägg installerades efter namn kan du uppdatera det med hjälp av az extension update.

az extension update --name <extension-name>

I andra fall kan ett tillägg uppdateras från källan genom att följa anvisningarna i Installera tillägg.

Om ett tilläggsnamn av någon orsak inte kan lösas av CLI kan du testa att avinstallera det och försöka installera det igen. Tillägget kan också ha blivit en del av bas-CLI. Prova att uppdatera CLI enligt beskrivningen i Installera Azure CLI och se om tilläggets kommandon har lagts till.

Avinstallera tillägg

Om du inte längre behöver ett tillägg tar du bort det med az extension remove.

az extension remove --name <extension-name>

Du kan även ta bort ett tillägg manuellt genom att ta bort det från den plats där det har installerats. $AZURE_EXTENSION_DIR-gränssnittsvariabeln definierar var moduler är installerade. Om den här variabeln är odefinierad blir värdet som standard $HOME/.azure/cliextensions på Linux och macOS, och %USERPROFILE%\.azure\cliextensions på Windows.

rm -rf $AZURE_EXTENSION_DIR/<extension-name>

Vanliga frågor

Följande är några svar på andra vanliga frågor om CLI-tillägg.

Vilka filformat är tillåtna för installation?

För närvarande kan endast kompilerade Python WHL-filer installeras som tillägg.

Kan tillägg ersätta befintliga kommandon?

Ja. Tillägg kan ersätta befintliga kommandon, men innan du kör ett kommando som har ersatts kommer CLI att visa en varning.

Hur vet jag om ett tillägg är en förhandsversion?

Ett tilläggs dokumentation och versionshantering visar om det är en förhandsversion. Microsoft släpper ofta förhandsversioner av kommandon som CLI-tillägg, med alternativet att flytta dem senare till CLI-huvudprodukten. När kommandon flyttas ut ur tillägg bör du avinstallera det gamla tillägget.

Kan tillägg vara beroende av varandra?

Nej. Eftersom CLI inte garanterar en inläsningsordning kanske beroenden inte tillgodoses. När du tar bort ett tillägg påverkas inte några andra.

Uppdateras tillägg tillsammans med CLI?

Nej. Tillägg måste uppdateras separat, enligt beskrivningen i Uppdatera tillägg.

Hur utvecklar jag ett eget tillägg?

Mer hjälp finns på den officiella lagringsplatsen. Azure/azure-cli-extensions