Microsoft.Compute virtualMachineScaleSets/virtualMachines/runCommands

  • Статья

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

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

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

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

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

resource symbolicname 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2023-09-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  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'
      script: 'string'
      scriptUri: 'string'
      scriptUriManagedIdentity: {
        clientId: 'string'
        objectId: 'string'
      }
    }
    timeoutInSeconds: int
    treatFailureAsDeploymentFailure: bool
  }
}

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

virtualMachineScaleSets/virtualMachines/runCommands

Имя Описание Значение
name имя ресурса.

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

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

VirtualMachineRunCommandProperties

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

RunCommandManagedIdentity

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

RunCommandInputParameter

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

VirtualMachineRunCommandScriptSource

Имя Описание Значение
commandId Задает commandId предопределенного встроенного скрипта. строка
скрипт Указывает содержимое скрипта, выполняемого на виртуальной машине. строка
scriptUri Указывает расположение загрузки скрипта. Это может быть URI SAS большого двоичного объекта хранилища Azure с доступом на чтение или общедоступный URI. строка
scriptUriManagedIdentity Управляемое удостоверение, назначаемое пользователем, которое имеет доступ к scriptUri в случае большого двоичного объекта хранилища Azure. Используйте пустой объект в случае назначаемого системой удостоверения. Убедитесь, что blob-объект хранилища Azure существует и управляемому удостоверению предоставлен доступ к контейнеру BLOB-объектов с назначением роли "Читатель данных BLOB-объектов хранилища". В случае назначаемого пользователем удостоверения убедитесь, что вы добавили его в удостоверение виртуальной машины. Дополнительные сведения об управляемом удостоверении и выполнении команды см https://aka.ms/ManagedIdentity . в и https://aka.ms/RunCommandManaged. RunCommandManagedIdentity

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

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

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

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

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

{
  "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands",
  "apiVersion": "2023-09-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "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",
      "script": "string",
      "scriptUri": "string",
      "scriptUriManagedIdentity": {
        "clientId": "string",
        "objectId": "string"
      }
    },
    "timeoutInSeconds": "int",
    "treatFailureAsDeploymentFailure": "bool"
  }
}

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

virtualMachineScaleSets/virtualMachines/runCommands

Имя Описание Значение
тип Тип ресурса Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands
версия_API Версия API ресурсов '2023-09-01'
name имя ресурса.

Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM.		 строка (обязательно)
location Расположение ресурса строка (обязательно)
tags Теги ресурсов Словарь имен и значений тегов. См . раздел Теги в шаблонах
properties Описывает свойства команды запуска виртуальной машины. VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

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

RunCommandManagedIdentity

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

RunCommandInputParameter

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

VirtualMachineRunCommandScriptSource

Имя Описание Значение
commandId Задает commandId предопределенного встроенного скрипта. строка
скрипт Указывает содержимое скрипта, выполняемого на виртуальной машине. строка
scriptUri Указывает расположение загрузки скрипта. Это может быть URI SAS большого двоичного объекта хранилища Azure с доступом на чтение или общедоступный URI. строка
scriptUriManagedIdentity Управляемое удостоверение, назначаемое пользователем, которое имеет доступ к scriptUri в случае большого двоичного объекта хранилища Azure. Используйте пустой объект в случае назначаемого системой удостоверения. Убедитесь, что blob-объект хранилища Azure существует и управляемому удостоверению предоставлен доступ к контейнеру BLOB-объектов с назначением роли "Читатель данных BLOB-объектов хранилища". В случае назначаемого пользователем удостоверения убедитесь, что вы добавили его в удостоверение виртуальной машины. Дополнительные сведения об управляемом удостоверении и выполнении команды см https://aka.ms/ManagedIdentity . в и https://aka.ms/RunCommandManaged. RunCommandManagedIdentity

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2023-09-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    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"
        script = "string"
        scriptUri = "string"
        scriptUriManagedIdentity = {
          clientId = "string"
          objectId = "string"
        }
      }
      timeoutInSeconds = int
      treatFailureAsDeploymentFailure = bool
    }
  })
}

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

virtualMachineScaleSets/virtualMachines/runCommands

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

VirtualMachineRunCommandProperties

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

RunCommandManagedIdentity

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

RunCommandInputParameter

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

VirtualMachineRunCommandScriptSource

Имя Описание Значение
commandId Задает commandId предопределенного встроенного скрипта. строка
скрипт Указывает содержимое скрипта, выполняемого на виртуальной машине. строка
scriptUri Указывает расположение для скачивания скрипта. Это может быть URI SAS большого двоичного объекта хранилища Azure с доступом на чтение или общедоступный URI. строка
scriptUriManagedIdentity Управляемое удостоверение, назначаемое пользователем, которое имеет доступ к scriptUri в случае большого двоичного объекта хранилища Azure. Используйте пустой объект в случае назначаемого системой удостоверения. Убедитесь, что blob-объект службы хранилища Azure существует и управляемому удостоверению предоставлен доступ к контейнеру BLOB-объектов с назначением роли "Читатель данных BLOB-объектов хранилища". В случае назначаемого пользователем удостоверения убедитесь, что вы добавили его в удостоверение виртуальной машины. Дополнительные сведения об управляемом удостоверении и выполнении команды см https://aka.ms/ManagedIdentity . в и https://aka.ms/RunCommandManaged. RunCommandManagedIdentity