Virtual Machine Run Commands - List By Virtual Machine

Служба:

Compute

Версия API:

2024-07-01

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

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

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string	Имя группы ресурсов.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно определяют подписку Microsoft Azure. Идентификатор подписки входит в состав URI для каждого вызова службы.
vmName	path	True	string	Имя виртуальной машины, содержащей команду run.
api-version	query	True	string	Версия клиентского API.
$expand	query		string	Выражение расширения, применяемое к операции.

Ответы

Имя	Тип	Описание
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.

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

HTTP

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

Java

/**
 * Samples for VirtualMachineRunCommands ListByVirtualMachine.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/runCommandExamples/
     * VirtualMachineRunCommand_List.json
     */
    /**
     * Sample code: List run commands in a Virtual Machine.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listRunCommandsInAVirtualMachine(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineRunCommands()
            .listByVirtualMachine("myResourceGroup", "myVM", null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python virtual_machine_run_command_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.virtual_machine_run_commands.list_by_virtual_machine(
        resource_group_name="myResourceGroup",
        vm_name="myVM",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/runCommandExamples/VirtualMachineRunCommand_List.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armcompute_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/runCommandExamples/VirtualMachineRunCommand_List.json
func ExampleVirtualMachineRunCommandsClient_NewListByVirtualMachinePager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewVirtualMachineRunCommandsClient().NewListByVirtualMachinePager("myResourceGroup", "myVM", &armcompute.VirtualMachineRunCommandsClientListByVirtualMachineOptions{Expand: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.VirtualMachineRunCommandsListResult = armcompute.VirtualMachineRunCommandsListResult{
		// 	Value: []*armcompute.VirtualMachineRunCommand{
		// 		{
		// 			Name: to.Ptr("myRunCommand"),
		// 			Type: to.Ptr("Microsoft.Compute/virtualMachines/runCommands"),
		// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/runCommands/myRunCommand"),
		// 			Location: to.Ptr("westus"),
		// 			Tags: map[string]*string{
		// 				"tag1": to.Ptr("value1"),
		// 				"tag2": to.Ptr("value2"),
		// 			},
		// 			Properties: &armcompute.VirtualMachineRunCommandProperties{
		// 				AsyncExecution: to.Ptr(false),
		// 				ErrorBlobURI: to.Ptr("https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt"),
		// 				OutputBlobURI: to.Ptr("https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt"),
		// 				Parameters: []*armcompute.RunCommandInputParameter{
		// 					{
		// 						Name: to.Ptr("param1"),
		// 						Value: to.Ptr("value1"),
		// 					},
		// 					{
		// 						Name: to.Ptr("param2"),
		// 						Value: to.Ptr("value2"),
		// 				}},
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				RunAsUser: to.Ptr("user1"),
		// 				Source: &armcompute.VirtualMachineRunCommandScriptSource{
		// 					Script: to.Ptr("Write-Host Hello World!"),
		// 				},
		// 				TimeoutInSeconds: to.Ptr[int32](0),
		// 				TreatFailureAsDeploymentFailure: to.Ptr(false),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to The operation to get all run commands of a Virtual Machine.
 *
 * @summary The operation to get all run commands of a Virtual Machine.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/runCommandExamples/VirtualMachineRunCommand_List.json
 */
async function listRunCommandsInAVirtualMachine() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmName = "myVM";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.virtualMachineRunCommands.listByVirtualMachine(
    resourceGroupName,
    vmName,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/runCommandExamples/VirtualMachineRunCommand_List.json
// this example is just showing the usage of "VirtualMachineRunCommands_ListByVirtualMachine" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this VirtualMachineResource created on azure
// for more information of creating VirtualMachineResource, please refer to the document of VirtualMachineResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string vmName = "myVM";
ResourceIdentifier virtualMachineResourceId = VirtualMachineResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, vmName);
VirtualMachineResource virtualMachine = client.GetVirtualMachineResource(virtualMachineResourceId);

// get the collection of this VirtualMachineRunCommandResource
VirtualMachineRunCommandCollection collection = virtualMachine.GetVirtualMachineRunCommands();

// invoke the operation and iterate over the result
await foreach (VirtualMachineRunCommandResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    VirtualMachineRunCommandData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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

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

200

{
  "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	Описывает свойства параметра команды run.
RunCommandManagedIdentity	Содержит clientId или objectId (используйте только один, а не оба) управляемого удостоверения, назначаемого пользователем, имеющего доступ к blob-объекту хранилища, используемому в команде run. Используйте пустой объект RunCommandManagedIdentity в случае назначаемого системой удостоверения. Убедитесь, что большой двоичный объект хранилища Azure существует в случае scriptUri, и управляемое удостоверение было предоставлено доступ к контейнеру BLOB-объекта с назначением роли "Средство чтения данных BLOB-объектов хранилища" с назначением ролей scriptUri и "Участник данных BLOB-объектов хранилища" для добавления BLOB-объектов (outputBlobUri, errorBlobUri). В случае назначаемого пользователем удостоверения убедитесь, что вы добавите его в удостоверение виртуальной машины. Дополнительные сведения об управляемом удостоверении и команде запуска см. в https://aka.ms/ManagedIdentity и https://aka.ms/RunCommandManaged.
StatusLevelTypes	Код уровня.
VirtualMachineRunCommand	Описывает команду запуска виртуальной машины.
VirtualMachineRunCommandInstanceView	Представление экземпляра команды выполнения виртуальной машины.
VirtualMachineRunCommandScriptSource	Описывает источники скриптов для команды выполнения. Используйте только один из скриптов, scriptUri, commandId.
VirtualMachineRunCommandsListResult	Ответ на команду выполнения списка

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

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

Имя	Тип	Описание
name	string	Имя параметра команды запуска.
value	string	Значение параметра команды run.

RunCommandManagedIdentity

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

Имя	Тип	Описание
clientId	string	Идентификатор клиента (значение GUID) управляемого удостоверения, назначаемого пользователем. Объектный идентификатор не следует использовать, если это указано.
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 будет помечен как failed. Если параметр 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	Задает идентификатор командной строки предопределенного встроенного скрипта.
script	string	Указывает содержимое скрипта, выполняемого на виртуальной машине.
scriptUri	string	Указывает расположение загрузки скрипта. Это может быть URI SAS большого двоичного объекта хранилища Azure с доступом на чтение или общедоступным универсальным кодом ресурса (URI).
scriptUriManagedIdentity	RunCommandManagedIdentity	Назначаемое пользователем управляемое удостоверение, которое имеет доступ к scriptUri в случае большого двоичного объекта хранилища Azure. Используйте пустой объект в случае назначаемого системой удостоверения. Убедитесь, что большой двоичный объект хранилища Azure существует, и управляемое удостоверение было предоставлено доступ к контейнеру BLOB-объектов с назначением роли "Читатель данных BLOB-объектов хранилища". В случае назначаемого пользователем удостоверения убедитесь, что вы добавите его в удостоверение виртуальной машины. Дополнительные сведения об управляемом удостоверении и команде запуска см. в https://aka.ms/ManagedIdentity и https://aka.ms/RunCommandManaged.

VirtualMachineRunCommandsListResult

Ответ на команду выполнения списка

Имя	Тип	Описание
nextLink	string	URI для получения следующей страницы команд выполнения.
value	VirtualMachineRunCommand[]	Список команд выполнения