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

Set-AzVMRunCommand

Модуль:
Az.Compute Module

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

Синтаксис

UpdateExpanded (по умолчанию) 

Set-AzVMRunCommand
    -ResourceGroupName <String>
    -RunCommandName <String>
    -VMName <String>
    -Location <String>
    [-SubscriptionId <String>]
    [-AsyncExecution]
    [-ErrorBlobManagedIdentityClientId <String>]
    [-ErrorBlobManagedIdentityObjectId <String>]
    [-ErrorBlobUri <String>]
    [-OutputBlobManagedIdentityClientId <String>]
    [-OutputBlobManagedIdentityObjectId <String>]
    [-OutputBlobUri <String>]
    [-Parameter <IRunCommandInputParameter[]>]
    [-ProtectedParameter <IRunCommandInputParameter[]>]
    [-RunAsPassword <String>]
    [-RunAsUser <String>]
    [-ScriptUriManagedIdentityClientId <String>]
    [-ScriptUriManagedIdentityObjectId <String>]
    [-SourceCommandId <String>]
    [-SourceScript <String>]
    [-SourceScriptUri <String>]
    [-Tag <Hashtable>]
    [-TimeoutInSecond <Int32>]
    [-TreatFailureAsDeploymentFailure]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ScriptLocalPath 

Set-AzVMRunCommand
    -ResourceGroupName <String>
    -RunCommandName <String>
    -VMName <String>
    -Location <String>
    -ScriptLocalPath <String>
    [-SubscriptionId <String>]
    [-AsyncExecution]
    [-ErrorBlobManagedIdentityClientId <String>]
    [-ErrorBlobManagedIdentityObjectId <String>]
    [-ErrorBlobUri <String>]
    [-OutputBlobManagedIdentityClientId <String>]
    [-OutputBlobManagedIdentityObjectId <String>]
    [-OutputBlobUri <String>]
    [-Parameter <IRunCommandInputParameter[]>]
    [-ProtectedParameter <IRunCommandInputParameter[]>]
    [-RunAsPassword <String>]
    [-RunAsUser <String>]
    [-ScriptUriManagedIdentityClientId <String>]
    [-ScriptUriManagedIdentityObjectId <String>]
    [-Tag <Hashtable>]
    [-TimeoutInSecond <Int32>]
    [-TreatFailureAsDeploymentFailure]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Описание

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

Примеры

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

Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVMEE -RunCommandName MyRunCommand -Location EastUS2EUAP -SourceScriptUri "https://myst.blob.core.windows.net/mycontainer/myscript.ps1?sp=r&st=2022-10-27T21:02:35Z&se=2022-10-28T05:02:35Z&spr=https&sv=2021-06-08&sr=b&sig=******"

Location      Name         Type
--------      ----         ----
eastus2euap   MyRunCommand Microsoft.Compute/virtualMachines/runCommands

Создайте или обновите команду запуска на виртуальной машине Windows с помощью URL-адреса SAS большого двоичного объекта хранилища, содержащего скрипт .ps1. URL-адрес SAS должен предоставлять доступ для чтения к объекту Blob. Срок действия 24 часов предлагается для URL-адреса SAS. URL-адреса SAS можно создавать на портале Azure с помощью параметров BLOB-объектов или маркера SAS с помощью New-AzStorageBlobSASToken. При создании маркера SAS с помощью New-AzStorageBlobSASToken URL-адрес SAS = базовый URL-адрес BLOB-объектов + "?" + маркер SAS из New-AzStorageBlobSASToken.

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

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

Location      Name         Type
--------      ----         ----
eastus2euap   MyRunCommand Microsoft.Compute/virtualMachines/runCommands

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

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

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

Location      Name          Type
--------      ----          ----
eastus2euap   MyRunCommand2 Microsoft.Compute/virtualMachines/runCommands

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

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

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

Location      Name         Type
--------      ----         ----
eastus2euap   MyRunCommand Microsoft.Compute/virtualMachines/runCommands

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

Пример 5. Создание или обновление команды выполнения на виртуальной машине и потоковая передача стандартных выходных данных и стандартных сообщений об ошибках для вывода и ошибок добавления БОЛЬШИХ двоичных объектов.

Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVML -RunCommandName MyRunCommand3 -Location EastUS2EUAP -ScriptLocalPath "C:\MyScriptsDir\MyScript.ps1" -OutputBlobUri "https://vivst.blob.core.windows.net/vivcontainer/output.txt?sp=racw&st=2022-10-27T22:18:36Z&se=2022-10-28T06:18:36Z&spr=https&sv=2021-06-08&sr=b&sig=******" -ErrorBlobUri "https://vivst.blob.core.windows.net/vivcontainer/error.txt?sp=racw&st=2022-10-27T22:18:36Z&se=2022-10-28T06:18:36Z&spr=https&sv=2021-06-08&sr=b&sig=******"

Location      Name          Type
--------      ----         ----
eastus2euap   MyRunCommand3 Microsoft.Compute/virtualMachines/runCommands

Создайте или обновите команду run на виртуальной машине и потоковую передачу стандартных выходных данных и стандартных сообщений об ошибках для вывода и добавления больших двоичных объектов. Выходные данные и большие двоичные объекты ошибок должны иметь тип AppendBlob, а URL-адреса SAS должны предоставлять доступ для чтения, добавления, создания, записи к большому двоичному объекту. Срок действия 24 часов предлагается для URL-адреса SAS. Если выходные данные или большой двоичный объект ошибки не существует, будет создан большой двоичный объект типа AppendBlob. URL-адреса SAS можно создавать на портале Azure с помощью параметров BLOB-объектов или маркера SAS с помощью New-AzStorageBlobSASToken. При создании маркера SAS с помощью New-AzStorageBlobSASToken URL-адрес SAS = базовый URL-адрес BLOB-объектов + "?" + маркер SAS из New-AzStorageBlobSASToken.

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

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

Location      Name         Type
--------      ----         ----
eastus2euap   MyRunCommand Microsoft.Compute/virtualMachines/runCommands

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

Параметры

-AsJob

Выполнение команды в качестве задания

Свойства параметра

Тип:SwitchParameter
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-AsyncExecution

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

Свойства параметра

Тип:SwitchParameter
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Confirm

Запрашивает подтверждение перед запуском cmdlet.

Свойства параметра

Тип:SwitchParameter
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:cf

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-DefaultProfile

Параметр DefaultProfile не работает. Используйте параметр SubscriptionId, если он доступен при выполнении командлета в другой подписке.

Свойства параметра

Тип:PSObject
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:AzureRMContext, AzureCredential

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-ErrorBlobManagedIdentityClientId

Идентификатор клиента (значение GUID) управляемого удостоверения, назначаемого пользователем. Объектный идентификатор не следует использовать, если это указано.

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-ErrorBlobManagedIdentityObjectId

Идентификатор объекта (значение GUID) управляемого удостоверения, назначаемого пользователем. ClientId не следует использовать, если это указано.

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-ErrorBlobUri

Указывает большой двоичный объект хранилища Azure, в котором будет отправлен поток ошибок скрипта. Используйте URI SAS с чтением, добавлением, созданием, записью или использованием управляемого удостоверения для предоставления виртуальной машине доступа к большому двоичному объекту. См. параметр errorBlobManagedIdentity.

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Location

Расположение ресурса

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-NoWait

Асинхронное выполнение команды

Свойства параметра

Тип:SwitchParameter
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-OutputBlobManagedIdentityClientId

Идентификатор клиента (значение GUID) управляемого удостоверения, назначаемого пользователем. Объектный идентификатор не следует использовать, если это указано.

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-OutputBlobManagedIdentityObjectId

Идентификатор объекта (значение GUID) управляемого удостоверения, назначаемого пользователем. ClientId не следует использовать, если это указано.

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-OutputBlobUri

Указывает большой двоичный объект хранилища Azure, в котором будет отправлен поток выходных данных скрипта. Используйте URI SAS с чтением, добавлением, созданием, записью или использованием управляемого удостоверения для предоставления виртуальной машине доступа к большому двоичному объекту. См. параметр outputBlobManagedIdentity.

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Parameter

Параметры, используемые скриптом. Сведения о создании см. в разделе NOTES свойств PARAMETER и создании хэш-таблицы.

Свойства параметра

Тип:

IRunCommandInputParameter[]

Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-ProtectedParameter

Параметры, используемые скриптом. Сведения о создании см. в разделе NOTES для свойств PROTECTEDPARAMETER и создания хэш-таблицы.

Свойства параметра

Тип:

IRunCommandInputParameter[]

Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-ResourceGroupName

Имя группы ресурсов.

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-RunAsPassword

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

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-RunAsUser

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

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-RunCommandName

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

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-ScriptLocalPath

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

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

ScriptLocalPath
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-ScriptUriManagedIdentityClientId

Идентификатор клиента (значение GUID) управляемого удостоверения, назначаемого пользователем. Объектный идентификатор не следует использовать, если это указано.

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-ScriptUriManagedIdentityObjectId

Идентификатор объекта (значение GUID) управляемого удостоверения, назначаемого пользователем. ClientId не следует использовать, если это указано.

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-SourceCommandId

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

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

UpdateExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-SourceScript

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

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

UpdateExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-SourceScriptUri

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

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

UpdateExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-SubscriptionId

Учетные данные подписки, которые однозначно определяют подписку Microsoft Azure. Идентификатор подписки входит в состав URI для каждого вызова службы.

Свойства параметра

Тип:String
Default value:(Get-AzContext).Subscription.Id
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Tag

Теги ресурсов

Свойства параметра

Тип:Hashtable
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-TimeoutInSecond

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

Свойства параметра

Тип:Int32
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-TreatFailureAsDeploymentFailure

Необязательно. Если задано значение true, любой сбой в скрипте завершится сбоем развертывания и provisioningState будет помечен как "Сбой". Если задано значение false, ProvisioningState будет отражать только выполнение команды выполнения платформы расширений, не указывайте, завершился ли скрипт сбоем в случае сбоев скрипта. Просмотр представления экземпляра команды выполнения в случае сбоя скрипта, чтобы увидеть executionMessage, выходные данные, ошибку: https://aka.ms/runcommandmanaged#get-execution-status-and-results

Свойства параметра

Тип:SwitchParameter
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-VMName

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

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-WhatIf

Показывает, что произойдет, если командлет будет запущен. Командлет не запускается.

Свойства параметра

Тип:SwitchParameter
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:wi

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

CommonParameters

Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.

Выходные данные

IVirtualMachineRunCommand