Virtual Machine Run Commands - Update

Serviço:

Compute

Versão da API:

2024-07-01

A operação para atualizar o comando de execução.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
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. A ID da assinatura faz parte do URI para cada chamada de serviço.
vmName	path	True	string	O nome da máquina virtual em que o comando de execução deve ser atualizado.
api-version	query	True	string	Versão da API do cliente.

Corpo da solicitação

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

Nome	Tipo	Description
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 na 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 em que o fluxo de erros de script será carregado. Use um URI SAS com leitura, acréscimo, criação, acesso de gravação ou use a identidade gerenciada para fornecer acesso à VM 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 na 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 em que o fluxo de saída do script será carregado. Use um URI SAS com leitura, acréscimo, criação, acesso de gravação ou use a identidade gerenciada para fornecer acesso à VM 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 de execução.
properties.runAsUser	string	Especifica a conta de usuário na VM ao executar o comando de execução.
properties.source	VirtualMachineRunCommandScriptSource	A origem do script de comando de execução.
properties.timeoutInSeconds	integer	O tempo limite em segundos para executar o comando de execução.
properties.treatFailureAsDeploymentFailure	boolean	Opcional. Se definido como true, qualquer falha no script falhará na implantação e ProvisioningState será marcado como Falha. Se definido como false, ProvisioningState refletirá apenas se o comando de execução foi executado ou não pela plataforma de extensões, ele não indicaria se o script falhou em caso de falhas de script. Consulte a exibição de instância do comando de execução em caso de falhas de script para ver executionMessage, saída, erro: https://aka.ms/runcommandmanaged#get-execution-status-and-results
tags	object	Marcas de recurso

Respostas

Nome	Tipo	Description
200 OK	VirtualMachineRunCommand	OKEY Media Types: "application/json", "text/json"
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou. Media Types: "application/json", "text/json"

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Update a run command.

Solicitação de exemplo

HTTP

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

{
  "properties": {
    "source": {
      "script": "Write-Host Hello World! ; Remove-Item C:\test\testFile.txt"
    },
    "parameters": [
      {
        "name": "param1",
        "value": "value1"
      },
      {
        "name": "param2",
        "value": "value2"
      }
    ],
    "asyncExecution": false,
    "runAsUser": "user1",
    "runAsPassword": "<runAsPassword>",
    "timeoutInSeconds": 3600,
    "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/outputUri",
    "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt",
    "errorBlobManagedIdentity": {
      "objectId": "4231e4d2-33e4-4e23-96b2-17888afa6072"
    }
  }
}

Java

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

/**
 * Samples for VirtualMachineRunCommands Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/runCommandExamples/
     * VirtualMachineRunCommand_Update.json
     */
    /**
     * Sample code: Update a run command.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateARunCommand(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineRunCommands()
            .update("myResourceGroup", "myVM", "myRunCommand", new VirtualMachineRunCommandUpdate()
                .withSource(new VirtualMachineRunCommandScriptSource()
                    .withScript("Write-Host Hello World! ; Remove-Item C:\test\testFile.txt"))
                .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/outputUri")
                .withErrorBlobUri("https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt")
                .withErrorBlobManagedIdentity(
                    new RunCommandManagedIdentity().withObjectId("4231e4d2-33e4-4e23-96b2-17888afa6072")),
                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_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_run_commands.begin_update(
        resource_group_name="myResourceGroup",
        vm_name="myVM",
        run_command_name="myRunCommand",
        run_command={
            "properties": {
                "asyncExecution": False,
                "errorBlobManagedIdentity": {"objectId": "4231e4d2-33e4-4e23-96b2-17888afa6072"},
                "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt",
                "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/outputUri",
                "parameters": [{"name": "param1", "value": "value1"}, {"name": "param2", "value": "value2"}],
                "runAsPassword": "<runAsPassword>",
                "runAsUser": "user1",
                "source": {"script": "Write-Host Hello World! ; Remove-Item C:\test\testFile.txt"},
                "timeoutInSeconds": 3600,
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/runCommandExamples/VirtualMachineRunCommand_Update.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/VirtualMachineRunCommand_Update.json
func ExampleVirtualMachineRunCommandsClient_BeginUpdate() {
	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.NewVirtualMachineRunCommandsClient().BeginUpdate(ctx, "myResourceGroup", "myVM", "myRunCommand", armcompute.VirtualMachineRunCommandUpdate{
		Properties: &armcompute.VirtualMachineRunCommandProperties{
			AsyncExecution: to.Ptr(false),
			ErrorBlobManagedIdentity: &armcompute.RunCommandManagedIdentity{
				ObjectID: to.Ptr("4231e4d2-33e4-4e23-96b2-17888afa6072"),
			},
			ErrorBlobURI:  to.Ptr("https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt"),
			OutputBlobURI: to.Ptr("https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/outputUri"),
			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{
				Script: to.Ptr("Write-Host Hello World! ; Remove-Item C:	est	estFile.txt"),
			},
			TimeoutInSeconds: to.Ptr[int32](3600),
		},
	}, 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/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 update the run command.
 *
 * @summary The operation to update the run command.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/runCommandExamples/VirtualMachineRunCommand_Update.json
 */
async function updateARunCommand() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmName = "myVM";
  const runCommandName = "myRunCommand";
  const runCommand = {
    asyncExecution: false,
    errorBlobManagedIdentity: {
      objectId: "4231e4d2-33e4-4e23-96b2-17888afa6072",
    },
    errorBlobUri: "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt",
    outputBlobUri:
      "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/outputUri",
    parameters: [
      { name: "param1", value: "value1" },
      { name: "param2", value: "value2" },
    ],
    runAsPassword: "<runAsPassword>",
    runAsUser: "user1",
    source: {
      script: "Write-Host Hello World! ; Remove-Item C:\test\testFile.txt",
    },
    timeoutInSeconds: 3600,
  };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineRunCommands.beginUpdateAndWait(
    resourceGroupName,
    vmName,
    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/VirtualMachineRunCommand_Update.json
// this example is just showing the usage of "VirtualMachineRunCommands_Update" 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
VirtualMachineRunCommandUpdate runCommand = new VirtualMachineRunCommandUpdate
{
    Source = new VirtualMachineRunCommandScriptSource
    {
        Script = "Write-Host Hello World! ; Remove-Item C:\test\testFile.txt",
    },
    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/outputUri"),
    ErrorBlobUri = new Uri("https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt"),
    ErrorBlobManagedIdentity = new RunCommandManagedIdentity
    {
        ObjectId = "4231e4d2-33e4-4e23-96b2-17888afa6072",
    },
};
ArmOperation<VirtualMachineRunCommandResource> lro = await virtualMachineRunCommand.UpdateAsync(WaitUntil.Completed, runCommand);
VirtualMachineRunCommandResource 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 de exemplo

Código de status:

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": "Updating",
    "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt",
    "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt"
  }
}

Definições

Nome	Description
ApiError	Erro de API.
ApiErrorBase	Base de erros de API.
CloudError	Uma resposta de erro do serviço de computação.
ExecutionState	Status de execução de 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 tenha acesso ao blob de armazenamento usado no Comando Executar. Use um objeto RunCommandManagedIdentity vazio em caso de identidade atribuída pelo 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 "Leitor de Dados de Blob de Armazenamento" com o blob scriptUri e o 'Colaborador de Dados do Blob de Armazenamento' para blobs de acréscimo(outputBlobUri, errorBlobUri). No caso de identidade atribuída pelo usuário, adicione-a na 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 executar. Use apenas um script, scriptUri, commandId.
VirtualMachineRunCommandUpdate	Descreve um comando de execução de Máquina Virtual.

ApiError

Erro de API.

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

ApiErrorBase

Base de erros de API.

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

CloudError

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

Nome	Tipo	Description
error	ApiError	Erro de API.

ExecutionState

Status de execução de script.

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

InnerError

Detalhes do erro interno.

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

InstanceViewStatus

Status da exibição da instância.

Nome	Tipo	Description
code	string	O código de status.
displayStatus	string	O rótulo localizável curto 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.

Nome	Tipo	Description
name	string	O nome do parâmetro de comando de execução.
value	string	O valor do 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 tenha acesso ao blob de armazenamento usado no Comando Executar. Use um objeto RunCommandManagedIdentity vazio em caso de identidade atribuída pelo 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 "Leitor de Dados de Blob de Armazenamento" com o blob scriptUri e o 'Colaborador de Dados do Blob de Armazenamento' para blobs de acréscimo(outputBlobUri, errorBlobUri). No caso de identidade atribuída pelo usuário, adicione-a na identidade da VM. Para obter mais informações sobre identidade gerenciada e Executar Comando, consulte https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged.

Nome	Tipo	Description
clientId	string	ID do cliente (valor GUID) da identidade gerenciada atribuída pelo usuário. ObjectId não deverá 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.

Nome	Tipo	Description
Error	string
Info	string
Warning	string

VirtualMachineRunCommand

Descreve um comando de execução de Máquina Virtual.

Nome	Tipo	Valor padrão	Description
id	string		ID do recurso
location	string		Local 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 na 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 em que o fluxo de erros de script será carregado. Use um URI SAS com leitura, acréscimo, criação, acesso de gravação ou use a identidade gerenciada para fornecer acesso à VM ao blob. Consulte o parâmetro errorBlobManagedIdentity.
properties.instanceView	VirtualMachineRunCommandInstanceView		A máquina virtual executa a exibição da instância de comando.
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 na 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 em que o fluxo de saída do script será carregado. Use um URI SAS com leitura, acréscimo, criação, acesso de gravação ou use a identidade gerenciada para fornecer acesso à VM 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 aparece apenas na resposta. Se treatFailureAsDeploymentFailure for definido como true, qualquer falha no script falhará na implantação e ProvisioningState será marcado como Falha. Se treatFailureAsDeploymentFailure for definido como false, ProvisioningState refletirá apenas se o comando de execução foi executado ou não pela plataforma de extensões, não indicaria se o script falhou em caso de falhas de script. Consulte a exibição de instância do comando de execução em caso de falhas de script para ver executionMessage, saída, erro: 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 de execução.
properties.runAsUser	string		Especifica a conta de usuário na VM ao executar o comando de execução.
properties.source	VirtualMachineRunCommandScriptSource		A origem do script de comando de execução.
properties.timeoutInSeconds	integer		O tempo limite em segundos para executar o comando de execução.
properties.treatFailureAsDeploymentFailure	boolean	False	Opcional. Se definido como true, qualquer falha no script falhará na implantação e ProvisioningState será marcado como Falha. Se definido como false, ProvisioningState refletirá apenas se o comando de execução foi executado ou não pela plataforma de extensões, ele não indicaria se o script falhou em caso de falhas de script. Consulte a exibição de instância do comando de execução em caso de falhas de script para ver executionMessage, saída, erro: https://aka.ms/runcommandmanaged#get-execution-status-and-results
tags	object		Marcas de recurso
type	string		Tipo de recurso

VirtualMachineRunCommandInstanceView

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

Nome	Tipo	Description
endTime	string	Hora de término do script.
error	string	Fluxo de erros de script.
executionMessage	string	Comunique erros de configuração de script ou mensagens de execução.
executionState	ExecutionState	Status de execução de 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 executar. Use apenas um script, scriptUri, commandId.

Nome	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 um 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 do Blob de Armazenamento". No caso de identidade atribuída pelo usuário, certifique-se de adicioná-la na identidade da VM. Para obter mais informações sobre identidade gerenciada e Executar Comando, consulte https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged.

VirtualMachineRunCommandUpdate

Descreve um comando de execução de Máquina Virtual.

Nome	Tipo	Valor padrão	Description
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 na 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 em que o fluxo de erros de script será carregado. Use um URI SAS com leitura, acréscimo, criação, acesso de gravação ou use a identidade gerenciada para fornecer acesso à VM ao blob. Consulte o parâmetro errorBlobManagedIdentity.
properties.instanceView	VirtualMachineRunCommandInstanceView		A máquina virtual executa a exibição da instância de comando.
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 na 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 em que o fluxo de saída do script será carregado. Use um URI SAS com leitura, acréscimo, criação, acesso de gravação ou use a identidade gerenciada para fornecer acesso à VM 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 aparece apenas na resposta. Se treatFailureAsDeploymentFailure for definido como true, qualquer falha no script falhará na implantação e ProvisioningState será marcado como Falha. Se treatFailureAsDeploymentFailure for definido como false, ProvisioningState refletirá apenas se o comando de execução foi executado ou não pela plataforma de extensões, não indicaria se o script falhou em caso de falhas de script. Consulte a exibição de instância do comando de execução em caso de falhas de script para ver executionMessage, saída, erro: 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 de execução.
properties.runAsUser	string		Especifica a conta de usuário na VM ao executar o comando de execução.
properties.source	VirtualMachineRunCommandScriptSource		A origem do script de comando de execução.
properties.timeoutInSeconds	integer		O tempo limite em segundos para executar o comando de execução.
properties.treatFailureAsDeploymentFailure	boolean	False	Opcional. Se definido como true, qualquer falha no script falhará na implantação e ProvisioningState será marcado como Falha. Se definido como false, ProvisioningState refletirá apenas se o comando de execução foi executado ou não pela plataforma de extensões, ele não indicaria se o script falhou em caso de falhas de script. Consulte a exibição de instância do comando de execução em caso de falhas de script para ver executionMessage, saída, erro: https://aka.ms/runcommandmanaged#get-execution-status-and-results
tags	object		Marcas de recurso