Запуск скриптов в Windows VM с использованием управляемых команд выполнения

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

Эта команда предоставляет скрипт виртуальной машине, выполняет его и возвращает захваченные выходные данные.

Set-AzVMRunCommand -ResourceGroupName "myRG" -VMName "myVM" -Location "EastUS" -RunCommandName "RunCommandName" –SourceScript "echo Hello World!"

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

OutputBlobUri и ErrorBlobUri являются необязательными параметрами.

Set-AzVMRunCommand -ResourceGroupName "myRg" `
-VMName "myVM" `
-RunCommandName "RunCommandName" `
-SourceScriptUri “<SAS_URI_of_a_storage_blob_with_read_access_or_public_URI>" `
-OutputBlobUri “<SAS_URI_of_a_storage_append_blob_with_read_add_create_write_access>" `
-ErrorBlobUri “<SAS_URI_of_a_storage_append_blob_with_read_add_create_write_access>”

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

Время выполнения должно превышать время ожидания по умолчанию, равное 90 минутам. Он должен выполняться в течение 100 минут (см. параметр TimeoutInSecond на 6,000 секунд), если ожидается, что скрипт будет выполняться так долго. Через 100 минут выполнение скрипта должно остановиться.

Set-AzVMRunCommand -ResourceGroupName MyRG -VMName MyVM -RunCommandName MyRunCommand -Location EastUS2EUAP -SourceScriptUri <SourceScriptUri> -AsyncExecution -TimeoutInSecond 6000

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

Эта команда возвращает полный список ранее развернутых команд выполнения вместе со своими свойствами.

Get-AzVMRunCommand -ResourceGroupName "myRG" -VMName "myVM"

Получение состояния выполнения и результатов

Эта команда извлекает текущий ход выполнения, включая последние выходные данные, время начала и окончания, код выхода и состояние терминала выполнения.

Get-AzVMRunCommand -ResourceGroupName "myRG" -VMName "myVM" -RunCommandName "RunCommandName" -Expand InstanceView

Создание или обновление команды запуска на виртуальной машине с помощью SourceScriptUri (URL-адрес SAS BLOB-объекта хранилища)

Создайте или обновите команду запуска на виртуальной машине Windows, используя SAS URL блоба хранилища, содержащего скрипт PowerShell. SourceScriptUri может быть полным URL-адресом SAS или общедоступным URL-адресом BLOB-объекта хранилища.

Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVMEE -RunCommandName MyRunCommand -Location EastUS2EUAP -SourceScriptUri <SourceScriptUri>

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

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

$x = Get-AzVMRunCommand -ResourceGroupName MyRG -VMName MyVM -RunCommandName MyRunCommand -Expand InstanceView
$x.InstanceView

Пример результата

ExecutionState   : Succeeded
ExecutionMessage :
ExitCode         : 0
Output           :   
output       : uid=0(root) gid=0(root) groups=0(root)
                   HelloWorld

Error            :
StartTime        : 10/27/2022 9:10:52 PM
EndTime          : 10/27/2022 9:10:55 PM
Statuses         :

InstanceView.ExecutionState: состояние скрипта запуска команды пользователя. Обратитесь к этому состоянию, чтобы узнать, был ли скрипт успешным или нет. ProvisioningState: состояние полной подготовки общего расширения от начала до конца (завершила ли платформа расширений выполнение сценария команды запуска или нет).

Создание или обновление команды run на виртуальной машине с помощью ScriptLocalPath (локальный файл скрипта)

Создайте или обновите команду запуска на виртуальной машине с помощью локального файла скрипта, который находится на клиентском компьютере, где выполняется командлет.

Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVMEE -RunCommandName MyRunCommand -Location EastUS2EUAP -ScriptLocalPath "C:\MyScriptsDir\MyScript.ps1"

Создание или обновление команды запуска на виртуальной машине с помощью SourceScript (текст скрипта)

Создайте или обновите команду запуска на виртуальной машине, передавая содержимое скрипта непосредственно параметру -SourceScript. Использование ; для разделения нескольких команд

Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVML -RunCommandName MyRunCommand2 -Location EastUS2EUAP -SourceScript "id; echo HelloWorld"

Создание или обновление команды run на виртуальной машине с помощью SourceCommandId

Создайте или обновите команду run на виртуальной машине с помощью предварительного идентификатора commandId. Доступные командные идентификаторы можно получить с помощью Get-AzVMRunCommandDocument.

Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVMEE -RunCommandName MyRunCommand -Location EastUS2EUAP -SourceCommandId DisableWindowsUpdate

Создание или обновление команды выполнения на виртуальной машине с помощью OutputBlobUri, ErrorBlobUri для потоковой передачи стандартных выходных данных и стандартных сообщений об ошибках для вывода и добавления больших двоичных объектов

Создайте или обновите команду run на виртуальной машине и потоковую передачу стандартных выходных данных и стандартных сообщений об ошибках для вывода и добавления больших двоичных объектов.

Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVML -RunCommandName MyRunCommand3 -Location EastUS2EUAP -ScriptLocalPath "C:\MyScriptsDir\MyScript.ps1" -OutputBlobUri <OutPutBlobUrI> -ErrorBlobUri "ErrorBlobUri

Создание или обновление команды run на виртуальной машине в качестве другого пользователя с помощью параметров RunAsUser и RunAsPassword

Создайте или обновите команду выполнения на ВМ в качестве другого пользователя с помощью параметров RunAsUser и RunAsPassword. Чтобы RunAs функционировал должным образом, обратитесь к администратору виртуальной машины и убедитесь, что пользователь добавлен на виртуальной машине, имеет доступ к ресурсам, к которым обращается команда Run (каталоги, файлы, сеть и так далее), а в случае с виртуальной машиной Windows служба "Вторичный вход" запущена на виртуальной машине.

Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVMEE -RunCommandName MyRunCommand -Location EastUS2EUAP -ScriptLocalPath "C:\MyScriptsDir\MyScript.ps1" -RunAsUser myusername -RunAsPassword mypassword

Создавайте или обновляйте команду Run в ресурсе наборов масштабируемых виртуальных машин с помощью SourceScriptUri (URL-адрес SAS для BLOB-объекта хранилища)

Создайте или обновите команду выполнения на ресурсе масштабируемых наборов виртуальных машин Windows, используя SAS URL-адрес большого двоичного объекта хранилища, содержащего скрипт PowerShell.

Set-AzVmssVMRunCommand -ResourceGroupName MyRG0 -VMScaleSetName MyVMSS -InstanceId 0 -RunCommandName MyRunCommand -Location EastUS2EUAP -SourceScriptUri <SourceScriptUri>

Создайте или обновите команду Run в экземпляре виртуальной машины с использованием параметров Parameter и ProtectedParameter (публичные и защищенные параметры для сценария).

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

$PublicParametersArray = @([Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20210701.IRunCommandInputParameter]@{name='publicParam1';value='publicParam1value'},
>> [Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20210701.IRunCommandInputParameter]@{name='publicParam2';value='publicParam2value'})

$ProtectedParametersArray = @([Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20210701.IRunCommandInputParameter]@{name='secret1';value='secret1value'},
>> [Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20210701.IRunCommandInputParameter]@{name='secret2';value='secret2value'})

Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVMEE -RunCommandName MyRunCommand -Location EastUS2EUAP -SourceScriptUri <SourceScriptUri> -Parameter $PublicParametersArray -ProtectedParameter $ProtectedParametersArray

• Windows: Параметры и ProtectedParameters передаются скрипту в виде аргументов и запускаются следующим образом - myscript.ps1 -publicParam1 publicParam1value -publicParam2 publicParam2value -secret1 secret1value -secret2 secret2value

• Linux: именованные параметры и его значения задаются в конфигурации среды, которая должна быть доступна в скрипте .sh. Для аргументов без имен передайте пустую строку для ввода имени. Безымянные аргументы передаются в скрипт и выполняются следующим образом: myscript.sh publicParam1value publicParam2value secret1value secret2value

Удаление ресурса RunCommand из виртуальной машины

Удалите ресурс RunCommand, ранее развернутый на виртуальной машине. Если скрипт всё ещё выполняется, выполнение прекращается.

Remove-AzVMRunCommand -ResourceGroupName "myRG" -VMName "myVM" -RunCommandName "RunCommandName"

Ниже приведен пример с использованием команды az vm run-command для запуска сценария оболочки на виртуальной машине Windows Azure.

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

Эта команда предоставляет скрипт виртуальной машине, выполняет его и возвращает захваченные выходные данные.

az vm run-command create --name "myRunCommand" --vm-name "myVM" --resource-group "myRG" --script "Write-Host Hello World!"

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

Эта команда возвращает полный список ранее развернутых команд выполнения вместе со своими свойствами.

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

Получение состояния выполнения и результатов

Эта команда извлекает текущий ход выполнения, включая последние выходные данные, время начала и окончания, код выхода и состояние терминала выполнения.

az vm run-command show --name "myRunCommand" --vm-name "myVM" --resource-group "myRG" --expand instanceView

Удаление ресурса RunCommand из виртуальной машины

Удалите ресурс RunCommand, ранее развернутый на виртуальной машине. Если скрипт всё ещё выполняется, выполнение прекращается.

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

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

PUT /subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>/providers/Microsoft.Compute/virtualMachines/<vmName>/runcommands/<runCommandName>?api-version=2023-03-01

{ 
"location": "<location>", 
"properties": { 
    "source": { 
        "script": "Write-Host Hello World!", 
        "scriptUri": "<SAS URI of a storage blob with read access or public URI>",  
        "commandId": "<Id>"  
        }, 
    "parameters": [ 
        { 
            "name": "param1",
            "value": "value1" 
            }, 
        { 
            "name": "param2", 
            "value": "value2" 
            } 
        ], 
    "protectedParameters": [ 
        { 
            "name": "secret1", 
            "value": "value1" 
            }, 
        { 
            "name": "secret2", 
            "value": "value2" 
            } 
        ], 
    "runAsUser": "userName",
    "runAsPassword": "userPassword", 
    "timeoutInSeconds": 3600,
    "treatFailureAsDeploymentFailure": true,
    "outputBlobUri": "< SAS URI of a storage append blob with read, add, create, write access>", 
    "errorBlobUri": "< SAS URI of a storage append blob with read, add, create, write access >"  
    }
}

Примечания.

• В качестве источника входных данных можно указать встроенный скрипт, URI скрипта или идентификатор команды встроенного скрипта. URI скрипта — это SAS URI BLOB-объекта хранилища с доступом на чтение или общедоступный URI.
• Для одного выполнения команды поддерживается только один тип входных данных источника.
• Начиная с API версии 2023-03-01, можно задать для свойства treatFailureAsDeploymentFailure значение true, что приводит к сбою развертывания при возникновении сбоя в скрипте. Если установлено значение false, то ProvisioningState будет отражать только то, была ли выполнена команда запуска платформой расширений. Он не указывает на сбой в случае ошибки скрипта.
• Команда Run поддерживает запись выходных данных и ошибок в объекты BLOB с помощью параметров outputBlobUri и errorBlobUri, что позволяет хранить большие выходные данные скриптов. Используйте URI SAS для добавляемого blob-объекта хранилища с доступом на чтение, добавление, создание и запись. BLOB-объект должен иметь тип AppendBlob. Запись выходных данных скрипта или BLOB-объекта ошибок в противном случае завершится ошибкой. BLOB-объект будет перезаписан, если он уже существует. Он будет создан, если он не существует.

Список запущенных экземпляров функции выполнения команд на виртуальной машине

GET /subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>/providers/Microsoft.Compute/virtualMachines/<vmName>/runcommands?api-version=2023-03-01

Получение сведений о выводе для конкретного развертывания Run Command.

GET /subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>/providers/Microsoft.Compute/virtualMachines/<vmName>/runcommands/<runCommandName>?$expand=instanceView&api-version=2023-03-01

Удаление определенного развертывания команды запуска

Также можно удалить экземпляр Run Command.

DELETE /subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>/providers/Microsoft.Compute/virtualMachines/<vmName>/runcommands/<runCommandName>?api-version=2023-03-01

Развертывание скриптов в упорядоченной последовательности

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

{ 
    "type": "Microsoft.Compute/virtualMachines/runCommands", 
    "name": "secondRunCommand", 
    "apiVersion": "2019-12-01", 
    "location": "[parameters('location')]", 
    "dependsOn": <full resourceID of the previous other Run Command>, 
    "properties": { 
        "source": {  
            "script": "Write-Host Hello World!"  
        }, 
        "timeoutInSeconds": 60  
    }
}