Använda tillägg med Azure CLIUse extensions with Azure CLI

Du kan läsa in tillägg med Azure CLI.The Azure CLI offers the capability to load extensions. Tillägg är Python-hjul som inte levererats som en del av CLI men körs som CLI-kommandon.Extensions are Python wheels that aren't shipped as part of the CLI but run as CLI commands. Med tillägg får du åtkomst till experiment- och förhandsversioner av kommandon tillsammans med möjligheten att skriva egna CLI-gränssnitt.With extensions, you gain access to experimental and pre-release commands along with the ability to write your own CLI interfaces. Den här artikeln beskriver hur du hanterar tillägg och ger svar på vanliga frågor om deras användning.This article covers how to manage extensions and answers common questions about their use.

Hitta tilläggFind extensions

Om du vill se de tillägg som tillhandahålls och hanteras av Microsoft använder du kommandot az extension list-available.To see the extensions provided and maintained by Microsoft, use the az extension list-available command.

az extension list-available --output table

Det finns även en lista över tillägg på dokumentationswebbplatsen.We also host a list of extensions on the documentation site.

Installera tilläggInstall extensions

När du har hittat ett tillägg som du vill installera använder du az extension add för att hämta det.Once you have found an extension to install, use az extension add to get it. Om tillägget finns i listan i az extension list-available kan du installera tillägget efter dess namn.If the extension is listed in az extension list-available, you can install the extension by name.

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.If the extension is from an external resource or you have a direct link to it, provide the source URL or local path. Tillägget måste vara en kompilerad Python-hjulfil.The extension must be a compiled Python wheel file.

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

När du har installerat ett tillägg finns det under värdet för $AZURE_EXTENSION_DIR-gränssnittsvariabeln.Once an extension is installed, it's found under the value of the $AZURE_EXTENSION_DIR shell variable. 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.If this variable is unset, by default the value is $HOME/.azure/cliextensions on Linux and macOS, and %USERPROFILE%\.azure\cliextensions on Windows.

Uppdatera tilläggUpdate extensions

Om ett tillägg installerades efter namn kan du uppdatera det med hjälp av az extension update.If an extension was installed by name, update it using 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.Otherwise, an extension can be updated from source by following the Install extensions instructions.

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.If an extension name can't be resolved by the CLI, uninstall it and attempt to reinstall. Tillägget kan också ha blivit en del av bas-CLI.The extension could also have become part of the base CLI. Prova att uppdatera CLI enligt beskrivningen i Installera Azure CLI och se om tilläggets kommandon har lagts till.Try updating the CLI as described in Install the Azure CLI and see if the extension's commands were added.

Avinstallera tilläggUninstall extensions

Om du inte längre behöver ett tillägg tar du bort det med az extension remove.If you no longer need an extension, remove it with 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.You can also remove an extension manually by deleting it from the location where it was installed. $AZURE_EXTENSION_DIR-gränssnittsvariabeln definierar var moduler är installerade.The $AZURE_EXTENSION_DIR shell variable defines where modules are installed. 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.If this variable is unset, by default the value is $HOME/.azure/cliextensions on Linux and macOS, and %USERPROFILE%\.azure\cliextensions on Windows.

rm -rf $AZURE_EXTENSION_DIR/<extension-name>

VANLIGA FRÅGOR OCH SVARFAQ

Följande är några svar på andra vanliga frågor om CLI-tillägg.Here are some answers to other common questions about CLI extensions.

Vilka filformat är tillåtna för installation?What file formats are allowed for installation?

För närvarande kan endast kompilerade Python WHL-filer installeras som tillägg.Currently, only compiled Python wheels can be installed as extensions.

Kan tillägg ersätta befintliga kommandon?Can extensions replace existing commands?

Ja.Yes. Tillägg kan ersätta befintliga kommandon, men innan du kör ett kommando som har ersatts kommer CLI att visa en varning.Extensions may replace existing commands, but before running a command that has been replaced the CLI will issue a warning.

Hur vet jag om ett tillägg är en förhandsversion?How can I tell if an extension is in pre-release?

Ett tilläggs dokumentation och versionshantering visar om det är en förhandsversion.An extension's documentation and versioning will show if it's in pre-release. Microsoft släpper ofta förhandsversioner av kommandon som CLI-tillägg, med alternativet att flytta dem senare till CLI-huvudprodukten.Microsoft often releases preview commands as CLI extensions, with the option of moving them into the main CLI product later. När kommandon flyttas ut ur tillägg bör du avinstallera det gamla tillägget.When commands are moved out of extensions, the old extension should be uninstalled.

Kan tillägg vara beroende av varandra?Can extensions depend upon each other?

Nej.No. Eftersom CLI inte garanterar en inläsningsordning kanske beroenden inte tillgodoses.Since the CLI doesn't guarantee a load order, dependencies might not be satisfied. När du tar bort ett tillägg påverkas inte några andra.Removing an extension won't affect any others.

Uppdateras tillägg tillsammans med CLI?Are extensions updated along with the CLI?

Nej.No. Tillägg måste uppdateras separat, enligt beskrivningen i Uppdatera tillägg.Extensions must be updated separately, as described in Update extensions.

Hur utvecklar jag ett eget tillägg?How to develop our own extension?

Mer hjälp finns på den officiella lagrings platsen.Please refer to the official repository for more help. Azure/Azure-CLI-tilläggAzure/azure-cli-extensions