Microsoft.Compute virtualMachineScaleSets/virtualMachines/runCommands 2022-03-01

• Актуальная
• 2022-11-01
• 2022-08-01
• 2022-03-01
• 2021-11-01
• 2021-07-01
• 2021-04-01
• 2021-03-01
• 2020-12-01

Определение ресурса Bicep

Тип ресурса virtualMachineScaleSets/virtualMachines/runCommands можно развернуть в:

• Группы ресурсов — см. команды развертывания групп ресурсов.

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

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

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

resource symbolicname 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2022-03-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    asyncExecution: bool
    errorBlobUri: 'string'
    outputBlobUri: 'string'
    parameters: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    protectedParameters: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    runAsPassword: 'string'
    runAsUser: 'string'
    source: {
      commandId: 'string'
      script: 'string'
      scriptUri: 'string'
    }
    timeoutInSeconds: int
  }
}

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

virtualMachineScaleSets/virtualMachines/runCommands

Имя	Описание	Значение
name	имя ресурса. Узнайте, как задать имена и типы для дочерних ресурсов в Bicep.	string (обязательно)
location	Расположение ресурса	string (обязательно)
tags	Теги ресурсов	Словарь имен и значений тегов. См . раздел Теги в шаблонах
родитель	В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить только в том случае, если дочерний ресурс объявлен за пределами родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.	Символьное имя ресурса типа : virtualMachines
properties	Описывает свойства команды запуска виртуальной машины.	VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

Имя	Описание	Значение
asyncExecution	Необязательный элемент. Если задано значение true, подготовка завершится сразу после запуска скрипта и не будет ожидать завершения скрипта.	bool
errorBlobUri	Указывает большой двоичный объект хранилища Azure, куда будет отправляться поток ошибок скрипта.	строка
outputBlobUri	Указывает большой двоичный объект службы хранилища Azure, куда будет отправляться поток вывода скрипта.	строка
параметры	Параметры, используемые скриптом.	RunCommandInputParameter[]
protectedParameters	Параметры, используемые скриптом.	RunCommandInputParameter[]
runAsPassword	Указывает пароль учетной записи пользователя на виртуальной машине при выполнении команды выполнения.	строка
runAsUser	Указывает учетную запись пользователя на виртуальной машине при выполнении команды выполнения.	строка
source	Источник скрипта выполнения команды.	VirtualMachineRunCommandScriptSource
timeoutInSeconds	Время ожидания в секундах для выполнения команды выполнения.	INT

RunCommandInputParameter

Имя	Описание	Значение
name	Имя параметра команды запуска.	string (обязательно)
значение	Значение параметра команды выполнения.	string (обязательно)

VirtualMachineRunCommandScriptSource

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

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

Тип ресурса virtualMachineScaleSets/virtualMachines/runCommands можно развернуть в:

• Группы ресурсов — см. команды развертывания группы ресурсов.

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

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

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

{
  "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands",
  "apiVersion": "2022-03-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "asyncExecution": "bool",
    "errorBlobUri": "string",
    "outputBlobUri": "string",
    "parameters": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "protectedParameters": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "runAsPassword": "string",
    "runAsUser": "string",
    "source": {
      "commandId": "string",
      "script": "string",
      "scriptUri": "string"
    },
    "timeoutInSeconds": "int"
  }
}

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

virtualMachineScaleSets/virtualMachines/runCommands

Имя	Описание	Значение
тип	Тип ресурса	Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands
версия_API	Версия API ресурсов	'2022-03-01'
name	имя ресурса. Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM.	строка (обязательно)
location	Расположение ресурса	строка (обязательно)
tags	Теги ресурсов	Словарь имен и значений тегов. См . раздел Теги в шаблонах
properties	Описывает свойства команды запуска виртуальной машины.	VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

Имя	Описание	Значение
asyncExecution	Необязательный элемент. Если задано значение true, подготовка завершится сразу после запуска скрипта и не будет ждать завершения скрипта.	bool
errorBlobUri	Указывает большой двоичный объект службы хранилища Azure, куда будет отправлен поток ошибок скрипта.	строка
outputBlobUri	Указывает большой двоичный объект службы хранилища Azure, в который будет отправлен выходной поток скрипта.	строка
параметры	Параметры, используемые скриптом.	RunCommandInputParameter[]
protectedParameters	Параметры, используемые скриптом.	RunCommandInputParameter[]
runAsPassword	Указывает пароль учетной записи пользователя на виртуальной машине при выполнении команды запуска.	строка
runAsUser	Указывает учетную запись пользователя на виртуальной машине при выполнении команды запуска.	строка
source	Источник скрипта команды запуска.	VirtualMachineRunCommandScriptSource
timeoutInSeconds	Время ожидания в секундах для выполнения команды выполнения.	INT

RunCommandInputParameter

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

VirtualMachineRunCommandScriptSource

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

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

Тип ресурса virtualMachineScaleSets/virtualMachines/runCommands можно развернуть в:

• Группы ресурсов

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2022-03-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      asyncExecution = bool
      errorBlobUri = "string"
      outputBlobUri = "string"
      parameters = [
        {
          name = "string"
          value = "string"
        }
      ]
      protectedParameters = [
        {
          name = "string"
          value = "string"
        }
      ]
      runAsPassword = "string"
      runAsUser = "string"
      source = {
        commandId = "string"
        script = "string"
        scriptUri = "string"
      }
      timeoutInSeconds = int
    }
  })
}

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

virtualMachineScaleSets/virtualMachines/runCommands

Имя	Описание	Значение
тип	Тип ресурса	"Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2022-03-01"
name	имя ресурса.	string (обязательно)
location	Расположение ресурса	string (обязательно)
parent_id	Идентификатор ресурса, который является родительским для этого ресурса.	Идентификатор ресурса типа: virtualMachines
tags	Теги ресурсов	Словарь имен и значений тегов.
properties	Описывает свойства команды запуска виртуальной машины.	VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

Имя	Описание	Значение
asyncExecution	Необязательный элемент. Если задано значение true, подготовка завершится сразу после запуска скрипта и не будет ожидать завершения скрипта.	bool
errorBlobUri	Указывает большой двоичный объект хранилища Azure, куда будет отправляться поток ошибок скрипта.	строка
outputBlobUri	Указывает большой двоичный объект службы хранилища Azure, куда будет отправляться поток вывода скрипта.	строка
параметры	Параметры, используемые скриптом.	RunCommandInputParameter[]
protectedParameters	Параметры, используемые скриптом.	RunCommandInputParameter[]
runAsPassword	Указывает пароль учетной записи пользователя на виртуальной машине при выполнении команды выполнения.	строка
runAsUser	Указывает учетную запись пользователя на виртуальной машине при выполнении команды выполнения.	строка
source	Источник скрипта выполнения команды.	VirtualMachineRunCommandScriptSource
timeoutInSeconds	Время ожидания в секундах для выполнения команды выполнения.	INT

RunCommandInputParameter

Имя	Описание	Значение
name	Имя параметра команды запуска.	string (обязательно)
значение	Значение параметра команды выполнения.	string (обязательно)

VirtualMachineRunCommandScriptSource

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