az vm extension

  • Ссылка

Управление расширениями на виртуальных машинах.

Расширения — это небольшие приложения, которые предоставляют задачи конфигурации после развертывания и автоматизации на виртуальных машинах Azure. Например, если на виртуальной машине нужно установить программное обеспечение, настроить антивирусную защиту или конфигурацию Docker, это можно сделать с помощью расширения виртуальной машины (далее — расширение ВМ). Расширения можно использовать при развертывании новой виртуальной машины или запускать на любой из существующих систем.

Команды

Имя Описание Тип Состояние
az vm extension delete

Операция удаления расширения.

 Основные сведения Общедоступная версия
az vm extension image

Найдите доступные расширения виртуальной машины для подписки и региона.

 Основные сведения Общедоступная версия
az vm extension image list

Список сведений о доступных расширениях.

 Основные сведения Общедоступная версия
az vm extension image list-names

Список имен доступных расширений.

 Основные сведения Общедоступная версия
az vm extension image list-versions

Список версий доступных расширений.

 Основные сведения Общедоступная версия
az vm extension image show

Отображение сведений о расширении.

 Основные сведения Общедоступная версия
az vm extension list

Вывод списка расширений, подключенных к виртуальной машине.

 Основные сведения Общедоступная версия
az vm extension set

Задайте расширения для виртуальной машины.

 Основные сведения Общедоступная версия
az vm extension show

Отображение сведений о расширениях, подключенных к виртуальной машине.

 Основные сведения Общедоступная версия
az vm extension wait

Поместите интерфейс командной строки в состояние ожидания до тех пор, пока не будет выполнено условие расширения виртуальной машины.

 Основные сведения Общедоступная версия

az vm extension delete

Изменить

Операция удаления расширения.

az vm extension delete [--ids]
                       [--name]
                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                       [--resource-group]
                       [--subscription]
                       [--vm-name]

Примеры

Используйте имя и расширение виртуальной машины для удаления расширения из виртуальной машины.

az vm extension delete -g MyResourceGroup --vm-name MyVm -n MyExtensionName

Удалите расширения с идентификаторами, содержащим строку MyExtension из виртуальной машины.

az vm extension delete --ids $(az resource list --query "[?contains(name, 'MyExtension')].id" -o tsv)

Необязательные параметры

--ids

Один или несколько идентификаторов ресурсов (через пробелы). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие аргументы Resource Id.

--name --vm-extension-name -n

Имя расширения виртуальной машины.

--no-wait

Не ожидать завершения длительной операции.

Допустимые значения: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--vm-name

Имя виртуальной машины. Вы можете настроить значение по умолчанию с помощью az configure --defaults vm=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az vm extension list

Изменить

Вывод списка расширений, подключенных к виртуальной машине.

az vm extension list [--ids]
                     [--resource-group]
                     [--subscription]
                     [--vm-name]

Примеры

Вывод списка подключенных расширений к именованной виртуальной машине.

az vm extension list -g MyResourceGroup --vm-name MyVm

Необязательные параметры

--ids

Один или несколько идентификаторов ресурсов (через пробелы). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие аргументы Resource Id.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--vm-name

Имя виртуальной машины. Вы можете настроить значение по умолчанию с помощью az configure --defaults vm=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az vm extension set

Изменить

Задайте расширения для виртуальной машины.

Получение сведений о расширении из az vm extension image list.

az vm extension set --name
                    --publisher
                    [--enable-auto-upgrade {false, true}]
                    [--extension-instance-name]
                    [--force-update]
                    [--ids]
                    [--no-auto-upgrade {false, true}]
                    [--no-auto-upgrade-minor-version {false, true}]
                    [--no-wait]
                    [--protected-settings]
                    [--resource-group]
                    [--settings]
                    [--subscription]
                    [--version]
                    [--vm-name]

Примеры

Добавьте учетную запись пользователя на виртуальную машину Linux.

az vm extension set -n VMAccessForLinux --publisher Microsoft.OSTCExtensions --version 1.4 \
    --vm-name MyVm --resource-group MyResourceGroup \
    --protected-settings '{"username":"user1", "ssh_key":"ssh_rsa ..."}'

Добавьте расширение customScript в виртуальные машины, заданные идентификаторами --ids.

az vm extension set -n customScript --publisher Microsoft.Azure.Extensions --ids {vm_id}

Добавьте расширение и включите автоматическое обновление платформы, если доступна более новая версия расширения.

az vm extension set -n extName --publisher publisher --vm-name MyVM -g MyResourceGroup \
--enable-auto-upgrade true

Обязательные параметры

--name -n

Имя расширения.

Значение из: az vm extension image list
--publisher

Имя издателя расширения.

Необязательные параметры

--enable-auto-upgrade

Укажите, что расширение должно быть автоматически обновлено платформой, если доступна более новая версия расширения.

Допустимые значения: false, true
--extension-instance-name

Имя экземпляра расширения, который можно настроить. По умолчанию: имя расширения.

--force-update

Принудительно обновляться, даже если конфигурация расширения не изменилась.

Default value: False
--ids

Один или несколько идентификаторов ресурсов (через пробелы). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие аргументы Resource Id.

--no-auto-upgrade
Не рекомендуется

Параметр "--no-auto-upgrade" устарел и будет удален в будущем выпуске. Вместо этого используйте "--no-auto-upgrade-minor-version".

Если задано, служба расширений не будет автоматически выбирать или обновляться до последней дополнительной версии, даже если расширение повторно развернуто.

Допустимые значения: false, true
Default value: False
--no-auto-upgrade-minor-version

Если задано, служба расширений не будет автоматически выбирать или обновляться до последней дополнительной версии, даже если расширение повторно развернуто.

Допустимые значения: false, true
Default value: False
--no-wait

Не ожидать завершения длительной операции.

Default value: False
--protected-settings

Защищенные параметры в формате JSON для конфиденциальной информации, например учетных данных. Путь к файлу JSON также принимается.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

--settings

Параметры расширения в формате JSON. Путь к файлу JSON также принимается.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--version

Версия расширения. Чтобы закрепить версию расширения, укажите --no-auto-upgrade-minor-version.

--vm-name

Имя виртуальной машины. Вы можете настроить значение по умолчанию с помощью az configure --defaults vm=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az vm extension show

Изменить

Отображение сведений о расширениях, подключенных к виртуальной машине.

az vm extension show [--ids]
                     [--instance-view]
                     [--name]
                     [--resource-group]
                     [--subscription]
                     [--vm-name]

Примеры

Используйте имя виртуальной машины и имя расширения для отображения расширений, подключенных к виртуальной машине.

az vm extension show -g MyResourceGroup --vm-name MyVm -n extension_name

Необязательные параметры

--ids

Один или несколько идентификаторов ресурсов (через пробелы). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие аргументы Resource Id.

--instance-view

Представление экземпляра расширения виртуальной машины.

Default value: False
--name -n

Имя расширения.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--vm-name

Имя виртуальной машины. Вы можете настроить значение по умолчанию с помощью az configure --defaults vm=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az vm extension wait

Изменить

Поместите интерфейс командной строки в состояние ожидания до тех пор, пока не будет выполнено условие расширения виртуальной машины.

az vm extension wait [--created]
                     [--custom]
                     [--deleted]
                     [--exists]
                     [--ids]
                     [--interval]
                     [--name]
                     [--resource-group]
                     [--subscription]
                     [--timeout]
                     [--updated]
                     [--vm-name]

Примеры

Поместите интерфейс командной строки в состояние ожидания до тех пор, пока не будет выполнено условие расширения виртуальной машины. (автоматическое создание)

az vm extension wait --created --name MyExtension --resource-group MyResourceGroup --vm-name MyVm

Поместите интерфейс командной строки в состояние ожидания до тех пор, пока не будет выполнено условие расширения виртуальной машины. (автоматическое создание)

az vm extension wait --exists --name MyExtension --resource-group MyResourceGroup --vm-name MyVm

Поместите интерфейс командной строки в состояние ожидания до тех пор, пока не будет выполнено условие расширения виртуальной машины. (автоматическое создание)

az vm extension wait --ids @- --name MyExtension --subscription MySubscription --updated --vm-name MyVm

Необязательные параметры

--created

Подождите, пока не будет создано с помощью provisioningState по адресу "Успешно".

Default value: False
--custom

Подождите, пока условие не будет удовлетворено пользовательским запросом JMESPath. Например, provisioningState!='InProgress', instanceView.statuses[?code='PowerState/running'].

--deleted

Дождитесь удаления.

Default value: False
--exists

Подождите, пока ресурс не существует.

Default value: False
--ids

Один или несколько идентификаторов ресурсов (через пробелы). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие аргументы Resource Id.

--interval

Интервал опроса в секундах.

Default value: 30
--name -n

Имя расширения.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--timeout

Максимальное ожидание в секундах.

Default value: 3600
--updated

Подождите, пока не будет обновлено с помощью provisioningState по адресу "Успешно".

Default value: False
--vm-name

Имя виртуальной машины. Вы можете настроить значение по умолчанию с помощью az configure --defaults vm=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.