Поделиться через

az vm extension

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

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

Команды

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

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

 Core GA
az vm extension image

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

 Core GA
az vm extension image list

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

 Core GA
az vm extension image list-names

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

 Core GA
az vm extension image list-versions

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

 Core GA
az vm extension image show

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

 Core GA
az vm extension list

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

 Core GA
az vm extension set

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

 Core GA
az vm extension show

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

 Core GA
az vm extension wait

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

 Core GA

az vm extension delete

Изменить

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

az vm extension delete [--ids]
                       [--name --vm-extension-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)

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

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

Свойство Значение
Parameter group: Resource Id Arguments
--name --vm-extension-name -n

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

Свойство Значение
Parameter group: Resource Id Arguments
--no-wait

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

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

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

Свойство Значение
Parameter group: Resource Id Arguments
--subscription

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

Свойство Значение
Parameter group: Resource Id Arguments
--vm-name

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

Свойство Значение
Parameter group: Resource Id Arguments
Глобальные параметры
--debug

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

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

Output format.

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

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

--verbose

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

Свойство Значение
Default value: False

az vm extension list

Изменить

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

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

Примеры

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

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

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

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

Свойство Значение
Parameter group: Resource Id Arguments
--resource-group -g

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

Свойство Значение
Parameter group: Resource Id Arguments
--subscription

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

Свойство Значение
Parameter group: Resource Id Arguments
--vm-name

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

Свойство Значение
Parameter group: Resource Id Arguments
Глобальные параметры
--debug

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

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

Output format.

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

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

--verbose

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

Свойство Значение
Default value: False

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

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

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--enable-auto-upgrade

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

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

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

--force-update

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

Свойство Значение
Default value: False
--ids

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

Свойство Значение
Parameter group: Resource Id Arguments
--no-auto-upgrade
Не рекомендуется

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

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

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

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

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

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

Свойство Значение
Default value: False
--protected-settings

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

--resource-group -g

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

Свойство Значение
Parameter group: Resource Id Arguments
--settings

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

--subscription

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

Свойство Значение
Parameter group: Resource Id Arguments
--version

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

--vm-name

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

Свойство Значение
Parameter group: Resource Id Arguments
Глобальные параметры
--debug

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

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

Output format.

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

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

--verbose

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

Свойство Значение
Default value: False

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

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

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

Свойство Значение
Parameter group: Resource Id Arguments
--instance-view

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

Свойство Значение
Default value: False
--name -n

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

Свойство Значение
Parameter group: Resource Id Arguments
--resource-group -g

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

Свойство Значение
Parameter group: Resource Id Arguments
--subscription

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

Свойство Значение
Parameter group: Resource Id Arguments
--vm-name

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

Свойство Значение
Parameter group: Resource Id Arguments
Глобальные параметры
--debug

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

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

Output format.

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

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

--verbose

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

Свойство Значение
Default value: False

az vm extension wait

Изменить

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

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

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

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

Свойство Значение
Parameter group: Wait Condition Arguments
Default value: False
--custom

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

Свойство Значение
Parameter group: Wait Condition Arguments
--deleted

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

Свойство Значение
Parameter group: Wait Condition Arguments
Default value: False
--exists

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

Свойство Значение
Parameter group: Wait Condition Arguments
Default value: False
--expand

Выражение расширения, применяемое к операции.

--ids

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

Свойство Значение
Parameter group: Resource Id Arguments
--interval

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

Свойство Значение
Parameter group: Wait Condition Arguments
Default value: 30
--name --vm-extension-name -n

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

Свойство Значение
Parameter group: Resource Id Arguments
--resource-group -g

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

Свойство Значение
Parameter group: Resource Id Arguments
--subscription

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

Свойство Значение
Parameter group: Resource Id Arguments
--timeout

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

Свойство Значение
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

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

Свойство Значение
Parameter group: Wait Condition Arguments
Default value: False
--vm-name

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

Свойство Значение
Parameter group: Resource Id Arguments
Глобальные параметры
--debug

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

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

Output format.

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

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

--verbose

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

Свойство Значение
Default value: False