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


Microsoft.Compute virtualMachineScaleSets/virtualMachines/runCommands 2025-04-01

Определение ресурсов Bicep

Тип ресурса virtualMachineScaleSets/virtualMachines/runCommands можно развернуть с помощью операций, целевых:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands, добавьте следующий Bicep в шаблон.

resource symbolicname 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2025-04-01' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    asyncExecution: bool
    errorBlobManagedIdentity: {
      clientId: 'string'
      objectId: 'string'
    }
    errorBlobUri: 'string'
    outputBlobManagedIdentity: {
      clientId: 'string'
      objectId: 'string'
    }
    outputBlobUri: 'string'
    parameters: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    protectedParameters: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    runAsPassword: 'string'
    runAsUser: 'string'
    source: {
      commandId: 'string'
      galleryScriptReferenceId: 'string'
      script: 'string'
      scriptShell: 'string'
      scriptUri: 'string'
      scriptUriManagedIdentity: {
        clientId: 'string'
        objectId: 'string'
      }
    }
    timeoutInSeconds: int
    treatFailureAsDeploymentFailure: bool
  }
  tags: {
    {customized property}: 'string'
  }
}

Значения свойств

Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands

Имя Description Ценность
location Географическое расположение, в котором находится ресурс строка (обязательно)
имя имя ресурса. строка (обязательно)
parent В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса.

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.
Символьное имя ресурса типа: virtualMachineScaleSets/virtualMachines
properties Описывает свойства команды выполнения виртуальной машины. VirtualMachineRunCommandProperties
tags Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах

Параметр ввода RunCommandInput

Имя Description Ценность
имя Имя параметра команды запуска. строка (обязательно)
value Значение параметра команды run. строка (обязательно)

RunCommandManagedIdentity (ВыполнитьCommandManagedIdentity)

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

Отслеживаемые Ресурсные Теги

Имя Description Ценность

VirtualMachineRunCommandProperties

Имя Description Ценность
asyncExecution Необязательно. Если задано значение true, подготовка завершится сразу после запуска скрипта и не будет ожидать завершения скрипта. bool
errorBlobManagedIdentity Назначаемое пользователем управляемое удостоверение, которое имеет доступ к blob-объекту хранилища errorBlobUri. Используйте пустой объект в случае назначаемого системой удостоверения. Убедитесь, что управляемое удостоверение было предоставлено доступ к контейнеру BLOB-объекта с назначением роли "Участник данных BLOB-объектов хранилища". В случае назначаемого пользователем удостоверения убедитесь, что вы добавите его в удостоверение виртуальной машины. Дополнительные сведения об управляемом удостоверении и команде запуска см. в https://aka.ms/ManagedIdentity и https://aka.ms/RunCommandManaged RunCommandManagedIdentity (ВыполнитьCommandManagedIdentity)
errorBlobUri Указывает большой двоичный объект хранилища Azure, в котором будет отправлен поток ошибок скрипта. Используйте URI SAS с чтением, добавлением, созданием, записью или использованием управляемого удостоверения для предоставления виртуальной машине доступа к большому двоичному объекту. См. параметр errorBlobManagedIdentity. струна
outputBlobManagedIdentity Назначаемое пользователем управляемое удостоверение, которое имеет доступ к blob-объекту хранилища outputBlobUri. Используйте пустой объект в случае назначаемого системой удостоверения. Убедитесь, что управляемое удостоверение было предоставлено доступ к контейнеру BLOB-объекта с назначением роли "Участник данных BLOB-объектов хранилища". В случае назначаемого пользователем удостоверения убедитесь, что вы добавите его в удостоверение виртуальной машины. Дополнительные сведения об управляемом удостоверении и команде запуска см. в https://aka.ms/ManagedIdentity и https://aka.ms/RunCommandManaged RunCommandManagedIdentity (ВыполнитьCommandManagedIdentity)
outputBlobUri Указывает большой двоичный объект хранилища Azure, в котором будет отправлен поток выходных данных скрипта. Используйте URI SAS с чтением, добавлением, созданием, записью или использованием управляемого удостоверения для предоставления виртуальной машине доступа к большому двоичному объекту. См. параметр outputBlobManagedIdentity. струна
parameters Параметры, используемые скриптом. RunCommandInputParameter[]
защищенныеПараметры Параметры, используемые скриптом. RunCommandInputParameter[]
runAsPassword Указывает пароль учетной записи пользователя на виртуальной машине при выполнении команды выполнения. струна
runAsUser Указывает учетную запись пользователя на виртуальной машине при выполнении команды выполнения. струна
source Источник скрипта выполнения команды. VirtualMachineRunCommandScriptSource
timeoutInSeconds Время ожидания в секундах для выполнения команды выполнения. инт
treatFailureAsDeploymentFailureFailure Необязательно. Если задано значение true, любой сбой в скрипте завершится сбоем развертывания и provisioningState будет помечен как "Сбой". Если задано значение false, ProvisioningState будет отражать только выполнение команды выполнения платформы расширений, не указывайте, завершился ли скрипт сбоем в случае сбоев скрипта. Просмотр представления экземпляра команды выполнения в случае сбоя скрипта, чтобы увидеть executionMessage, выходные данные, ошибку: https://aka.ms/runcommandmanaged#get-execution-status-and-results bool

VirtualMachineRunCommandScriptSource

Имя Description Ценность
commandId Задает идентификатор командной строки предопределенного встроенного скрипта. Идентификаторы команд, доступные для Linux, перечислены по адресу https://aka.ms/RunCommandManagedLinux#available-commands, Windows по адресу https://aka.ms/RunCommandManagedWindows#available-commands. струна
galleryScriptReferenceId Идентификатор ресурса версии скрипта галереи, которую необходимо выполнить. Пример ID выглядит как /subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Compute/galleries/{galleryName}/scripts/{scriptName}/versions/{version}. струна
script Указывает содержимое скрипта, выполняемого на виртуальной машине. струна
scriptShell Необязательно. Укажите, какую оболочку использовать для запуска скрипта. Эти значения должны совпадать с ожидаемыми расширением. В настоящее время поддерживается только для виртуальных машин Windows, скрипт использует Powershell 7, если он указан. Powershell 7 должен быть уже установлен на компьютере, чтобы использовать значение параметра Powershell7. По умолчанию
«Powershell7»
scriptUri Указывает расположение загрузки скрипта. Это может быть URI SAS большого двоичного объекта хранилища Azure с доступом на чтение или общедоступным универсальным кодом ресурса (URI). струна
scriptUriManagedIdentity Назначаемое пользователем управляемое удостоверение, которое имеет доступ к scriptUri в случае большого двоичного объекта хранилища Azure. Используйте пустой объект в случае назначаемого системой удостоверения. Убедитесь, что большой двоичный объект хранилища Azure существует, и управляемое удостоверение было предоставлено доступ к контейнеру BLOB-объектов с назначением роли "Читатель данных BLOB-объектов хранилища". В случае назначаемого пользователем удостоверения убедитесь, что вы добавите его в удостоверение виртуальной машины. Дополнительные сведения об управляемом удостоверении и команде запуска см. в https://aka.ms/ManagedIdentity и https://aka.ms/RunCommandManaged. RunCommandManagedIdentity (ВыполнитьCommandManagedIdentity)

Определение ресурса шаблона ARM

Тип ресурса virtualMachineScaleSets/virtualMachines/runCommands можно развернуть с помощью операций, целевых:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands",
  "apiVersion": "2025-04-01",
  "name": "string",
  "location": "string",
  "properties": {
    "asyncExecution": "bool",
    "errorBlobManagedIdentity": {
      "clientId": "string",
      "objectId": "string"
    },
    "errorBlobUri": "string",
    "outputBlobManagedIdentity": {
      "clientId": "string",
      "objectId": "string"
    },
    "outputBlobUri": "string",
    "parameters": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "protectedParameters": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "runAsPassword": "string",
    "runAsUser": "string",
    "source": {
      "commandId": "string",
      "galleryScriptReferenceId": "string",
      "script": "string",
      "scriptShell": "string",
      "scriptUri": "string",
      "scriptUriManagedIdentity": {
        "clientId": "string",
        "objectId": "string"
      }
    },
    "timeoutInSeconds": "int",
    "treatFailureAsDeploymentFailure": "bool"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Значения свойств

Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands

Имя Description Ценность
apiVersion Версия API '2025-04-01'
location Географическое расположение, в котором находится ресурс строка (обязательно)
имя имя ресурса. строка (обязательно)
properties Описывает свойства команды выполнения виртуальной машины. VirtualMachineRunCommandProperties
tags Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах
type Тип ресурса "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands"

Параметр ввода RunCommandInput

Имя Description Ценность
имя Имя параметра команды запуска. строка (обязательно)
value Значение параметра команды run. строка (обязательно)

RunCommandManagedIdentity (ВыполнитьCommandManagedIdentity)

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

Отслеживаемые Ресурсные Теги

Имя Description Ценность

VirtualMachineRunCommandProperties

Имя Description Ценность
asyncExecution Необязательно. Если задано значение true, подготовка завершится сразу после запуска скрипта и не будет ожидать завершения скрипта. bool
errorBlobManagedIdentity Назначаемое пользователем управляемое удостоверение, которое имеет доступ к blob-объекту хранилища errorBlobUri. Используйте пустой объект в случае назначаемого системой удостоверения. Убедитесь, что управляемое удостоверение было предоставлено доступ к контейнеру BLOB-объекта с назначением роли "Участник данных BLOB-объектов хранилища". В случае назначаемого пользователем удостоверения убедитесь, что вы добавите его в удостоверение виртуальной машины. Дополнительные сведения об управляемом удостоверении и команде запуска см. в https://aka.ms/ManagedIdentity и https://aka.ms/RunCommandManaged RunCommandManagedIdentity (ВыполнитьCommandManagedIdentity)
errorBlobUri Указывает большой двоичный объект хранилища Azure, в котором будет отправлен поток ошибок скрипта. Используйте URI SAS с чтением, добавлением, созданием, записью или использованием управляемого удостоверения для предоставления виртуальной машине доступа к большому двоичному объекту. См. параметр errorBlobManagedIdentity. струна
outputBlobManagedIdentity Назначаемое пользователем управляемое удостоверение, которое имеет доступ к blob-объекту хранилища outputBlobUri. Используйте пустой объект в случае назначаемого системой удостоверения. Убедитесь, что управляемое удостоверение было предоставлено доступ к контейнеру BLOB-объекта с назначением роли "Участник данных BLOB-объектов хранилища". В случае назначаемого пользователем удостоверения убедитесь, что вы добавите его в удостоверение виртуальной машины. Дополнительные сведения об управляемом удостоверении и команде запуска см. в https://aka.ms/ManagedIdentity и https://aka.ms/RunCommandManaged RunCommandManagedIdentity (ВыполнитьCommandManagedIdentity)
outputBlobUri Указывает большой двоичный объект хранилища Azure, в котором будет отправлен поток выходных данных скрипта. Используйте URI SAS с чтением, добавлением, созданием, записью или использованием управляемого удостоверения для предоставления виртуальной машине доступа к большому двоичному объекту. См. параметр outputBlobManagedIdentity. струна
parameters Параметры, используемые скриптом. RunCommandInputParameter[]
защищенныеПараметры Параметры, используемые скриптом. RunCommandInputParameter[]
runAsPassword Указывает пароль учетной записи пользователя на виртуальной машине при выполнении команды выполнения. струна
runAsUser Указывает учетную запись пользователя на виртуальной машине при выполнении команды выполнения. струна
source Источник скрипта выполнения команды. VirtualMachineRunCommandScriptSource
timeoutInSeconds Время ожидания в секундах для выполнения команды выполнения. инт
treatFailureAsDeploymentFailureFailure Необязательно. Если задано значение true, любой сбой в скрипте завершится сбоем развертывания и provisioningState будет помечен как "Сбой". Если задано значение false, ProvisioningState будет отражать только выполнение команды выполнения платформы расширений, не указывайте, завершился ли скрипт сбоем в случае сбоев скрипта. Просмотр представления экземпляра команды выполнения в случае сбоя скрипта, чтобы увидеть executionMessage, выходные данные, ошибку: https://aka.ms/runcommandmanaged#get-execution-status-and-results bool

VirtualMachineRunCommandScriptSource

Имя Description Ценность
commandId Задает идентификатор командной строки предопределенного встроенного скрипта. Идентификаторы команд, доступные для Linux, перечислены по адресу https://aka.ms/RunCommandManagedLinux#available-commands, Windows по адресу https://aka.ms/RunCommandManagedWindows#available-commands. струна
galleryScriptReferenceId Идентификатор ресурса версии скрипта галереи, которую необходимо выполнить. Пример ID выглядит как /subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Compute/galleries/{galleryName}/scripts/{scriptName}/versions/{version}. струна
script Указывает содержимое скрипта, выполняемого на виртуальной машине. струна
scriptShell Необязательно. Укажите, какую оболочку использовать для запуска скрипта. Эти значения должны совпадать с ожидаемыми расширением. В настоящее время поддерживается только для виртуальных машин Windows, скрипт использует Powershell 7, если он указан. Powershell 7 должен быть уже установлен на компьютере, чтобы использовать значение параметра Powershell7. По умолчанию
«Powershell7»
scriptUri Указывает расположение загрузки скрипта. Это может быть URI SAS большого двоичного объекта хранилища Azure с доступом на чтение или общедоступным универсальным кодом ресурса (URI). струна
scriptUriManagedIdentity Назначаемое пользователем управляемое удостоверение, которое имеет доступ к scriptUri в случае большого двоичного объекта хранилища Azure. Используйте пустой объект в случае назначаемого системой удостоверения. Убедитесь, что большой двоичный объект хранилища Azure существует, и управляемое удостоверение было предоставлено доступ к контейнеру BLOB-объектов с назначением роли "Читатель данных BLOB-объектов хранилища". В случае назначаемого пользователем удостоверения убедитесь, что вы добавите его в удостоверение виртуальной машины. Дополнительные сведения об управляемом удостоверении и команде запуска см. в https://aka.ms/ManagedIdentity и https://aka.ms/RunCommandManaged. RunCommandManagedIdentity (ВыполнитьCommandManagedIdentity)

Примеры использования

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса virtualMachineScaleSets/virtualMachines/runCommands можно развернуть с помощью операций, целевых:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands, добавьте следующий объект Terraform в шаблон.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2025-04-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      asyncExecution = bool
      errorBlobManagedIdentity = {
        clientId = "string"
        objectId = "string"
      }
      errorBlobUri = "string"
      outputBlobManagedIdentity = {
        clientId = "string"
        objectId = "string"
      }
      outputBlobUri = "string"
      parameters = [
        {
          name = "string"
          value = "string"
        }
      ]
      protectedParameters = [
        {
          name = "string"
          value = "string"
        }
      ]
      runAsPassword = "string"
      runAsUser = "string"
      source = {
        commandId = "string"
        galleryScriptReferenceId = "string"
        script = "string"
        scriptShell = "string"
        scriptUri = "string"
        scriptUriManagedIdentity = {
          clientId = "string"
          objectId = "string"
        }
      }
      timeoutInSeconds = int
      treatFailureAsDeploymentFailure = bool
    }
  }
}

Значения свойств

Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands

Имя Description Ценность
location Географическое расположение, в котором находится ресурс строка (обязательно)
имя имя ресурса. строка (обязательно)
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: virtualMachineScaleSets/virtualMachines
properties Описывает свойства команды выполнения виртуальной машины. VirtualMachineRunCommandProperties
tags Теги ресурсов Словарь имен и значений тегов.
type Тип ресурса "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2025-04-01"

Параметр ввода RunCommandInput

Имя Description Ценность
имя Имя параметра команды запуска. строка (обязательно)
value Значение параметра команды run. строка (обязательно)

RunCommandManagedIdentity (ВыполнитьCommandManagedIdentity)

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

Отслеживаемые Ресурсные Теги

Имя Description Ценность

VirtualMachineRunCommandProperties

Имя Description Ценность
asyncExecution Необязательно. Если задано значение true, подготовка завершится сразу после запуска скрипта и не будет ожидать завершения скрипта. bool
errorBlobManagedIdentity Назначаемое пользователем управляемое удостоверение, которое имеет доступ к blob-объекту хранилища errorBlobUri. Используйте пустой объект в случае назначаемого системой удостоверения. Убедитесь, что управляемое удостоверение было предоставлено доступ к контейнеру BLOB-объекта с назначением роли "Участник данных BLOB-объектов хранилища". В случае назначаемого пользователем удостоверения убедитесь, что вы добавите его в удостоверение виртуальной машины. Дополнительные сведения об управляемом удостоверении и команде запуска см. в https://aka.ms/ManagedIdentity и https://aka.ms/RunCommandManaged RunCommandManagedIdentity (ВыполнитьCommandManagedIdentity)
errorBlobUri Указывает большой двоичный объект хранилища Azure, в котором будет отправлен поток ошибок скрипта. Используйте URI SAS с чтением, добавлением, созданием, записью или использованием управляемого удостоверения для предоставления виртуальной машине доступа к большому двоичному объекту. См. параметр errorBlobManagedIdentity. струна
outputBlobManagedIdentity Назначаемое пользователем управляемое удостоверение, которое имеет доступ к blob-объекту хранилища outputBlobUri. Используйте пустой объект в случае назначаемого системой удостоверения. Убедитесь, что управляемое удостоверение было предоставлено доступ к контейнеру BLOB-объекта с назначением роли "Участник данных BLOB-объектов хранилища". В случае назначаемого пользователем удостоверения убедитесь, что вы добавите его в удостоверение виртуальной машины. Дополнительные сведения об управляемом удостоверении и команде запуска см. в https://aka.ms/ManagedIdentity и https://aka.ms/RunCommandManaged RunCommandManagedIdentity (ВыполнитьCommandManagedIdentity)
outputBlobUri Указывает большой двоичный объект хранилища Azure, в котором будет отправлен поток выходных данных скрипта. Используйте URI SAS с чтением, добавлением, созданием, записью или использованием управляемого удостоверения для предоставления виртуальной машине доступа к большому двоичному объекту. См. параметр outputBlobManagedIdentity. струна
parameters Параметры, используемые скриптом. RunCommandInputParameter[]
защищенныеПараметры Параметры, используемые скриптом. RunCommandInputParameter[]
runAsPassword Указывает пароль учетной записи пользователя на виртуальной машине при выполнении команды выполнения. струна
runAsUser Указывает учетную запись пользователя на виртуальной машине при выполнении команды выполнения. струна
source Источник скрипта выполнения команды. VirtualMachineRunCommandScriptSource
timeoutInSeconds Время ожидания в секундах для выполнения команды выполнения. инт
treatFailureAsDeploymentFailureFailure Необязательно. Если задано значение true, любой сбой в скрипте завершится сбоем развертывания и provisioningState будет помечен как "Сбой". Если задано значение false, ProvisioningState будет отражать только выполнение команды выполнения платформы расширений, не указывайте, завершился ли скрипт сбоем в случае сбоев скрипта. Просмотр представления экземпляра команды выполнения в случае сбоя скрипта, чтобы увидеть executionMessage, выходные данные, ошибку: https://aka.ms/runcommandmanaged#get-execution-status-and-results bool

VirtualMachineRunCommandScriptSource

Имя Description Ценность
commandId Задает идентификатор командной строки предопределенного встроенного скрипта. Идентификаторы команд, доступные для Linux, перечислены по адресу https://aka.ms/RunCommandManagedLinux#available-commands, Windows по адресу https://aka.ms/RunCommandManagedWindows#available-commands. струна
galleryScriptReferenceId Идентификатор ресурса версии скрипта галереи, которую необходимо выполнить. Пример ID выглядит как /subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Compute/galleries/{galleryName}/scripts/{scriptName}/versions/{version}. струна
script Указывает содержимое скрипта, выполняемого на виртуальной машине. струна
scriptShell Необязательно. Укажите, какую оболочку использовать для запуска скрипта. Эти значения должны совпадать с ожидаемыми расширением. В настоящее время поддерживается только для виртуальных машин Windows, скрипт использует Powershell 7, если он указан. Powershell 7 должен быть уже установлен на компьютере, чтобы использовать значение параметра Powershell7. По умолчанию
«Powershell7»
scriptUri Указывает расположение загрузки скрипта. Это может быть URI SAS большого двоичного объекта хранилища Azure с доступом на чтение или общедоступным универсальным кодом ресурса (URI). струна
scriptUriManagedIdentity Назначаемое пользователем управляемое удостоверение, которое имеет доступ к scriptUri в случае большого двоичного объекта хранилища Azure. Используйте пустой объект в случае назначаемого системой удостоверения. Убедитесь, что большой двоичный объект хранилища Azure существует, и управляемое удостоверение было предоставлено доступ к контейнеру BLOB-объектов с назначением роли "Читатель данных BLOB-объектов хранилища". В случае назначаемого пользователем удостоверения убедитесь, что вы добавите его в удостоверение виртуальной машины. Дополнительные сведения об управляемом удостоверении и команде запуска см. в https://aka.ms/ManagedIdentity и https://aka.ms/RunCommandManaged. RunCommandManagedIdentity (ВыполнитьCommandManagedIdentity)