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

az vmss run-command

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

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

Команды

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

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

 Core GA
az vmss run-command delete

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

 Core GA
az vmss run-command invoke

Выполните определенную команду выполнения в экземпляре масштабируемого набора виртуальных машин.

 Core GA
az vmss run-command list

Операция получения всех команд выполнения экземпляра в масштабируемом наборе виртуальных машин.

 Core GA
az vmss run-command show

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

 Core GA
az vmss run-command update

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

 Core GA

az vmss run-command create

Изменить

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

az vmss run-command create --instance-id
                           --name --run-command-name
                           --resource-group
                           --vmss-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]

Примеры

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

az vmss run-command create --resource-group "myResourceGroup" --instance-id "0" --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" --vmss-name "myVMSS"

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

--instance-id

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

--name --run-command-name

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

--resource-group -g

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

--vmss-name

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

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

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

--async-execution

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

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

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

--error-blob-uri

Uri (без SAS) в добавочный большой двоичный объект, в котором будет отправлен поток ошибок скрипта.

--location -l

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

--no-wait

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

Свойство Значение
Default value: False
--output-blob-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

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

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

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

--only-show-errors

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

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

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

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

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

--subscription

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

--verbose

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

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

az vmss run-command delete

Изменить

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

az vmss run-command delete --name --run-command-name
                           [--ids]
                           [--instance-id]
                           [--no-wait]
                           [--resource-group]
                           [--subscription]
                           [--vmss-name]
                           [--yes]

Примеры

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

az vmss run-command delete --resource-group "myResourceGroup" --instance-id "0" --run-command-name "myRunCommand" --vmss-name "myVMSS"

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

--name --run-command-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-id

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

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

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

Свойство Значение
Default value: False
--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
--vmss-name

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

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

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

Свойство Значение
Default value: False
Глобальные параметры
--debug

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

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

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

--only-show-errors

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

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

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

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

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

--verbose

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

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

az vmss run-command invoke

Изменить

Выполните определенную команду выполнения в экземпляре масштабируемого набора виртуальных машин.

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

az vmss run-command invoke --command-id
                           [--ids]
                           [--instance-id]
                           [--name]
                           [--parameters]
                           [--resource-group]
                           [--scripts]
                           [--subscription]

Примеры

Установите nginx на экземпляр VMSS.

az vmss run-command invoke -g MyResourceGroup -n MyVMSS --command-id RunShellScript \ --instance-id 0 --scripts "sudo apt-get update && sudo apt-get install -y nginx"

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

az vmss run-command invoke -g MyResourceGroup -n MyVMSS --command-id RunShellScript \ --instance-id 4 --scripts 'echo $1 $2' --parameters hello world

Вызовите команду во всех экземплярах VMSS с помощью идентификаторов ресурсов экземпляра VMSS. Примечание. "@-" расширяется на stdin.

az vmss list-instances -n MyVMSS -g my-rg --query "[].id" --output tsv | \
az vmss run-command invoke --scripts 'echo $1 $2' --parameters hello world  \
    --command-id RunShellScript --ids @-

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

az vmss 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' --instance-id 2

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

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

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

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

--command-id

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

Свойство Значение
Значение из: az vmss run-command list

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

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

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

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

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

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

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

--resource-group -g

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

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

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

--subscription

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

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

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

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

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

--only-show-errors

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

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

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

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

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

--verbose

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

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

az vmss run-command list

Изменить

Операция получения всех команд выполнения экземпляра в масштабируемом наборе виртуальных машин.

az vmss run-command list --instance-id
                         --resource-group
                         --vmss-name
                         [--expand]

Примеры

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

az vmss run-command list --resource-group "myResourceGroup" --vmss-name "myVMSS" --instance-id "0"

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

--instance-id

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

--resource-group -g

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

--vmss-name

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

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

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

--expand

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

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

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

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

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

--only-show-errors

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

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

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

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

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

--subscription

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

--verbose

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

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

az vmss run-command show

Изменить

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

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

Примеры

Получение команд выполнения VMSS.

az vmss run-command show --instance-id "0" --resource-group "myResourceGroup" --run-command-name "myRunCommand" --vmss-name "myVMSS"

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

--name --run-command-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-id

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

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

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

Свойство Значение
Default value: False
--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
--vmss-name

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

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

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

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

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

--only-show-errors

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

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

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

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

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

--verbose

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

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

az vmss run-command update

Изменить

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

az vmss run-command update --name --run-command-name
                           [--async-execution {false, true}]
                           [--command-id]
                           [--error-blob-uri]
                           [--ids]
                           [--instance-id]
                           [--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]
                           [--vmss-name]

Примеры

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

az vmss run-command update --resource-group "myResourceGroup" --instance-id "0" --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" --vmss-name "myVMSS"

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

--name --run-command-name

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

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

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

--async-execution

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

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

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

--error-blob-uri

Uri (без SAS) в добавочный большой двоичный объект, в котором будет отправлен поток ошибок скрипта.

--ids

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

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

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

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

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

--no-wait

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

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

Универсальный код ресурса (без SAS) в добавочный БОЛЬШОЙ двоичный объект, в котором будут отправлены выходные данные скрипта.

--parameters

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

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

--protected-parameters

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

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

--resource-group -g

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

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

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

--run-as-user

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

--script

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

--script-uri

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

--subscription

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

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

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

--timeout-in-seconds

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

--vmss-name

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

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

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

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

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

--only-show-errors

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

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

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

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

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

--verbose

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

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