Microsoft.Compute virtualMachines/runCommands 2023-09-01

Статья
08/17/2024

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

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

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

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

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

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

resource symbolicname 'Microsoft.Compute/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
  }
}

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

virtualMachines/runCommands

Имя	Описание	Ценность
имя	Имя ресурса Узнайте, как задать имена и типы дочерних ресурсов в Bicep.	строка (обязательно)
местоположение	Расположение ресурса	строка (обязательно)
Теги	Теги ресурсов	Словарь имен и значений тегов. См. теги в шаблонах
родитель	В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.	Символьное имя ресурса типа: virtualMachines
свойства	Описывает свойства команды выполнения виртуальной машины.	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	Указывает учетную запись пользователя на виртуальной машине при выполнении команды выполнения.	струна
источник	Источник скрипта выполнения команды.	VirtualMachineRunCommandScriptSource
timeoutInSeconds	Время ожидания в секундах для выполнения команды выполнения.	int
treatFailureAsDeploymentFailureFailure	Необязательный. Если задано значение true, любой сбой в скрипте завершится сбоем развертывания и provisioningState будет помечен как "Сбой". Если задано значение false, ProvisioningState будет отражать только выполнение команды выполнения платформы расширений, не указывайте, завершился ли скрипт сбоем в случае сбоев скрипта. Просмотр представления экземпляра команды выполнения в случае сбоя скрипта, чтобы увидеть executionMessage, выходные данные, ошибку: `https://aka.ms/runcommandmanaged#get-execution-status-and-results`	bool

RunCommandManagedIdentity

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

RunCommandInputParameter

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

VirtualMachineRunCommandScriptSource

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

Шаблоны быстрого запуска

Следующие шаблоны быстрого запуска развертывают этот тип ресурса.

Шаблон	Описание
подписка SharePoint / 2019 / 2016 / 2013 все настроенные развертывание	Этот шаблон создает ферму SharePoint Subscription /2019/2016/2013 с обширной конфигурацией, которая будет выполняться вручную, включая федеративную проверку подлинности с ADFS, доверие OAuth, службу профилей пользователей и веб-приложение с 2 зонами, содержащими несколько путей на основе и семейства веб-сайтов с именем узла. На виртуальных машинах SharePoint для установки последней версии Блокнота++, Visual Studio Code, Azure Data Studio, Fiddler, ULS Viewer и 7-Zip используется шоколад.

Шаблон

Описание

подписка SharePoint / 2019 / 2016 / 2013 все настроенные

развертывание

Этот шаблон создает ферму SharePoint Subscription /2019/2016/2013 с обширной конфигурацией, которая будет выполняться вручную, включая федеративную проверку подлинности с ADFS, доверие OAuth, службу профилей пользователей и веб-приложение с 2 зонами, содержащими несколько путей на основе и семейства веб-сайтов с именем узла. На виртуальных машинах SharePoint для установки последней версии Блокнота++, Visual Studio Code, Azure Data Studio, Fiddler, ULS Viewer и 7-Zip используется шоколад.

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

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

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

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

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

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

{
  "type": "Microsoft.Compute/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"
  }
}

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

virtualMachines/runCommands

Имя	Описание	Ценность
тип	Тип ресурса	"Microsoft.Compute/virtualMachines/runCommands"
apiVersion	Версия API ресурсов	'2023-09-01'
имя	Имя ресурса Узнайте, как задать имена и типы дочерних ресурсов в шаблонах ARM JSON.	строка (обязательно)
местоположение	Расположение ресурса	строка (обязательно)
Теги	Теги ресурсов	Словарь имен и значений тегов. См. теги в шаблонах
свойства	Описывает свойства команды выполнения виртуальной машины.	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	Указывает учетную запись пользователя на виртуальной машине при выполнении команды выполнения.	струна
источник	Источник скрипта выполнения команды.	VirtualMachineRunCommandScriptSource
timeoutInSeconds	Время ожидания в секундах для выполнения команды выполнения.	int
treatFailureAsDeploymentFailureFailure	Необязательный. Если задано значение true, любой сбой в скрипте завершится сбоем развертывания и provisioningState будет помечен как "Сбой". Если задано значение false, ProvisioningState будет отражать только выполнение команды выполнения платформы расширений, не указывайте, завершился ли скрипт сбоем в случае сбоев скрипта. Просмотр представления экземпляра команды выполнения в случае сбоя скрипта, чтобы увидеть executionMessage, выходные данные, ошибку: `https://aka.ms/runcommandmanaged#get-execution-status-and-results`	bool

RunCommandManagedIdentity

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

RunCommandInputParameter

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

VirtualMachineRunCommandScriptSource

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

Шаблоны быстрого запуска

Следующие шаблоны быстрого запуска развертывают этот тип ресурса.

Шаблон	Описание
подписка SharePoint / 2019 / 2016 / 2013 все настроенные развертывание	Этот шаблон создает ферму SharePoint Subscription /2019/2016/2013 с обширной конфигурацией, которая будет выполняться вручную, включая федеративную проверку подлинности с ADFS, доверие OAuth, службу профилей пользователей и веб-приложение с 2 зонами, содержащими несколько путей на основе и семейства веб-сайтов с именем узла. На виртуальных машинах SharePoint для установки последней версии Блокнота++, Visual Studio Code, Azure Data Studio, Fiddler, ULS Viewer и 7-Zip используется шоколад.

Шаблон

Описание

подписка SharePoint / 2019 / 2016 / 2013 все настроенные

развертывание

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

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

групп ресурсов

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/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
    }
  })
}

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

virtualMachines/runCommands

Имя	Описание	Ценность
тип	Тип ресурса	"Microsoft.Compute/virtualMachines/runCommands@2023-09-01"
имя	Имя ресурса	строка (обязательно)
местоположение	Расположение ресурса	строка (обязательно)
parent_id	Идентификатор ресурса, который является родительским для этого ресурса.	Идентификатор ресурса типа: virtualMachines
Теги	Теги ресурсов	Словарь имен и значений тегов.
свойства	Описывает свойства команды выполнения виртуальной машины.	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	Указывает учетную запись пользователя на виртуальной машине при выполнении команды выполнения.	струна
источник	Источник скрипта выполнения команды.	VirtualMachineRunCommandScriptSource
timeoutInSeconds	Время ожидания в секундах для выполнения команды выполнения.	int
treatFailureAsDeploymentFailureFailure	Необязательный. Если задано значение true, любой сбой в скрипте завершится сбоем развертывания и provisioningState будет помечен как "Сбой". Если задано значение false, ProvisioningState будет отражать только выполнение команды выполнения платформы расширений, не указывайте, завершился ли скрипт сбоем в случае сбоев скрипта. Просмотр представления экземпляра команды выполнения в случае сбоя скрипта, чтобы увидеть executionMessage, выходные данные, ошибку: `https://aka.ms/runcommandmanaged#get-execution-status-and-results`	bool

RunCommandManagedIdentity

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

RunCommandInputParameter

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

VirtualMachineRunCommandScriptSource

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

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

Microsoft.Compute virtualMachines/runCommands 2023-09-01

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

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

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

virtualMachines/runCommands

VirtualMachineRunCommandProperties

RunCommandManagedIdentity

RunCommandInputParameter

VirtualMachineRunCommandScriptSource

Шаблоны быстрого запуска

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

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

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

virtualMachines/runCommands

VirtualMachineRunCommandProperties

RunCommandManagedIdentity

RunCommandInputParameter

VirtualMachineRunCommandScriptSource

Шаблоны быстрого запуска

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

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

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

virtualMachines/runCommands

VirtualMachineRunCommandProperties

RunCommandManagedIdentity

RunCommandInputParameter

VirtualMachineRunCommandScriptSource

Обратная связь

Дополнительные ресурсы