Azure CLI-extensies beheren: installeren, bijwerken en verwijderen

De Azure CLI biedt de mogelijkheid om extensies te laden. Extensies voor de Azure CLI worden gekenmerkt als Python-wielen die niet worden verzonden als onderdeel van de CLI, maar worden uitgevoerd als CLI-opdrachten. Met extensies krijgt u toegang tot experimentele en voorlopige opdrachten, samen met de mogelijkheid om uw eigen CLI-interfaces te schrijven. In dit artikel wordt uitgelegd hoe u extensies kunt beheren en worden antwoorden op veelgestelde vragen over het gebruik ervan gegeven.

Extensies zoeken

Gebruik de opdracht az extension list-available om de Azure CLI-extensies te zien die door Microsoft worden geleverd en onderhouden.

az extension list-available --output table

We hosten ook een lijst met extensies op de documentatiesite.

Hoe installeer je extensies

Extensies handmatig installeren

Nadat u een extensie hebt gevonden die u wilt installeren, gebruikt u az extension add om deze te installeren. Als de extensie wordt weergegeven in de uitvoer van az extension list-available, kunt u deze op naam installeren.

az extension add --name <extension-name>

Als de extensie van een externe bron komt of u over een directe koppeling beschikt, kunt u de bron-URL of het lokale pad opgeven. De extensie moet een gecompileerd Python-wielbestand zijn.

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

U kunt ook een persoonlijke extensie-index maken volgens de indeling in index.jsonen vervolgens de URL van de extensie-index instellen die door Azure CLI wordt gebruikt vanaf versie 2.20.0. Daarna kunt u de extensie op naam installeren vanuit de privé-extensie-index.

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

Nadat u een extensie hebt geïnstalleerd, wordt deze weergegeven onder de waarde van de $AZURE_EXTENSION_DIR shell-variabele. Als deze variabele niet is ingesteld, bevindt de standaardlocatie zich $HOME/.azure/cliextensions in Linux en macOS en %USERPROFILE%\.azure\cliextensions in Windows.

Extensies automatisch installeren

Wanneer u een extensieopdracht uitvoert die niet is geïnstalleerd, kan de Azure CLI de opdracht die u uitvoert herkennen en de extensie automatisch installeren vanaf versie 2.10.0. Deze functie, ook wel dynamische installatie genoemd, is standaard ingeschakeld vanaf versie 2.12.0. U kunt deze ook inschakelen via configuratie voor eerdere ondersteunde versies.

az config set extension.use_dynamic_install=yes_prompt

Gebruik de volgende configuratieopdracht om dynamische installatie in te schakelen zonder een prompt.

az config set extension.use_dynamic_install=yes_without_prompt

Gebruik de volgende configuratieopdracht om de functie voor dynamische installatie uit te schakelen om terug te keren naar het standaardgedrag. De extensieopdracht retourneert een "opdracht niet gevonden"-fout als de extensie niet is geïnstalleerd.

az config set extension.use_dynamic_install=no

Standaard blijft een opdracht van een extensie die vraagt om een dynamische installatie, doorgaan nadat de extensie is geïnstalleerd. U kunt het standaardgedrag wijzigen en de opdracht afsluiten zonder opnieuw uit te voeren door de run_after_dynamic_install eigenschap in te stellen op no.

az config set extension.run_after_dynamic_install=no

Extensies bijwerken

Als u een extensie op naam installeert, werkt u deze bij met behulp van az extension update.

az extension update --name <extension-name>

Anders kan een extensie worden bijgewerkt vanuit de bron door de instructies voor installatie-extensies te volgen.

Als u de CLI niet kunt gebruiken om een extensienaam op te lossen, verwijdert u de extensie en installeert u de extensie opnieuw. De extensie maakt mogelijk ook deel uit van de basis-CLI. Werk de CLI bij zoals beschreven in De Azure CLI installeren en controleer of de opdrachten van de extensie beschikbaar zijn.

Extensies verwijderen

Als u een extensie niet meer nodig hebt, verwijdert u deze met az extension remove.

az extension remove --name <extension-name>

U kunt een extensie ook handmatig verwijderen door deze te verwijderen van de locatie waar deze is geïnstalleerd. De $AZURE_EXTENSION_DIR shell-variabele definieert waar modules worden geïnstalleerd. Als deze variabele niet is ingesteld, is de standaardwaarde in Linux en MacOS $HOME/.azure/cliextensions en in Windows %USERPROFILE%\.azure\cliextensions.

rm -rf $AZURE_EXTENSION_DIR/<extension-name>

Veelgestelde vragen

Hier volgen enkele antwoorden op andere veelgestelde vragen over CLI-extensies.

Welke bestandsindelingen zijn toegestaan voor installatie?

Momenteel kunnen alleen gecompileerde Python-wielen worden geïnstalleerd als extensies.

Kunnen extensies bestaande opdrachten vervangen?

Ja. Extensies kunnen bestaande opdrachten vervangen, maar de CLI geeft een waarschuwing uit voordat u een vervangen opdracht uitvoert.

Hoe kan ik zien of een extensie in prerelease staat?

In de documentatie en versiebeheer van een extensie wordt getoond of deze zich in prerelease bevindt. Microsoft brengt vaak preview-opdrachten uit als CLI-extensies, met de optie om ze later naar het belangrijkste CLI-product te verplaatsen. Wanneer opdrachten uit extensies worden verplaatst, moet de oude extensie worden verwijderd.

Kunnen extensies afhankelijk zijn van elkaar?

Nee. Omdat de CLI geen belastingsvolgorde garandeert, zijn er mogelijk niet aan afhankelijkheden voldaan. Het verwijderen van een extensie heeft geen invloed op andere.

Worden extensies bijgewerkt samen met de CLI?

Nee. Extensies moeten afzonderlijk worden bijgewerkt, zoals beschreven in Update-extensies.

Hoe kan ik onze eigen extensie ontwikkelen?

Raadpleeg de officiële opslagplaats voor meer hulp. Azure/azure-cli-extensions