Použití a správa rozšíření pomocí Azure CLI

Azure CLI nabízí možnost načíst rozšíření. Rozšíření pro Azure CLI jsou charakterizována jako kola Pythonu, která nejsou dodávána jako součást rozhraní příkazového řádku, ale běží jako příkazy rozhraní příkazového řádku. S rozšířeními získáte přístup k experimentálním příkazům a příkazům předběžné verze a také možnost psát vlastní rozhraní příkazového řádku. Tento článek popisuje správu rozšíření a odpovídá na běžné dotazy ohledně jejich využití.

Jak najít rozšíření

Pokud chcete zobrazit rozšíření Azure CLI poskytovaná a udržovaná Microsoftem, použijte příkaz az extension list-available .

az extension list-available --output table

Seznam rozšíření je také uvedený na našem dokumentačním webu.

Postup instalace rozšíření

Ruční instalace rozšíření

Jakmile najdete rozšíření k instalaci, použijte k jeho získání příkaz az extension add. Rozšíření uvedená v seznamu az extension list-available můžete instalovat podle názvu.

az extension add --name <extension-name>

Pokud je rozšíření z externího zdroje nebo pokud na něj máte přímý odkaz, zadáte zdrojovou adresu URL nebo místní cestu. Musí jít o zkompilovaný soubor wheel Pythonu.

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

Můžete také vytvořit index privátního rozšíření podle formátu index.json a pak nastavit adresu URL indexu rozšíření, kterou azure CLI používá, počínaje verzí 2.20.0. Potom můžete rozšíření nainstalovat podle názvu z indexu privátního rozšíření.

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

Jakmile je rozšíření nainstalované, najdete ho pod hodnotou proměnné prostředí $AZURE_EXTENSION_DIR. Pokud tato proměnná není nastavena, její výchozí hodnota v Linuxu a macOS je $HOME/.azure/cliextensions a ve Windows to je %USERPROFILE%\.azure\cliextensions.

Automatická instalace rozšíření

Když spustíte příkaz rozšíření, který není nainstalovaný, azure CLI rozpozná příkaz, který spustíte, a automaticky nainstaluje rozšíření od verze 2.10.0. Tato funkce, která se označuje jako dynamická instalace, je ve výchozím nastavení povolena, protože 2.12.0. Můžete ho také povolit prostřednictvím konfigurace pro předchozí podporované verze.

az config set extension.use_dynamic_install=yes_prompt

Pomocí následujícího příkazu konfigurace povolte dynamickou instalaci bez výzvy.

az config set extension.use_dynamic_install=yes_without_prompt

Pomocí následujícího příkazu konfigurace vypněte funkci dynamické instalace a vraťte se k výchozímu chování. Příkaz rozšíření vrátí chybu typu command-not-found, pokud rozšíření není nainstalované.

az config set extension.use_dynamic_install=no

Ve výchozím nastavení se příkaz rozšíření, který zobrazí výzvu k dynamické instalaci, bude po instalaci rozšíření dál spouštět. Můžete změnit výchozí chování a ukončit příkaz bez opětovného spuštění nastavením run_after_dynamic_install vlastnosti na no.

az config set extension.run_after_dynamic_install=no

Aktualizace rozšíření

Pokud se rozšíření instalovalo podle názvu, můžete ho aktualizovat pomocí příkazu az extension update.

az extension update --name <extension-name>

V opačném případě se rozšíření může aktualizovat ze zdroje podle pokynů pro instalaci rozšíření.

Pokud rozhraní příkazového řádku nerozpozná název rozšíření, odinstalujte ho a zkuste ho přeinstalovat. Je také možné, že se toto rozšíření stalo součástí základního rozhraní příkazového řádku. Zkuste aktualizovat CLI podle postupu popsaného v tématu Instalace Azure CLI a podívejte se, jestli se přidaly příkazy rozšíření.

Odinstalace rozšíření

Pokud rozšíření už nepotřebujete, odeberte ho pomocí příkazu az extension remove.

az extension remove --name <extension-name>

Rozšíření můžete také odebrat ručně, a to odstraněním z umístění, kam se nainstalovalo. Proměnná prostředí $AZURE_EXTENSION_DIR definuje, kde se instalují moduly. Pokud tato proměnná není nastavena, její výchozí hodnota v Linuxu a macOS je $HOME/.azure/cliextensions a ve Windows to je %USERPROFILE%\.azure\cliextensions.

rm -rf $AZURE_EXTENSION_DIR/<extension-name>

Časté otázky

Tady jsou odpovědi na další běžné otázky ohledně rozšíření rozhraní příkazového řádku.

Které formáty souborů jsou povolené pro instalaci?

V současnosti se jako rozšíření dají nainstalovat jenom zkompilované soubory wheel Pythonu.

Mohou rozšíření nahradit stávající příkazy?

Ano. Rozšíření mohou nahradit existující příkazy, ale před spuštěním příkazu, který se nahradil, rozhraní příkazového řádku zobrazí upozornění.

Jak poznám, že rozšíření je v předběžné verzi?

Správa verzí a dokumentace k rozšíření uvádějí, jestli se jedná o předběžnou verzi. Microsoft často vydává příkazy ve verzi Preview jako rozšíření rozhraní příkazového řádku, s možností přesunout je později do hlavního produktu CLI. Když se příkazy vyřadí z rozšíření, měla by se stará rozšíření odinstalovat.

Mohou na sobě rozšíření vzájemně záviset?

No. Vzhledem k tomu, že rozhraní příkazového řádku nezaručuje pořadí načítání, nemusí být splněné závislosti. Odebrání rozšíření nemá na ostatní žádný vliv.

Aktualizují se rozšíření současně s rozhraním příkazového řádku?

No. Rozšíření se musí aktualizovat samostatně, jak je popsáno v části věnované aktualizaci rozšíření.

Jak vyvíjet vlastní rozšíření?

Další pomoc najdete v oficiálním úložišti. Azure/azure-cli-extensions