Zarządzanie rozszerzeniami interfejsu wiersza polecenia platformy Azure: instalowanie, aktualizowanie i usuwanie

Interfejs wiersza polecenia platformy Azure umożliwia ładowanie rozszerzeń. Rozszerzenia interfejsu wiersza polecenia platformy Azure są scharakteryzowane jako koła języka Python, które nie są dostarczane jako część interfejsu wiersza polecenia, ale działają jako polecenia interfejsu wiersza polecenia. W przypadku rozszerzeń uzyskujesz dostęp do poleceń eksperymentalnych i w wersji przedpremierowej, a także możliwość tworzenia własnych interfejsów wiersza polecenia. W tym artykule opisano sposób zarządzania rozszerzeniami oraz udzielono odpowiedzi na często zadawane pytania dotyczące ich użycia.

Jak znaleźć rozszerzenia

Aby wyświetlić rozszerzenia interfejsu wiersza polecenia platformy Azure, które są dostarczane i obsługiwane przez firmę Microsoft, użyj polecenia az extension list-available.

az extension list-available --output table

Lista rozszerzeń znajduje się również w witrynie z dokumentacją.

Jak zainstalować rozszerzenia

Ręczne instalowanie rozszerzeń

Po znalezieniu rozszerzenia do zainstalowania, użyj az extension add aby je zainstalować. Jeśli rozszerzenie pojawi się w danych wyjściowych az extension list-available, możesz zainstalować je według nazwy.

az extension add --name <extension-name>

Jeśli rozszerzenie pochodzi z zewnętrznego zasobu lub masz bezpośredni link do niego, podaj źródłowy adres URL lub ścieżkę lokalną. Rozszerzenie musi być skompilowanym plikiem wheel języka Python.

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

Możesz również utworzyć prywatny indeks rozszerzeń zgodnie z formatem w index.json, a następnie od wersji 2.20.0 ustawić adres URL indeksu rozszerzeń używanego przez Azure CLI na ten indeks. Następnie można zainstalować rozszerzenie po nazwie z indeksu prywatnych rozszerzeń.

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

Po zainstalowaniu rozszerzenia zostanie ono wyświetlone pod wartością zmiennej $AZURE_EXTENSION_DIR powłoki. Jeśli ta zmienna nie jest ustawiona, domyślną lokalizacją jest $HOME/.azure/cliextensions system Linux i macOS oraz %USERPROFILE%\.azure\cliextensions w systemie Windows.

Automatyczne instalowanie rozszerzeń

Po uruchomieniu polecenia rozszerzenia, które nie jest zainstalowane, interfejs wiersza polecenia platformy Azure może rozpoznać uruchamiane polecenie i automatycznie zainstalować rozszerzenie, począwszy od wersji 2.10.0. Ta funkcja, znana jako instalacja dynamiczna, jest domyślnie włączona, począwszy od wersji 2.12.0. Można ją również włączyć za pomocą konfiguracji dla poprzednich obsługiwanych wersji.

az config set extension.use_dynamic_install=yes_prompt

Użyj następującego polecenia konfiguracji, aby włączyć instalację dynamiczną bez monitu.

az config set extension.use_dynamic_install=yes_without_prompt

Użyj następującego polecenia konfiguracji, aby wyłączyć funkcję instalacji dynamicznej, aby przywrócić domyślne zachowanie. Polecenie rozszerzenia zwraca błąd polecenia nie znaleziono, jeśli rozszerzenie nie jest zainstalowane.

az config set extension.use_dynamic_install=no

Domyślnie polecenie rozszerzenia, które wyświetla monit o instalację dynamiczną, będzie nadal działać po zainstalowaniu rozszerzenia. Możesz zmienić domyślne zachowanie i zakończyć działanie polecenia bez ponownego uruchomienia, ustawiając run_after_dynamic_install właściwość na no.

az config set extension.run_after_dynamic_install=no

Jak aktualizować rozszerzenia

Jeśli zainstalujesz rozszerzenie według nazwy, zaktualizuj je za pomocą polecenia az extension update.

az extension update --name <extension-name>

W przeciwnym razie rozszerzenie może zostać zaktualizowane za pomocą źródła, postępując zgodnie z instrukcjami w artykule Instalowanie rozszerzeń.

Jeśli nie możesz użyć interfejsu wiersza polecenia, aby rozpoznać nazwę rozszerzenia, odinstaluj rozszerzenie i spróbuj go ponownie zainstalować. Rozszerzenie może być również częścią podstawowego CLI. Zaktualizuj interfejs wiersza polecenia zgodnie z opisem w temacie Instalowanie interfejsu wiersza polecenia platformy Azure i sprawdź, czy polecenia rozszerzenia są dostępne.

Jak odinstalować rozszerzenia

Jeśli rozszerzenie nie jest już potrzebne, usuń je za pomocą polecenia az extension remove.

az extension remove --name <extension-name>

Rozszerzenie można również usunąć ręcznie, usuwając je z lokalizacji, w którym zostało zainstalowane. Zmienna powłoki $AZURE_EXTENSION_DIR określa miejsce instalowania modułów. Jeśli nie ustawiono tej zmiennej, domyślnie wartością jest $HOME/.azure/cliextensions w systemie Linux i macOS i %USERPROFILE%\.azure\cliextensions w systemie Windows.

rm -rf $AZURE_EXTENSION_DIR/<extension-name>

Często zadawane pytania

Poniżej przedstawiono odpowiedzi na inne typowe pytania dotyczące rozszerzeń interfejsu wiersza polecenia.

Jakie formaty plików są dozwolone w przypadku instalacji?

Obecnie tylko skompilowane pakiety Python wheel mogą być instalowane jako rozszerzenia.

Czy rozszerzenia mogą zastępować istniejące polecenia?

Tak. Rozszerzenia mogą zastąpić istniejące polecenia, ale interfejs wiersza polecenia wyświetla ostrzeżenie przed uruchomieniem zastąpionego polecenia.

Jak sprawdzić, czy rozszerzenie jest w wersji wstępnej?

Dokumentacja i kontrola wersji rozszerzenia pokazują, czy jest w wersji wstępnej. Firma Microsoft często publikuje polecenia w wersji zapoznawczej jako rozszerzenia interfejsu wiersza polecenia z opcją przeniesienia ich do głównego produktu interfejsu wiersza polecenia w późniejszym czasie. Po przeniesieniu polecenia z rozszerzeń należy odinstalować starą wersję.

Czy rozszerzenia mogą zależeć od siebie?

Nie. Ponieważ interfejs wiersza polecenia nie gwarantuje kolejności ładowania, może wystąpić problem z niespełnieniem zależności. Usunięcie rozszerzenia nie ma wpływu na inne.

Czy rozszerzenia są aktualizowane razem z interfejsem wiersza polecenia?

Nie. Rozszerzenia muszą być aktualizowane oddzielnie, zgodnie z opisem w sekcji Aktualizowanie rozszerzeń.

Jak opracować własne rozszerzenie?

Aby uzyskać więcej pomocy, zapoznaj się z oficjalnym repozytorium. Azure/azure-cli-extensions