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


Virtual Machine Run Commands - List By Virtual Machine

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands?api-version=2024-03-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands?$expand={$expand}&api-version=2024-03-01

Параметры URI

Имя В Обязательно Тип Описание
resourceGroupName
path True

string

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

subscriptionId
path True

string

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

vmName
path True

string

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

api-version
query True

string

Версия API клиента.

$expand
query

string

Выражение expand, применяемое к операции.

Ответы

Имя Тип Описание
200 OK

VirtualMachineRunCommandsListResult

ОК

Media Types: "application/json", "text/json"

Other Status Codes

CloudError

Ответ об ошибке, описывающий причину сбоя операции.

Media Types: "application/json", "text/json"

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

List run commands in a Virtual Machine.

Образец запроса

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/runCommands?api-version=2024-03-01

Пример ответа

{
  "value": [
    {
      "name": "myRunCommand",
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/runCommands/myRunCommand",
      "type": "Microsoft.Compute/virtualMachines/runCommands",
      "location": "westus",
      "tags": {
        "tag1": "value1",
        "tag2": "value2"
      },
      "properties": {
        "source": {
          "script": "Write-Host Hello World!"
        },
        "parameters": [
          {
            "name": "param1",
            "value": "value1"
          },
          {
            "name": "param2",
            "value": "value2"
          }
        ],
        "asyncExecution": false,
        "treatFailureAsDeploymentFailure": false,
        "runAsUser": "user1",
        "timeoutInSeconds": 0,
        "provisioningState": "Succeeded",
        "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt",
        "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt"
      }
    }
  ]
}

Определения

Имя Описание
ApiError

Ошибка API.

ApiErrorBase

База ошибок API.

CloudError

Ответ об ошибке от службы вычислений.

ExecutionState

Состояние выполнения скрипта.

InnerError

Сведения о внутренней ошибке.

InstanceViewStatus

Состояние представления экземпляра.

RunCommandInputParameter

Описывает свойства параметра команды запуска.

RunCommandManagedIdentity

Содержит clientId или objectId (используйте только один, а не оба) управляемого удостоверения, назначаемого пользователем, который имеет доступ к большому двоичному объекту хранилища, используемому в команде запуска. Используйте пустой объект RunCommandManagedIdentity в случае назначаемого системой удостоверения. Убедитесь, что blob-объект хранилища Azure существует в случае scriptUri и управляемому удостоверению предоставлен доступ к контейнеру BLOB-объекта с назначением роли "Читатель данных BLOB-объектов хранилища" с большим двоичным объектом scriptUri и "Участник данных BLOB-объекта хранилища" для добавочных BLOB-объектов (outputBlobUri, errorBlobUri). В случае назначаемого пользователем удостоверения убедитесь, что вы добавили его в удостоверение виртуальной машины. Дополнительные сведения об управляемом удостоверении и выполнении команды см https://aka.ms/ManagedIdentity . в и https://aka.ms/RunCommandManaged.

StatusLevelTypes

Код уровня.

VirtualMachineRunCommand

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

VirtualMachineRunCommandInstanceView

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

VirtualMachineRunCommandScriptSource

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

VirtualMachineRunCommandsListResult

Ответ операции выполнения команды list

ApiError

Ошибка API.

Имя Тип Описание
code

string

Код ошибки.

details

ApiErrorBase[]

Сведения об ошибке API

innererror

InnerError

Внутренняя ошибка API

message

string

Сообщение об ошибке.

target

string

Целевой объект конкретной ошибки.

ApiErrorBase

База ошибок API.

Имя Тип Описание
code

string

Код ошибки.

message

string

Сообщение об ошибке.

target

string

Целевой объект конкретной ошибки.

CloudError

Ответ об ошибке от службы вычислений.

Имя Тип Описание
error

ApiError

Ошибка API.

ExecutionState

Состояние выполнения скрипта.

Имя Тип Описание
Canceled

string

Failed

string

Pending

string

Running

string

Succeeded

string

TimedOut

string

Unknown

string

InnerError

Сведения о внутренней ошибке.

Имя Тип Описание
errordetail

string

Внутреннее сообщение об ошибке или дамп исключений.

exceptiontype

string

Тип исключения.

InstanceViewStatus

Состояние представления экземпляра.

Имя Тип Описание
code

string

Код состояния.

displayStatus

string

Короткая локализуемая метка для состояния.

level

StatusLevelTypes

Код уровня.

message

string

Подробное сообщение о состоянии, в том числе для оповещений и сообщений об ошибках.

time

string

Время состояния.

RunCommandInputParameter

Описывает свойства параметра команды запуска.

Имя Тип Описание
name

string

Имя параметра команды запуска.

value

string

Значение параметра команды запуска.

RunCommandManagedIdentity

Содержит clientId или objectId (используйте только один, а не оба) управляемого удостоверения, назначаемого пользователем, который имеет доступ к большому двоичному объекту хранилища, используемому в команде запуска. Используйте пустой объект RunCommandManagedIdentity в случае назначаемого системой удостоверения. Убедитесь, что blob-объект хранилища Azure существует в случае scriptUri и управляемому удостоверению предоставлен доступ к контейнеру BLOB-объекта с назначением роли "Читатель данных BLOB-объектов хранилища" с большим двоичным объектом scriptUri и "Участник данных BLOB-объекта хранилища" для добавочных BLOB-объектов (outputBlobUri, errorBlobUri). В случае назначаемого пользователем удостоверения убедитесь, что вы добавили его в удостоверение виртуальной машины. Дополнительные сведения об управляемом удостоверении и выполнении команды см https://aka.ms/ManagedIdentity . в и https://aka.ms/RunCommandManaged.

Имя Тип Описание
clientId

string

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

objectId

string

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

StatusLevelTypes

Код уровня.

Имя Тип Описание
Error

string

Info

string

Warning

string

VirtualMachineRunCommand

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

Имя Тип Default value Описание
id

string

Идентификатор ресурса

location

string

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

name

string

Имя ресурса

properties.asyncExecution

boolean

False

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

properties.errorBlobManagedIdentity

RunCommandManagedIdentity

Управляемое удостоверение, назначаемое пользователем, которое имеет доступ к blob-объекту хранилища errorBlobUri. Используйте пустой объект в случае назначаемого системой удостоверения. Убедитесь, что управляемому удостоверению предоставлен доступ к контейнеру BLOB-объектов с назначением роли "Участник данных BLOB-объектов хранилища". В случае назначаемого пользователем удостоверения убедитесь, что вы добавили его в удостоверение виртуальной машины. Дополнительные сведения об управляемом удостоверении и выполнении команды см https://aka.ms/ManagedIdentity . в и https://aka.ms/RunCommandManaged

properties.errorBlobUri

string

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

properties.instanceView

VirtualMachineRunCommandInstanceView

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

properties.outputBlobManagedIdentity

RunCommandManagedIdentity

Управляемое удостоверение, назначаемое пользователем, которое имеет доступ к blob-объекту хранилища outputBlobUri. Используйте пустой объект в случае назначаемого системой удостоверения. Убедитесь, что управляемому удостоверению предоставлен доступ к контейнеру BLOB-объектов с назначением роли "Участник данных BLOB-объектов хранилища". В случае назначаемого пользователем удостоверения убедитесь, что вы добавили его в удостоверение виртуальной машины. Дополнительные сведения об управляемом удостоверении и выполнении команды см https://aka.ms/ManagedIdentity . в и https://aka.ms/RunCommandManaged

properties.outputBlobUri

string

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

properties.parameters

RunCommandInputParameter[]

Параметры, используемые скриптом.

properties.protectedParameters

RunCommandInputParameter[]

Параметры, используемые скриптом.

properties.provisioningState

string

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

properties.runAsPassword

string

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

properties.runAsUser

string

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

properties.source

VirtualMachineRunCommandScriptSource

Источник скрипта команды запуска.

properties.timeoutInSeconds

integer

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

properties.treatFailureAsDeploymentFailure

boolean

False

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

tags

object

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

type

string

Тип ресурса

VirtualMachineRunCommandInstanceView

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

Имя Тип Описание
endTime

string

Время окончания скрипта.

error

string

Поток ошибок скрипта.

executionMessage

string

Сообщать об ошибках конфигурации скрипта или сообщениях о выполнении.

executionState

ExecutionState

Состояние выполнения скрипта.

exitCode

integer

Код выхода, возвращенный при выполнении скрипта.

output

string

Поток вывода скрипта.

startTime

string

Время начала скрипта.

statuses

InstanceViewStatus[]

Сведения о состоянии ресурса.

VirtualMachineRunCommandScriptSource

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

Имя Тип Описание
commandId

string

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

script

string

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

scriptUri

string

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

scriptUriManagedIdentity

RunCommandManagedIdentity

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

VirtualMachineRunCommandsListResult

Ответ операции выполнения команды list

Имя Тип Описание
nextLink

string

Универсальный код ресурса (URI) для получения следующей страницы команд выполнения.

value

VirtualMachineRunCommand[]

Список команд выполнения