Virtual Machine Scale Set VM Run Commands - Create Or Update

Serviço:

Compute

Versão da API:

2024-07-01

A operação para criar ou atualizar o comando VM VM run.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
instanceId	path	True	string	O ID da instância da máquina virtual.
resourceGroupName	path	True	string	O nome do grupo de recursos.
runCommandName	path	True	string	O nome do comando de execução da máquina virtual.
subscriptionId	path	True	string	Credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. O ID da assinatura faz parte do URI de cada chamada de serviço.
vmScaleSetName	path	True	string	O nome do conjunto de escala de VM.
api-version	query	True	string	Versão da API do cliente.

Corpo do Pedido

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

Name	Necessário	Tipo	Description
location	True	string	Localização do recurso
properties.asyncExecution		boolean	Opcional. Se definido como true, o provisionamento será concluído assim que o script for iniciado e não aguardará a conclusão do script.
properties.errorBlobManagedIdentity		RunCommandManagedIdentity	Identidade gerenciada atribuída pelo usuário que tem acesso ao blob de armazenamento errorBlobUri. Use um objeto vazio em caso de identidade atribuída pelo sistema. Verifique se a identidade gerenciada recebeu acesso ao contêiner do blob com a atribuição de função 'Colaborador de Dados de Blob de Armazenamento'. No caso de identidade atribuída pelo usuário, certifique-se de adicioná-la sob a identidade da VM. Para obter mais informações sobre identidade gerenciada e Executar comando, consulte https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged
properties.errorBlobUri		string	Especifica o blob de armazenamento do Azure onde o fluxo de erro de script será carregado. Use um URI SAS com acesso de leitura, acréscimo, criação, gravação OU use a identidade gerenciada para fornecer à VM acesso ao blob. Consulte o parâmetro errorBlobManagedIdentity.
properties.outputBlobManagedIdentity		RunCommandManagedIdentity	Identidade gerenciada atribuída pelo usuário que tem acesso ao blob de armazenamento outputBlobUri. Use um objeto vazio em caso de identidade atribuída pelo sistema. Verifique se a identidade gerenciada recebeu acesso ao contêiner do blob com a atribuição de função 'Colaborador de Dados de Blob de Armazenamento'. No caso de identidade atribuída pelo usuário, certifique-se de adicioná-la sob a identidade da VM. Para obter mais informações sobre identidade gerenciada e Executar comando, consulte https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged
properties.outputBlobUri		string	Especifica o blob de armazenamento do Azure onde o fluxo de saída de script será carregado. Use um URI SAS com acesso de leitura, acréscimo, criação, gravação OU use a identidade gerenciada para fornecer à VM acesso ao blob. Consulte o parâmetro outputBlobManagedIdentity.
properties.parameters		RunCommandInputParameter[]	Os parâmetros usados pelo script.
properties.protectedParameters		RunCommandInputParameter[]	Os parâmetros usados pelo script.
properties.runAsPassword		string	Especifica a senha da conta de usuário na VM ao executar o comando run.
properties.runAsUser		string	Especifica a conta de usuário na VM ao executar o comando run.
properties.source		VirtualMachineRunCommandScriptSource	A origem do script de comando run.
properties.timeoutInSeconds		integer	O tempo limite em segundos para executar o comando run.
properties.treatFailureAsDeploymentFailure		boolean	Opcional. Se definido como true, qualquer falha no script falhará na implantação e ProvisioningState será marcado como Failed. Se definido como false, ProvisioningState refletiria apenas se o comando run foi executado ou não pela plataforma de extensões, não indicaria se o script falhou em caso de falhas de script. Veja a visualização da instância do comando run em caso de falhas de script para ver executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results
tags		object	Tags de recursos

Respostas

Name	Tipo	Description
200 OK	VirtualMachineRunCommand	OK Media Types: "application/json", "text/json"
201 Created	VirtualMachineRunCommand	Criado Media Types: "application/json", "text/json"
Other Status Codes	CloudError	Resposta de erro descrevendo por que a operação falhou. Media Types: "application/json", "text/json"

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

Create VirtualMachineScaleSet VM run command.

Pedido de amostra

HTTP

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

{
  "location": "West US",
  "properties": {
    "source": {
      "scriptUri": "https://mystorageaccount.blob.core.windows.net/scriptcontainer/MyScript.ps1",
      "scriptUriManagedIdentity": {
        "objectId": "4231e4d2-33e4-4e23-96b2-17888afa6072"
      }
    },
    "parameters": [
      {
        "name": "param1",
        "value": "value1"
      },
      {
        "name": "param2",
        "value": "value2"
      }
    ],
    "asyncExecution": false,
    "treatFailureAsDeploymentFailure": true,
    "runAsUser": "user1",
    "runAsPassword": "<runAsPassword>",
    "timeoutInSeconds": 3600,
    "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt",
    "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt",
    "outputBlobManagedIdentity": {
      "clientId": "22d35efb-0c99-4041-8c5b-6d24db33a69a"
    },
    "errorBlobManagedIdentity": {}
  }
}

Java

import com.azure.resourcemanager.compute.fluent.models.VirtualMachineRunCommandInner;
import com.azure.resourcemanager.compute.models.RunCommandInputParameter;
import com.azure.resourcemanager.compute.models.RunCommandManagedIdentity;
import com.azure.resourcemanager.compute.models.VirtualMachineRunCommandScriptSource;
import java.util.Arrays;

/**
 * Samples for VirtualMachineScaleSetVMRunCommands CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/runCommandExamples/
     * VirtualMachineScaleSetVMRunCommand_CreateOrUpdate.json
     */
    /**
     * Sample code: Create VirtualMachineScaleSet VM run command.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createVirtualMachineScaleSetVMRunCommand(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineScaleSetVMRunCommands().createOrUpdate(
            "myResourceGroup", "myvmScaleSet", "0", "myRunCommand",
            new VirtualMachineRunCommandInner().withLocation("West US")
                .withSource(new VirtualMachineRunCommandScriptSource()
                    .withScriptUri("https://mystorageaccount.blob.core.windows.net/scriptcontainer/MyScript.ps1")
                    .withScriptUriManagedIdentity(
                        new RunCommandManagedIdentity().withObjectId("4231e4d2-33e4-4e23-96b2-17888afa6072")))
                .withParameters(Arrays.asList(new RunCommandInputParameter().withName("param1").withValue("value1"),
                    new RunCommandInputParameter().withName("param2").withValue("value2")))
                .withAsyncExecution(false).withRunAsUser("user1").withRunAsPassword("fakeTokenPlaceholder")
                .withTimeoutInSeconds(3600)
                .withOutputBlobUri(
                    "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt")
                .withErrorBlobUri("https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt")
                .withOutputBlobManagedIdentity(
                    new RunCommandManagedIdentity().withClientId("22d35efb-0c99-4041-8c5b-6d24db33a69a"))
                .withErrorBlobManagedIdentity(new RunCommandManagedIdentity())
                .withTreatFailureAsDeploymentFailure(true),
            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_scale_set_vm_run_command_create_or_update.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_scale_set_vm_run_commands.begin_create_or_update(
        resource_group_name="myResourceGroup",
        vm_scale_set_name="myvmScaleSet",
        instance_id="0",
        run_command_name="myRunCommand",
        run_command={
            "location": "West US",
            "properties": {
                "asyncExecution": False,
                "errorBlobManagedIdentity": {},
                "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt",
                "outputBlobManagedIdentity": {"clientId": "22d35efb-0c99-4041-8c5b-6d24db33a69a"},
                "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt",
                "parameters": [{"name": "param1", "value": "value1"}, {"name": "param2", "value": "value2"}],
                "runAsPassword": "<runAsPassword>",
                "runAsUser": "user1",
                "source": {
                    "scriptUri": "https://mystorageaccount.blob.core.windows.net/scriptcontainer/MyScript.ps1",
                    "scriptUriManagedIdentity": {"objectId": "4231e4d2-33e4-4e23-96b2-17888afa6072"},
                },
                "timeoutInSeconds": 3600,
                "treatFailureAsDeploymentFailure": True,
            },
        },
    ).result()
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_CreateOrUpdate.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/azcore/to"
	"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/VirtualMachineScaleSetVMRunCommand_CreateOrUpdate.json
func ExampleVirtualMachineScaleSetVMRunCommandsClient_BeginCreateOrUpdate() {
	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)
	}
	poller, err := clientFactory.NewVirtualMachineScaleSetVMRunCommandsClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myvmScaleSet", "0", "myRunCommand", armcompute.VirtualMachineRunCommand{
		Location: to.Ptr("West US"),
		Properties: &armcompute.VirtualMachineRunCommandProperties{
			AsyncExecution:           to.Ptr(false),
			ErrorBlobManagedIdentity: &armcompute.RunCommandManagedIdentity{},
			ErrorBlobURI:             to.Ptr("https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt"),
			OutputBlobManagedIdentity: &armcompute.RunCommandManagedIdentity{
				ClientID: to.Ptr("22d35efb-0c99-4041-8c5b-6d24db33a69a"),
			},
			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"),
				}},
			RunAsPassword: to.Ptr("<runAsPassword>"),
			RunAsUser:     to.Ptr("user1"),
			Source: &armcompute.VirtualMachineRunCommandScriptSource{
				ScriptURI: to.Ptr("https://mystorageaccount.blob.core.windows.net/scriptcontainer/MyScript.ps1"),
				ScriptURIManagedIdentity: &armcompute.RunCommandManagedIdentity{
					ObjectID: to.Ptr("4231e4d2-33e4-4e23-96b2-17888afa6072"),
				},
			},
			TimeoutInSeconds:                to.Ptr[int32](3600),
			TreatFailureAsDeploymentFailure: to.Ptr(true),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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/virtualMachineScaleSets/virtualMachines/runCommands"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/runCommands/myRunCommand"),
	// 	Location: to.Ptr("westus"),
	// 	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{
	// 			ScriptURI: to.Ptr("https://mystorageaccount.blob.core.windows.net/scriptcontainer/MyScript.ps1"),
	// 		},
	// 		TimeoutInSeconds: to.Ptr[int32](3600),
	// 		TreatFailureAsDeploymentFailure: to.Ptr(true),
	// 	},
	// }
}

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 create or update the VMSS VM run command.
 *
 * @summary The operation to create or update the VMSS VM run command.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_CreateOrUpdate.json
 */
async function createVirtualMachineScaleSetVMRunCommand() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmScaleSetName = "myvmScaleSet";
  const instanceId = "0";
  const runCommandName = "myRunCommand";
  const runCommand = {
    asyncExecution: false,
    errorBlobManagedIdentity: {},
    errorBlobUri: "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt",
    location: "West US",
    outputBlobManagedIdentity: {
      clientId: "22d35efb-0c99-4041-8c5b-6d24db33a69a",
    },
    outputBlobUri:
      "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt",
    parameters: [
      { name: "param1", value: "value1" },
      { name: "param2", value: "value2" },
    ],
    runAsPassword: "<runAsPassword>",
    runAsUser: "user1",
    source: {
      scriptUri: "https://mystorageaccount.blob.core.windows.net/scriptcontainer/MyScript.ps1",
      scriptUriManagedIdentity: {
        objectId: "4231e4d2-33e4-4e23-96b2-17888afa6072",
      },
    },
    timeoutInSeconds: 3600,
    treatFailureAsDeploymentFailure: true,
  };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineScaleSetVMRunCommands.beginCreateOrUpdateAndWait(
    resourceGroupName,
    vmScaleSetName,
    instanceId,
    runCommandName,
    runCommand,
  );
  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/VirtualMachineScaleSetVMRunCommand_CreateOrUpdate.json
// this example is just showing the usage of "VirtualMachineScaleSetVMRunCommands_CreateOrUpdate" 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 VirtualMachineScaleSetVmResource created on azure
// for more information of creating VirtualMachineScaleSetVmResource, please refer to the document of VirtualMachineScaleSetVmResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string virtualMachineScaleSetName = "myvmScaleSet";
string instanceId = "0";
ResourceIdentifier virtualMachineScaleSetVmResourceId = VirtualMachineScaleSetVmResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualMachineScaleSetName, instanceId);
VirtualMachineScaleSetVmResource virtualMachineScaleSetVm = client.GetVirtualMachineScaleSetVmResource(virtualMachineScaleSetVmResourceId);

// get the collection of this VirtualMachineScaleSetVmRunCommandResource
VirtualMachineScaleSetVmRunCommandCollection collection = virtualMachineScaleSetVm.GetVirtualMachineScaleSetVmRunCommands();

// invoke the operation
string runCommandName = "myRunCommand";
VirtualMachineRunCommandData data = new VirtualMachineRunCommandData(new AzureLocation("West US"))
{
    Source = new VirtualMachineRunCommandScriptSource
    {
        ScriptUri = new Uri("https://mystorageaccount.blob.core.windows.net/scriptcontainer/MyScript.ps1"),
        ScriptUriManagedIdentity = new RunCommandManagedIdentity
        {
            ObjectId = "4231e4d2-33e4-4e23-96b2-17888afa6072",
        },
    },
    Parameters = { new RunCommandInputParameter("param1", "value1"), new RunCommandInputParameter("param2", "value2") },
    AsyncExecution = false,
    RunAsUser = "user1",
    RunAsPassword = "<runAsPassword>",
    TimeoutInSeconds = 3600,
    OutputBlobUri = new Uri("https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt"),
    ErrorBlobUri = new Uri("https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt"),
    OutputBlobManagedIdentity = new RunCommandManagedIdentity
    {
        ClientId = "22d35efb-0c99-4041-8c5b-6d24db33a69a",
    },
    ErrorBlobManagedIdentity = new RunCommandManagedIdentity(),
    TreatFailureAsDeploymentFailure = true,
};
ArmOperation<VirtualMachineScaleSetVmRunCommandResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, runCommandName, data);
VirtualMachineScaleSetVmRunCommandResource result = lro.Value;

// 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

Resposta da amostra

Código de estado:

200

{
  "name": "myRunCommand",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/runCommands/myRunCommand",
  "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands",
  "location": "westus",
  "properties": {
    "source": {
      "scriptUri": "https://mystorageaccount.blob.core.windows.net/scriptcontainer/MyScript.ps1"
    },
    "parameters": [
      {
        "name": "param1",
        "value": "value1"
      },
      {
        "name": "param2",
        "value": "value2"
      }
    ],
    "asyncExecution": false,
    "treatFailureAsDeploymentFailure": true,
    "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"
  }
}

Código de estado:

201

{
  "name": "myRunCommand",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/runCommands/myRunCommand",
  "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands",
  "location": "westus",
  "properties": {
    "source": {
      "scriptUri": "https://mystorageaccount.blob.core.windows.net/scriptcontainer/MyScript.ps1"
    },
    "parameters": [
      {
        "name": "param1",
        "value": "value1"
      },
      {
        "name": "param2",
        "value": "value2"
      }
    ],
    "asyncExecution": false,
    "treatFailureAsDeploymentFailure": true,
    "runAsUser": "user1",
    "timeoutInSeconds": 3600,
    "provisioningState": "Creating",
    "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt",
    "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt"
  }
}

Definições

Name	Description
ApiError	Erro de api.
ApiErrorBase	Base de erro da api.
CloudError	Uma resposta de erro do serviço de computação.
ExecutionState	Status de execução do script.
InnerError	Detalhes do erro interno.
InstanceViewStatus	Status da exibição da instância.
RunCommandInputParameter	Descreve as propriedades de um parâmetro de comando de execução.
RunCommandManagedIdentity	Contém clientId ou objectId (use apenas um, não ambos) de uma identidade gerenciada atribuída pelo usuário que tem acesso ao blob de armazenamento usado em Executar comando. Use um objeto RunCommandManagedIdentity vazio no caso de identidade atribuída ao sistema. Verifique se o blob de armazenamento do Azure existe no caso de scriptUri e se a identidade gerenciada recebeu acesso ao contêiner do blob com a atribuição de função 'Storage Blob Data Reader' com scriptUri blob e 'Storage Blob Data Contributor' para Append blobs(outputBlobUri, errorBlobUri). No caso da identidade atribuída pelo usuário, certifique-se de adicioná-la sob a identidade da VM. Para obter mais informações sobre identidade gerenciada e Executar comando, consulte https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged.
StatusLevelTypes	O código de nível.
VirtualMachineRunCommand	Descreve um comando de execução de máquina virtual.
VirtualMachineRunCommandInstanceView	A exibição de instância de um comando de execução de máquina virtual.
VirtualMachineRunCommandScriptSource	Descreve as fontes de script para o comando run. Use apenas um dos scripts, scriptUri, commandId.

ApiError

Erro de api.

Name	Tipo	Description
code	string	O código de erro.
details	ApiErrorBase[]	Os detalhes do erro Api
innererror	InnerError	O erro interno da Api
message	string	A mensagem de erro.
target	string	O alvo do erro específico.

ApiErrorBase

Base de erro da api.

Name	Tipo	Description
code	string	O código de erro.
message	string	A mensagem de erro.
target	string	O alvo do erro específico.

CloudError

Uma resposta de erro do serviço de computação.

Name	Tipo	Description
error	ApiError	Erro de api.

ExecutionState

Status de execução do script.

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

InnerError

Detalhes do erro interno.

Name	Tipo	Description
errordetail	string	A mensagem de erro interna ou despejo de exceção.
exceptiontype	string	O tipo de exceção.

InstanceViewStatus

Status da exibição da instância.

Name	Tipo	Description
code	string	O código de status.
displayStatus	string	O rótulo curto localizável para o status.
level	StatusLevelTypes	O código de nível.
message	string	A mensagem de status detalhada, inclusive para alertas e mensagens de erro.
time	string	A hora do status.

RunCommandInputParameter

Descreve as propriedades de um parâmetro de comando de execução.

Name	Tipo	Description
name	string	O nome do parâmetro do comando run.
value	string	O valor do parâmetro run command.

RunCommandManagedIdentity

Contém clientId ou objectId (use apenas um, não ambos) de uma identidade gerenciada atribuída pelo usuário que tem acesso ao blob de armazenamento usado em Executar comando. Use um objeto RunCommandManagedIdentity vazio no caso de identidade atribuída ao sistema. Verifique se o blob de armazenamento do Azure existe no caso de scriptUri e se a identidade gerenciada recebeu acesso ao contêiner do blob com a atribuição de função 'Storage Blob Data Reader' com scriptUri blob e 'Storage Blob Data Contributor' para Append blobs(outputBlobUri, errorBlobUri). No caso da identidade atribuída pelo usuário, certifique-se de adicioná-la sob a identidade da VM. Para obter mais informações sobre identidade gerenciada e Executar comando, consulte https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged.

Name	Tipo	Description
clientId	string	ID do cliente (valor GUID) da identidade gerenciada atribuída pelo usuário. ObjectId não deve ser usado se isso for fornecido.
objectId	string	ID do objeto (valor GUID) da identidade gerenciada atribuída pelo usuário. ClientId não deve ser usado se isso for fornecido.

StatusLevelTypes

O código de nível.

Name	Tipo	Description
Error	string
Info	string
Warning	string

VirtualMachineRunCommand

Descreve um comando de execução de máquina virtual.

Name	Tipo	Default value	Description
id	string		ID do recurso
location	string		Localização do recurso
name	string		Nome do recurso
properties.asyncExecution	boolean	False	Opcional. Se definido como true, o provisionamento será concluído assim que o script for iniciado e não aguardará a conclusão do script.
properties.errorBlobManagedIdentity	RunCommandManagedIdentity		Identidade gerenciada atribuída pelo usuário que tem acesso ao blob de armazenamento errorBlobUri. Use um objeto vazio em caso de identidade atribuída pelo sistema. Verifique se a identidade gerenciada recebeu acesso ao contêiner do blob com a atribuição de função 'Colaborador de Dados de Blob de Armazenamento'. No caso de identidade atribuída pelo usuário, certifique-se de adicioná-la sob a identidade da VM. Para obter mais informações sobre identidade gerenciada e Executar comando, consulte https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged
properties.errorBlobUri	string		Especifica o blob de armazenamento do Azure onde o fluxo de erro de script será carregado. Use um URI SAS com acesso de leitura, acréscimo, criação, gravação OU use a identidade gerenciada para fornecer à VM acesso ao blob. Consulte o parâmetro errorBlobManagedIdentity.
properties.instanceView	VirtualMachineRunCommandInstanceView		A exibição da instância de comando de execução da máquina virtual.
properties.outputBlobManagedIdentity	RunCommandManagedIdentity		Identidade gerenciada atribuída pelo usuário que tem acesso ao blob de armazenamento outputBlobUri. Use um objeto vazio em caso de identidade atribuída pelo sistema. Verifique se a identidade gerenciada recebeu acesso ao contêiner do blob com a atribuição de função 'Colaborador de Dados de Blob de Armazenamento'. No caso de identidade atribuída pelo usuário, certifique-se de adicioná-la sob a identidade da VM. Para obter mais informações sobre identidade gerenciada e Executar comando, consulte https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged
properties.outputBlobUri	string		Especifica o blob de armazenamento do Azure onde o fluxo de saída de script será carregado. Use um URI SAS com acesso de leitura, acréscimo, criação, gravação OU use a identidade gerenciada para fornecer à VM acesso ao blob. Consulte o parâmetro outputBlobManagedIdentity.
properties.parameters	RunCommandInputParameter[]		Os parâmetros usados pelo script.
properties.protectedParameters	RunCommandInputParameter[]		Os parâmetros usados pelo script.
properties.provisioningState	string		O estado de provisionamento, que só aparece na resposta. Se treatFailureAsDeploymentFailure definido como true, qualquer falha no script falhará na implantação e ProvisioningState será marcado como Failed. Se treatFailureAsDeploymentFailure definido como false, ProvisioningState refletiria apenas se o comando run foi executado ou não pela plataforma de extensões, não indicaria se o script falhou em caso de falhas de script. Veja a visualização da instância do comando run em caso de falhas de script para ver executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results
properties.runAsPassword	string		Especifica a senha da conta de usuário na VM ao executar o comando run.
properties.runAsUser	string		Especifica a conta de usuário na VM ao executar o comando run.
properties.source	VirtualMachineRunCommandScriptSource		A origem do script de comando run.
properties.timeoutInSeconds	integer		O tempo limite em segundos para executar o comando run.
properties.treatFailureAsDeploymentFailure	boolean	False	Opcional. Se definido como true, qualquer falha no script falhará na implantação e ProvisioningState será marcado como Failed. Se definido como false, ProvisioningState refletiria apenas se o comando run foi executado ou não pela plataforma de extensões, não indicaria se o script falhou em caso de falhas de script. Veja a visualização da instância do comando run em caso de falhas de script para ver executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results
tags	object		Tags de recursos
type	string		Tipo de recurso

VirtualMachineRunCommandInstanceView

A exibição de instância de um comando de execução de máquina virtual.

Name	Tipo	Description
endTime	string	Hora de término do script.
error	string	Fluxo de erro de script.
executionMessage	string	Comunique erros de configuração de script ou mensagens de execução.
executionState	ExecutionState	Status de execução do script.
exitCode	integer	Código de saída retornado da execução do script.
output	string	Fluxo de saída de script.
startTime	string	Hora de início do script.
statuses	InstanceViewStatus[]	As informações de status do recurso.

VirtualMachineRunCommandScriptSource

Descreve as fontes de script para o comando run. Use apenas um dos scripts, scriptUri, commandId.

Name	Tipo	Description
commandId	string	Especifica um commandId de script interno predefinido.
script	string	Especifica o conteúdo do script a ser executado na VM.
scriptUri	string	Especifica o local de download do script. Pode ser URI SAS de um blob de armazenamento do Azure com acesso de leitura ou URI público.
scriptUriManagedIdentity	RunCommandManagedIdentity	Identidade gerenciada atribuída pelo usuário que tem acesso ao scriptUri no caso de blob de armazenamento do Azure. Use um objeto vazio em caso de identidade atribuída pelo sistema. Verifique se o blob de armazenamento do Azure existe e se a identidade gerenciada recebeu acesso ao contêiner do blob com a atribuição de função 'Leitor de Dados de Blob de Armazenamento'. No caso de identidade atribuída pelo usuário, certifique-se de adicioná-la sob a identidade da VM. Para obter mais informações sobre identidade gerenciada e Executar comando, consulte https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged.