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

az vm run-command

  • Ссылка

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

Дополнительные сведения см. в разделе https://learn.microsoft.com/azure/virtual-machines/windows/run-command или https://learn.microsoft.com/azure/virtual-machines/linux/run-command.

Команды

Имя Описание Тип Состояние
az vm run-command create

Операция создания команды выполнения.

 Ядро ГА
az vm run-command delete

Операция удаления команды выполнения.

 Ядро ГА
az vm run-command invoke

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

 Ядро ГА
az vm run-command list

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

 Ядро ГА
az vm run-command show

Получите определенную команду запуска.

 Ядро ГА
az vm run-command update

Операция обновления команды выполнения.

 Ядро ГА
az vm run-command wait

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

 Ядро ГА

az vm run-command create

Изменить

Операция создания команды выполнения.

az vm run-command create --name
                         --resource-group
                         --vm-name
                         [--async-execution {false, true}]
                         [--command-id]
                         [--error-blob-uri]
                         [--location]
                         [--no-wait]
                         [--output-blob-uri]
                         [--parameters]
                         [--protected-parameters]
                         [--run-as-password]
                         [--run-as-user]
                         [--script]
                         [--script-uri]
                         [--tags]
                         [--timeout-in-seconds]

Примеры

Создайте команду выполнения.

az vm run-command create --resource-group "myResourceGroup" --location "West US" --async-execution false --parameters arg1=param1 arg2=value1 --run-as-password "<runAsPassword>" --run-as-user "user1" --script "Write-Host Hello World!" --timeout-in-seconds 3600 --run-command-name "myRunCommand" --vm-name "myVM"

Создайте команду выполнения с отправкой потока выходных данных скрипта в BLOB-объект хранилища Azure (URI SAS).

az vm run-command create --resource-group "myResourceGroup" --location "West US" --script "Write-Host Hello World!" --run-command-name "myRunCommand" --vm-name "myVM" --output-blob-uri "https://mystorageaccount.blob.core.windows.net/mycontainer/RuncommandOutput.txt?sp=racw&st=2022-10-17T19:02:15Z&se=2022-10-18T03:02:15Z&spr=https&sv=2021-06-08&sr=b&sig=3BxtEasfdasdfasdfdYki9yvYsqc60V0%3D"

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

--name --run-command-name

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

--resource-group -g

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

--vm-name

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

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

--async-execution

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

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

Укажите идентификатор командной строки предопределенного встроенного скрипта.

--error-blob-uri

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

--location -l

Местоположение. Значения из az account list-locations. Расположение по умолчанию можно настроить с помощью az configure --defaults location=<location>.

--no-wait

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

Default value: False
--output-blob-uri

Укажите большой двоичный объект хранилища Azure (URI SAS), в котором будет отправлен выходной поток скрипта.

--parameters

Параметры, используемые скриптом.

Использование: --parameters arg1=XX arg2=XX.

--protected-parameters

Параметры, используемые скриптом.

Использование: --protected-parameters credentials=somefoo secret=somebar.

--run-as-password

Пароль при необходимости для использования параметра run-as-user. Он будет зашифрован и не зарегистрирован.

--run-as-user

По умолчанию процесс скрипта выполняется под системным или корневым пользователем. Укажите настраиваемого пользователя для размещения процесса.

--script

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

--script-uri

Укажите расположение загрузки скрипта.

--tags

Теги, разделенные пробелами: key[=value] [key[=value] ...]. Используйте "" для очистки существующих тегов.

--timeout-in-seconds

Время ожидания в секундах для выполнения команды выполнения.

Глобальные параметры
--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 run-command delete

Изменить

Операция удаления команды выполнения.

az vm run-command delete --name
                         [--ids]
                         [--no-wait]
                         [--resource-group]
                         [--subscription]
                         [--vm-name]
                         [--yes]

Примеры

Удаление команды выполнения.

az vm run-command delete --resource-group "myResourceGroup" --run-command-name "myRunCommand" --vm-name "myVM"

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

--name --run-command-name

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

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

--ids

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

--no-wait

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

Default value: False
--resource-group -g

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

--subscription

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

--vm-name

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

--yes -y

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

Default value: False
Глобальные параметры
--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 run-command invoke

Изменить

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

az vm run-command show возвращает полезные сведения о каждой команде выполнения. Обнаружение идентификатора команды run с помощью az vmss run-command list.

az vm run-command invoke --command-id
                         [--ids]
                         [--name]
                         [--no-wait]
                         [--parameters]
                         [--resource-group]
                         [--scripts]
                         [--subscription]

Примеры

Установите nginx на виртуальной машине Linux.

az vm run-command invoke -g MyResourceGroup -n MyVm --command-id RunShellScript --scripts "sudo apt-get update && sudo apt-get install -y nginx"

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

az vm run-command invoke -g MyResourceGroup -n MyVm --command-id RunShellScript --scripts 'echo $1 $2' --parameters hello world

Запустите скрипт PowerShell на виртуальной машине Windows с параметрами. Встроенный скрипт. Будьте осторожны с одним цитатой в CMD.exe.

az vm run-command invoke  --command-id RunPowerShellScript --name win-vm -g my-resource-group  \
    --scripts 'param([string]$arg1,[string]$arg2)' \
    'Write-Host This is a sample script with parameters $arg1 and $arg2' \
    --parameters 'arg1=somefoo' 'arg2=somebar'

Запустите скрипт PowerShell на виртуальной машине Windows с параметрами. Скрипт, предоставленный из файла.

# script.ps1
#   param(
#       [string]$arg1,
#       [string]$arg2
#   )
#   Write-Host This is a sample script with parameters $arg1 and $arg2

az vm run-command invoke  --command-id RunPowerShellScript --name win-vm -g my-resource-group \
    --scripts @script.ps1 --parameters "arg1=somefoo" "arg2=somebar"

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

--command-id

Идентификатор команды.

Значение из: az vm run-command list

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

--ids

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

--name -n

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

--no-wait

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

Default value: False
--parameters

Разделенные пробелами параметры в формате "[name=]value".

--resource-group -g

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

--scripts

Строки скрипта, разделенные пробелами. Используйте @{file} для загрузки скрипта из файла.

--subscription

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

Глобальные параметры
--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 run-command list

Изменить

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

Вы можете указать "--resource-group" и "--vm-name", чтобы получить все команды выполнения виртуальной машины. Кроме того, можно указать "-location" для перечисления всех доступных команд выполнения для подписки в расположении.

az vm run-command list [--expand]
                       [--location]
                       [--resource-group]
                       [--vm-name]

Примеры

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

az vm run-command list --resource-group "myResourceGroup" --vm-name "myVM"

Перечислить все доступные команды выполнения для подписки в расположении.

az vm run-command list --location "SoutheastAsia"

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

--expand

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

--location -l

Местоположение. Значения из az account list-locations. Расположение по умолчанию можно настроить с помощью az configure --defaults location=<location>.

--resource-group -g

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

--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 run-command show

Изменить

Получите определенную команду запуска.

Вы можете указать "--resource-group", "--run-command-name" и "--vm-name", чтобы получить команду выполнения в виртуальной машине. Кроме того, можно указать "--command-id" и "-location", чтобы получить команду выполнения для подписки в расположении.

az vm run-command show [--command-id]
                       [--ids]
                       [--instance-view]
                       [--location]
                       [--name]
                       [--resource-group]
                       [--subscription]
                       [--vm-name]

Примеры

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

az vm run-command show --resource-group "myResourceGroup" --run-command-name "myRunCommand" --vm-name "myVM"

Получите определенную команду запуска для подписки в расположении.

az vm run-command show --command-id "RunPowerShellScript" --location "SoutheastAsia"

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

--command-id

Идентификатор команды.

--ids

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

--instance-view

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

Default value: False
--location -l

Местоположение. Значения из az account list-locations. Расположение по умолчанию можно настроить с помощью az configure --defaults location=<location>.

--name --run-command-name

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

--resource-group -g

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

--subscription

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

--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 run-command update

Изменить

Операция обновления команды выполнения.

az vm run-command update --name
                         [--async-execution {false, true}]
                         [--command-id]
                         [--error-blob-uri]
                         [--ids]
                         [--location]
                         [--no-wait]
                         [--output-blob-uri]
                         [--parameters]
                         [--protected-parameters]
                         [--resource-group]
                         [--run-as-password]
                         [--run-as-user]
                         [--script]
                         [--script-uri]
                         [--subscription]
                         [--tags]
                         [--timeout-in-seconds]
                         [--vm-name]

Примеры

Обновите команду выполнения.

az vm run-command update --resource-group "myResourceGroup" --location "West US" --async-execution false --parameters arg1=param1 arg2=value1 --run-as-password "<runAsPassword>" --run-as-user "user1" --script "Write-Host Hello World!" --timeout-in-seconds 3600 --run-command-name "myRunCommand" --vm-name "myVM"

Обновите команду выполнения с отправкой потока выходных данных скрипта в БОЛЬШОЙ двоичный объект хранилища Azure (URI SAS).

az vm run-command update --resource-group "myResourceGroup" --location "West US" --script "Write-Host Hello World!" --run-command-name "myRunCommand" --vm-name "myVM" --output-blob-uri "https://mystorageaccount.blob.core.windows.net/mycontainer/RuncommandOutput.txt?sp=racw&st=2022-10-17T19:02:15Z&se=2022-10-18T03:02:15Z&spr=https&sv=2021-06-08&sr=b&sig=3BxtEasfdasdfasdfdYki9yvYsqc60V0%3D"

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

--name --run-command-name

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

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

--async-execution

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

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

Укажите идентификатор командной строки предопределенного встроенного скрипта.

--error-blob-uri

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

--ids

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

--location -l

Местоположение. Значения из az account list-locations. Расположение по умолчанию можно настроить с помощью az configure --defaults location=<location>.

--no-wait

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

Default value: False
--output-blob-uri

Укажите большой двоичный объект хранилища Azure (URI SAS), в котором будет отправлен выходной поток скрипта.

--parameters

Параметры, используемые скриптом.

Использование: --parameters arg1=XX arg2=XX.

--protected-parameters

Параметры, используемые скриптом.

Использование: --protected-parameters credentials=somefoo secret=somebar.

--resource-group -g

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

--run-as-password

Пароль при необходимости для использования параметра run-as-user. Он будет зашифрован и не зарегистрирован.

--run-as-user

По умолчанию процесс скрипта выполняется под системным или корневым пользователем. Укажите настраиваемого пользователя для размещения процесса.

--script

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

--script-uri

Укажите расположение загрузки скрипта.

--subscription

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

--tags

Теги, разделенные пробелами: key[=value] [key[=value] ...]. Используйте "" для очистки существующих тегов.

--timeout-in-seconds

Время ожидания в секундах для выполнения команды выполнения.

--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 run-command wait

Изменить

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

az vm run-command wait [--command-id]
                       [--created]
                       [--custom]
                       [--deleted]
                       [--exists]
                       [--ids]
                       [--instance-view]
                       [--interval]
                       [--location]
                       [--name]
                       [--resource-group]
                       [--subscription]
                       [--timeout]
                       [--updated]
                       [--vm-name]

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

--command-id

Идентификатор команды.

--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'.

--instance-view

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

Default value: False
--interval

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

Default value: 30
--location -l

Местоположение. Значения из az account list-locations. Расположение по умолчанию можно настроить с помощью az configure --defaults location=<location>.

--name --run-command-name

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

--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

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

Глобальные параметры
--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.