Virtual Machine Run Commands - Get By Virtual Machine

Servicio:

Compute

Versión de la API:

2024-07-01

Operación para obtener el comando run.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos.
runCommandName	path	True	string	Nombre del comando run de la máquina virtual.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI de cada llamada de servicio.
vmName	path	True	string	Nombre de la máquina virtual que contiene el comando run.
api-version	query	True	string	Versión de api de cliente.
$expand	query		string	Expresión expand que se va a aplicar en la operación.

Respuestas

Nombre	Tipo	Description
200 OK	VirtualMachineRunCommand	De acuerdo Media Types: "application/json", "text/json"
Other Status Codes	CloudError	Respuesta de error que describe por qué se produjo un error en la operación. Media Types: "application/json", "text/json"

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Get a run command.

Solicitud de ejemplo

HTTP

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

Java

/**
 * Samples for VirtualMachineRunCommands GetByVirtualMachine.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/runCommandExamples/
     * VirtualMachineRunCommand_Get.json
     */
    /**
     * Sample code: Get a run command.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getARunCommand(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineRunCommands()
            .getByVirtualMachineWithResponse("myResourceGroup", "myVM", "myRunCommand", 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_get.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.get_by_virtual_machine(
        resource_group_name="myResourceGroup",
        vm_name="myVM",
        run_command_name="myRunCommand",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/runCommandExamples/VirtualMachineRunCommand_Get.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_Get.json
func ExampleVirtualMachineRunCommandsClient_GetByVirtualMachine() {
	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)
	}
	res, err := clientFactory.NewVirtualMachineRunCommandsClient().GetByVirtualMachine(ctx, "myResourceGroup", "myVM", "myRunCommand", &armcompute.VirtualMachineRunCommandsClientGetByVirtualMachineOptions{Expand: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.VirtualMachineRunCommand = 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! ; Remove-Item C:	est	estFile.txt"),
	// 		},
	// 		TimeoutInSeconds: to.Ptr[int32](3600),
	// 		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 the run command.
 *
 * @summary The operation to get the run command.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/runCommandExamples/VirtualMachineRunCommand_Get.json
 */
async function getARunCommand() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmName = "myVM";
  const runCommandName = "myRunCommand";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineRunCommands.getByVirtualMachine(
    resourceGroupName,
    vmName,
    runCommandName,
  );
  console.log(result);
}

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_Get.json
// this example is just showing the usage of "VirtualMachineRunCommands_GetByVirtualMachine" 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 VirtualMachineRunCommandResource created on azure
// for more information of creating VirtualMachineRunCommandResource, please refer to the document of VirtualMachineRunCommandResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string vmName = "myVM";
string runCommandName = "myRunCommand";
ResourceIdentifier virtualMachineRunCommandResourceId = VirtualMachineRunCommandResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, vmName, runCommandName);
VirtualMachineRunCommandResource virtualMachineRunCommand = client.GetVirtualMachineRunCommandResource(virtualMachineRunCommandResourceId);

// invoke the operation
VirtualMachineRunCommandResource result = await virtualMachineRunCommand.GetAsync();

// the variable result 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 = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Respuesta de muestra

status code:

200

{
  "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! ; Remove-Item C:\test\testFile.txt"
    },
    "parameters": [
      {
        "name": "param1",
        "value": "value1"
      },
      {
        "name": "param2",
        "value": "value2"
      }
    ],
    "asyncExecution": false,
    "treatFailureAsDeploymentFailure": false,
    "runAsUser": "user1",
    "timeoutInSeconds": 3600,
    "provisioningState": "Succeeded",
    "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt",
    "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt"
  }
}

Definiciones

Nombre	Description
ApiError	Error de API.
ApiErrorBase	Base de errores de api.
CloudError	Respuesta de error del servicio Compute.
ExecutionState	Estado de ejecución del script.
InnerError	Detalles del error interno.
InstanceViewStatus	Estado de la vista de instancia.
RunCommandInputParameter	Describe las propiedades de un parámetro de comando de ejecución.
RunCommandManagedIdentity	Contiene clientId o objectId (use solo uno, no ambos) de una identidad administrada asignada por el usuario que tenga acceso al blob de almacenamiento usado en Ejecutar comando. Use un objeto RunCommandManagedIdentity vacío en caso de identidad asignada por el sistema. Asegúrese de que el blob de Azure Storage existe en caso de scriptUri y de que se ha concedido acceso a la identidad administrada al contenedor del blob con la asignación de roles "Lector de datos de Storage Blob" con scriptUri blob y "Colaborador de datos de Storage Blob" para Append blobs(outputBlobUri, errorBlobUri). En el caso de la identidad asignada por el usuario, asegúrese de agregarla en la identidad de la máquina virtual. Para obtener más información sobre la identidad administrada y ejecutar comando, consulte https://aka.ms/ManagedIdentity y https://aka.ms/RunCommandManaged.
StatusLevelTypes	Código de nivel.
VirtualMachineRunCommand	Describe un comando de ejecución de máquina virtual.
VirtualMachineRunCommandInstanceView	Vista de instancia de un comando de ejecución de máquina virtual.
VirtualMachineRunCommandScriptSource	Describe los orígenes de script para ejecutar el comando . Use solo uno de script, scriptUri, commandId.

ApiError

Error de API.

Nombre	Tipo	Description
code	string	Código de error.
details	ApiErrorBase[]	Detalles del error de api
innererror	InnerError	Error interno de api
message	string	Mensaje de error.
target	string	Destino del error concreto.

ApiErrorBase

Base de errores de api.

Nombre	Tipo	Description
code	string	Código de error.
message	string	Mensaje de error.
target	string	Destino del error concreto.

CloudError

Respuesta de error del servicio Compute.

Nombre	Tipo	Description
error	ApiError	Error de API.

ExecutionState

Estado de ejecución del script.

Nombre	Tipo	Description
Canceled	string
Failed	string
Pending	string
Running	string
Succeeded	string
TimedOut	string
Unknown	string

InnerError

Detalles del error interno.

Nombre	Tipo	Description
errordetail	string	Mensaje de error interno o volcado de memoria de excepciones.
exceptiontype	string	Tipo de excepción.

InstanceViewStatus

Estado de la vista de instancia.

Nombre	Tipo	Description
code	string	Código de estado.
displayStatus	string	Etiqueta localizable corta para el estado.
level	StatusLevelTypes	Código de nivel.
message	string	Mensaje de estado detallado, incluido para alertas y mensajes de error.
time	string	Hora del estado.

RunCommandInputParameter

Describe las propiedades de un parámetro de comando de ejecución.

Nombre	Tipo	Description
name	string	Nombre del parámetro del comando run.
value	string	Valor del parámetro del comando run.

RunCommandManagedIdentity

Contiene clientId o objectId (use solo uno, no ambos) de una identidad administrada asignada por el usuario que tenga acceso al blob de almacenamiento usado en Ejecutar comando. Use un objeto RunCommandManagedIdentity vacío en caso de identidad asignada por el sistema. Asegúrese de que el blob de Azure Storage existe en caso de scriptUri y de que se ha concedido acceso a la identidad administrada al contenedor del blob con la asignación de roles "Lector de datos de Storage Blob" con scriptUri blob y "Colaborador de datos de Storage Blob" para Append blobs(outputBlobUri, errorBlobUri). En el caso de la identidad asignada por el usuario, asegúrese de agregarla en la identidad de la máquina virtual. Para obtener más información sobre la identidad administrada y ejecutar comando, consulte https://aka.ms/ManagedIdentity y https://aka.ms/RunCommandManaged.

Nombre	Tipo	Description
clientId	string	Id. de cliente (valor GUID) de la identidad administrada asignada por el usuario. ObjectId no se debe usar si se proporciona.
objectId	string	Id. de objeto (valor GUID) de la identidad administrada asignada por el usuario. ClientId no debe usarse si se proporciona.

StatusLevelTypes

Código de nivel.

Nombre	Tipo	Description
Error	string
Info	string
Warning	string

VirtualMachineRunCommand

Describe un comando de ejecución de máquina virtual.

Nombre	Tipo	Valor predeterminado	Description
id	string		Identificador de recurso
location	string		Ubicación del recurso
name	string		Nombre del recurso
properties.asyncExecution	boolean	False	Opcional. Si se establece en true, el aprovisionamiento se completará en cuanto se inicie el script y no esperará a que se complete el script.
properties.errorBlobManagedIdentity	RunCommandManagedIdentity		Identidad administrada asignada por el usuario que tiene acceso al blob de almacenamiento errorBlobUri. Use un objeto vacío en caso de identidad asignada por el sistema. Asegúrese de que se ha concedido acceso a la identidad administrada al contenedor del blob con la asignación de roles "Colaborador de datos de storage Blob". En el caso de la identidad asignada por el usuario, asegúrese de agregarla en la identidad de la máquina virtual. Para obtener más información sobre la identidad administrada y ejecutar comando, consulte https://aka.ms/ManagedIdentity y https://aka.ms/RunCommandManaged
properties.errorBlobUri	string		Especifica el blob de Azure Storage donde se cargará el flujo de error del script. Use un URI de SAS con lectura, anexión, creación, creación, acceso de escritura O use la identidad administrada para proporcionar a la máquina virtual acceso al blob. Consulte el parámetro errorBlobManagedIdentity.
properties.instanceView	VirtualMachineRunCommandInstanceView		Vista de instancia del comando run de la máquina virtual.
properties.outputBlobManagedIdentity	RunCommandManagedIdentity		Identidad administrada asignada por el usuario que tiene acceso al blob de almacenamiento outputBlobUri. Use un objeto vacío en caso de identidad asignada por el sistema. Asegúrese de que se ha concedido acceso a la identidad administrada al contenedor del blob con la asignación de roles "Colaborador de datos de storage Blob". En el caso de la identidad asignada por el usuario, asegúrese de agregarla en la identidad de la máquina virtual. Para obtener más información sobre la identidad administrada y ejecutar comando, consulte https://aka.ms/ManagedIdentity y https://aka.ms/RunCommandManaged
properties.outputBlobUri	string		Especifica el blob de Azure Storage donde se cargará el flujo de salida del script. Use un URI de SAS con lectura, anexión, creación, creación, acceso de escritura O use la identidad administrada para proporcionar a la máquina virtual acceso al blob. Consulte el parámetro outputBlobManagedIdentity.
properties.parameters	RunCommandInputParameter[]		Parámetros usados por el script.
properties.protectedParameters	RunCommandInputParameter[]		Parámetros usados por el script.
properties.provisioningState	string		Estado de aprovisionamiento, que solo aparece en la respuesta. Si treatFailureAsDeploymentFailure se establece en true, cualquier error en el script producirá un error en la implementación y ProvisioningState se marcará como Error. Si treatFailureAsDeploymentFailure se establece en false, ProvisioningState solo reflejaría si la plataforma de extensiones ejecutó o no el comando de ejecución, no indicaría si se produjo un error en el script en caso de errores de script. Consulte la vista de instancia del comando run en caso de errores de script para ver executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results
properties.runAsPassword	string		Especifica la contraseña de la cuenta de usuario en la máquina virtual al ejecutar el comando run.
properties.runAsUser	string		Especifica la cuenta de usuario en la máquina virtual al ejecutar el comando run.
properties.source	VirtualMachineRunCommandScriptSource		Origen del script de comando de ejecución.
properties.timeoutInSeconds	integer		Tiempo de espera en segundos para ejecutar el comando run.
properties.treatFailureAsDeploymentFailure	boolean	False	Opcional. Si se establece en true, cualquier error en el script producirá un error en la implementación y ProvisioningState se marcará como Error. Si se establece en false, ProvisioningState solo reflejaría si la plataforma de extensiones ejecutó o no el comando de ejecución, no indicaría si se produjo un error en el script en caso de errores de script. Consulte la vista de instancia del comando run en caso de errores de script para ver executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results
tags	object		Etiquetas de recursos
type	string		Tipo de recurso

VirtualMachineRunCommandInstanceView

Vista de instancia de un comando de ejecución de máquina virtual.

Nombre	Tipo	Description
endTime	string	Hora de finalización del script.
error	string	Secuencia de errores de script.
executionMessage	string	Comunicar errores de configuración de script o mensajes de ejecución.
executionState	ExecutionState	Estado de ejecución del script.
exitCode	integer	Código de salida devuelto desde la ejecución del script.
output	string	Secuencia de salida del script.
startTime	string	Hora de inicio del script.
statuses	InstanceViewStatus[]	Información de estado del recurso.

VirtualMachineRunCommandScriptSource

Describe los orígenes de script para ejecutar el comando . Use solo uno de script, scriptUri, commandId.

Nombre	Tipo	Description
commandId	string	Especifica un commandId de script integrado predefinido.
script	string	Especifica el contenido del script que se va a ejecutar en la máquina virtual.
scriptUri	string	Especifica la ubicación de descarga del script. Puede ser un URI de SAS de un blob de Azure Storage con acceso de lectura o URI público.
scriptUriManagedIdentity	RunCommandManagedIdentity	Identidad administrada asignada por el usuario que tiene acceso a scriptUri en caso de blob de Azure Storage. Use un objeto vacío en caso de identidad asignada por el sistema. Asegúrese de que existe el blob de Azure Storage y de que se ha concedido acceso a la identidad administrada al contenedor del blob con la asignación de roles "Lector de datos de blobs de almacenamiento". En el caso de la identidad asignada por el usuario, asegúrese de agregarla en la identidad de la máquina virtual. Para obtener más información sobre la identidad administrada y ejecutar comando, consulte https://aka.ms/ManagedIdentity y https://aka.ms/RunCommandManaged.