Virtual Machine Run Commands - Create Or Update

Servizio:

Compute

Versione API:

2024-07-01

Operazione da creare o aggiornare il comando di esecuzione.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string	Nome del gruppo di risorse.
runCommandName	path	True	string	Nome del comando run della macchina virtuale.
subscriptionId	path	True	string	Credenziali di sottoscrizione che identificano in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata al servizio.
vmName	path	True	string	Nome della macchina virtuale in cui deve essere creato o aggiornato il comando di esecuzione.
api-version	query	True	string	Versione dell'API client.

Corpo della richiesta

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

Nome	Necessario	Tipo	Descrizione
location	True	string	Percorso risorsa
properties.asyncExecution		boolean	Opzionale. Se impostato su true, il provisioning verrà completato non appena viene avviato lo script e non attenderà il completamento dello script.
properties.errorBlobManagedIdentity		RunCommandManagedIdentity	Identità gestita assegnata dall'utente che ha accesso al BLOB di archiviazione errorBlobUri. Usare un oggetto vuoto in caso di identità assegnata dal sistema. Assicurarsi che all'identità gestita sia stato concesso l'accesso al contenitore del BLOB con l'assegnazione di ruolo "Collaboratore ai dati dei BLOB di archiviazione". In caso di identità assegnata dall'utente, assicurarsi di aggiungerla con l'identità della macchina virtuale. Per altre informazioni sull'identità gestita ed esegui comando, vedere https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged
properties.errorBlobUri		string	Specifica il BLOB di archiviazione di Azure in cui verrà caricato il flusso di errori dello script. Usare un URI di firma di accesso condiviso con lettura, aggiunta, creazione, accesso in scrittura O usare l'identità gestita per fornire alla macchina virtuale l'accesso al BLOB. Fare riferimento al parametro errorBlobManagedIdentity.
properties.outputBlobManagedIdentity		RunCommandManagedIdentity	Identità gestita assegnata dall'utente che ha accesso al BLOB di archiviazione outputBlobUri. Usare un oggetto vuoto in caso di identità assegnata dal sistema. Assicurarsi che all'identità gestita sia stato concesso l'accesso al contenitore del BLOB con l'assegnazione di ruolo "Collaboratore ai dati dei BLOB di archiviazione". In caso di identità assegnata dall'utente, assicurarsi di aggiungerla con l'identità della macchina virtuale. Per altre informazioni sull'identità gestita ed esegui comando, vedere https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged
properties.outputBlobUri		string	Specifica il BLOB di archiviazione di Azure in cui verrà caricato il flusso di output dello script. Usare un URI di firma di accesso condiviso con lettura, aggiunta, creazione, accesso in scrittura O usare l'identità gestita per fornire alla macchina virtuale l'accesso al BLOB. Fare riferimento al parametro outputBlobManagedIdentity.
properties.parameters		RunCommandInputParameter[]	Parametri utilizzati dallo script.
properties.protectedParameters		RunCommandInputParameter[]	Parametri utilizzati dallo script.
properties.runAsPassword		string	Specifica la password dell'account utente nella macchina virtuale durante l'esecuzione del comando di esecuzione.
properties.runAsUser		string	Specifica l'account utente nella macchina virtuale durante l'esecuzione del comando di esecuzione.
properties.source		VirtualMachineRunCommandScriptSource	Origine dello script del comando di esecuzione.
properties.timeoutInSeconds		integer	Timeout in secondi per eseguire il comando di esecuzione.
properties.treatFailureAsDeploymentFailure		boolean	Opzionale. Se impostato su true, qualsiasi errore nello script non riuscirà la distribuzione e ProvisioningState verrà contrassegnato come Non riuscito. Se impostato su false, ProvisioningState riflette solo se il comando di esecuzione è stato eseguito o meno dalla piattaforma delle estensioni, non indicherà se lo script non è riuscito in caso di errori di script. Vedere la visualizzazione dell'istanza del comando di esecuzione in caso di errori di script per visualizzare executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results
tags		object	Tag delle risorse

Risposte

Nome	Tipo	Descrizione
200 OK	VirtualMachineRunCommand	OK Media Types: "application/json", "text/json"
201 Created	VirtualMachineRunCommand	Creato Media Types: "application/json", "text/json"
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita. Media Types: "application/json", "text/json"

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Create or update a run command.

Esempio di richiesta

HTTP

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

{
  "location": "West US",
  "properties": {
    "source": {
      "scriptUri": "https://mystorageaccount.blob.core.windows.net/scriptcontainer/scriptURI"
    },
    "parameters": [
      {
        "name": "param1",
        "value": "value1"
      },
      {
        "name": "param2",
        "value": "value2"
      }
    ],
    "asyncExecution": false,
    "treatFailureAsDeploymentFailure": false,
    "runAsUser": "user1",
    "runAsPassword": "<runAsPassword>",
    "timeoutInSeconds": 3600,
    "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt",
    "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/scriptcontainer/scriptURI",
    "outputBlobManagedIdentity": {
      "clientId": "22d35efb-0c99-4041-8c5b-6d24db33a69a"
    }
  }
}

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 VirtualMachineRunCommands CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/runCommandExamples/
     * VirtualMachineRunCommand_CreateOrUpdate.json
     */
    /**
     * Sample code: Create or update a run command.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createOrUpdateARunCommand(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineRunCommands().createOrUpdate(
            "myResourceGroup", "myVM", "myRunCommand",
            new VirtualMachineRunCommandInner().withLocation("West US")
                .withSource(new VirtualMachineRunCommandScriptSource()
                    .withScriptUri("https://mystorageaccount.blob.core.windows.net/scriptcontainer/scriptURI"))
                .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/scriptcontainer/scriptURI")
                .withOutputBlobManagedIdentity(
                    new RunCommandManagedIdentity().withClientId("22d35efb-0c99-4041-8c5b-6d24db33a69a"))
                .withTreatFailureAsDeploymentFailure(false),
            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_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_run_commands.begin_create_or_update(
        resource_group_name="myResourceGroup",
        vm_name="myVM",
        run_command_name="myRunCommand",
        run_command={
            "location": "West US",
            "properties": {
                "asyncExecution": False,
                "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/scriptcontainer/scriptURI",
                "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/scriptURI"},
                "timeoutInSeconds": 3600,
                "treatFailureAsDeploymentFailure": False,
            },
        },
    ).result()
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/runCommandExamples/VirtualMachineRunCommand_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/VirtualMachineRunCommand_CreateOrUpdate.json
func ExampleVirtualMachineRunCommandsClient_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.NewVirtualMachineRunCommandsClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myVM", "myRunCommand", armcompute.VirtualMachineRunCommand{
		Location: to.Ptr("West US"),
		Properties: &armcompute.VirtualMachineRunCommandProperties{
			AsyncExecution: to.Ptr(false),
			ErrorBlobURI:   to.Ptr("https://mystorageaccount.blob.core.windows.net/scriptcontainer/scriptURI"),
			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/scriptURI"),
			},
			TimeoutInSeconds:                to.Ptr[int32](3600),
			TreatFailureAsDeploymentFailure: to.Ptr(false),
		},
	}, 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{
	// 			ScriptURI: to.Ptr("https://mystorageaccount.blob.core.windows.net/scriptcontainer/MyScript.ps1"),
	// 		},
	// 		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 create or update the run command.
 *
 * @summary The operation to create or update the run command.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/runCommandExamples/VirtualMachineRunCommand_CreateOrUpdate.json
 */
async function createOrUpdateARunCommand() {
  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,
    errorBlobUri: "https://mystorageaccount.blob.core.windows.net/scriptcontainer/scriptURI",
    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/scriptURI",
    },
    timeoutInSeconds: 3600,
    treatFailureAsDeploymentFailure: false,
  };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineRunCommands.beginCreateOrUpdateAndWait(
    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_CreateOrUpdate.json
// this example is just showing the usage of "VirtualMachineRunCommands_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 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
string runCommandName = "myRunCommand";
VirtualMachineRunCommandData data = new VirtualMachineRunCommandData(new AzureLocation("West US"))
{
    Source = new VirtualMachineRunCommandScriptSource
    {
        ScriptUri = new Uri("https://mystorageaccount.blob.core.windows.net/scriptcontainer/scriptURI"),
    },
    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/scriptcontainer/scriptURI"),
    OutputBlobManagedIdentity = new RunCommandManagedIdentity
    {
        ClientId = "22d35efb-0c99-4041-8c5b-6d24db33a69a",
    },
    TreatFailureAsDeploymentFailure = false,
};
ArmOperation<VirtualMachineRunCommandResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, runCommandName, data);
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

Risposta di esempio

Codice di stato:

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": {
      "scriptUri": "https://mystorageaccount.blob.core.windows.net/scriptcontainer/MyScript.ps1"
    },
    "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"
  }
}

Codice di stato:

201

{
  "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": {
      "scriptUri": "https://mystorageaccount.blob.core.windows.net/scriptcontainer/MyScript.ps1"
    },
    "parameters": [
      {
        "name": "param1",
        "value": "value1"
      },
      {
        "name": "param2",
        "value": "value2"
      }
    ],
    "asyncExecution": false,
    "treatFailureAsDeploymentFailure": false,
    "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"
  }
}

Definizioni

Nome	Descrizione
ApiError	Errore dell'API.
ApiErrorBase	Base degli errori api.
CloudError	Risposta di errore dal servizio di calcolo.
ExecutionState	Stato di esecuzione dello script.
InnerError	Dettagli dell'errore interno.
InstanceViewStatus	Stato di visualizzazione dell'istanza.
RunCommandInputParameter	Descrive le proprietà di un parametro di comando di esecuzione.
RunCommandManagedIdentity	Contiene clientId o objectId (usare solo una, non entrambe) di un'identità gestita assegnata dall'utente che ha accesso al BLOB di archiviazione usato in Esegui comando. Usare un oggetto RunCommandManagedIdentity vuoto in caso di identità assegnata dal sistema. Assicurarsi che il BLOB di archiviazione di Azure esista nel caso di scriptUri e che all'identità gestita sia stato concesso l'accesso al contenitore del BLOB con l'assegnazione di ruolo "Lettore dati BLOB di archiviazione" con il BLOB scriptUri e "Collaboratore ai dati del BLOB di archiviazione" per i BLOB di accodamento (outputBlobUri, errorBlobUri). In caso di identità assegnata dall'utente, assicurarsi di aggiungerla con l'identità della macchina virtuale. Per altre informazioni sull'identità gestita ed esegui comando, vedere https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged.
StatusLevelTypes	Codice a livello.
VirtualMachineRunCommand	Descrive un comando di esecuzione della macchina virtuale.
VirtualMachineRunCommandInstanceView	Visualizzazione dell'istanza di un comando di esecuzione di una macchina virtuale.
VirtualMachineRunCommandScriptSource	Descrive le origini dello script per il comando di esecuzione. Usare solo uno script, scriptUri, commandId.

ApiError

Errore dell'API.

Nome	Tipo	Descrizione
code	string	Codice di errore.
details	ApiErrorBase[]	Dettagli dell'errore dell'API
innererror	InnerError	Errore interno dell'API
message	string	Messaggio di errore.
target	string	Destinazione dell'errore specifico.

ApiErrorBase

Base degli errori api.

Nome	Tipo	Descrizione
code	string	Codice di errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore specifico.

CloudError

Risposta di errore dal servizio di calcolo.

Nome	Tipo	Descrizione
error	ApiError	Errore dell'API.

ExecutionState

Stato di esecuzione dello script.

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

InnerError

Dettagli dell'errore interno.

Nome	Tipo	Descrizione
errordetail	string	Messaggio di errore interno o dump delle eccezioni.
exceptiontype	string	Tipo di eccezione.

InstanceViewStatus

Stato di visualizzazione dell'istanza.

Nome	Tipo	Descrizione
code	string	Codice di stato.
displayStatus	string	Etichetta localizzabile breve per lo stato.
level	StatusLevelTypes	Codice a livello.
message	string	Messaggio di stato dettagliato, inclusi gli avvisi e i messaggi di errore.
time	string	Ora dello stato.

RunCommandInputParameter

Descrive le proprietà di un parametro di comando di esecuzione.

Nome	Tipo	Descrizione
name	string	Nome del parametro del comando di esecuzione.
value	string	Valore del parametro del comando run.

RunCommandManagedIdentity

Contiene clientId o objectId (usare solo una, non entrambe) di un'identità gestita assegnata dall'utente che ha accesso al BLOB di archiviazione usato in Esegui comando. Usare un oggetto RunCommandManagedIdentity vuoto in caso di identità assegnata dal sistema. Assicurarsi che il BLOB di archiviazione di Azure esista nel caso di scriptUri e che all'identità gestita sia stato concesso l'accesso al contenitore del BLOB con l'assegnazione di ruolo "Lettore dati BLOB di archiviazione" con il BLOB scriptUri e "Collaboratore ai dati del BLOB di archiviazione" per i BLOB di accodamento (outputBlobUri, errorBlobUri). In caso di identità assegnata dall'utente, assicurarsi di aggiungerla con l'identità della macchina virtuale. Per altre informazioni sull'identità gestita ed esegui comando, vedere https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged.

Nome	Tipo	Descrizione
clientId	string	ID client (valore GUID) dell'identità gestita assegnata dall'utente. ObjectId non deve essere utilizzato se specificato.
objectId	string	ID oggetto (valore GUID) dell'identità gestita assegnata dall'utente. ClientId non deve essere usato se specificato.

StatusLevelTypes

Codice a livello.

Nome	Tipo	Descrizione
Error	string
Info	string
Warning	string

VirtualMachineRunCommand

Descrive un comando di esecuzione della macchina virtuale.

Nome	Tipo	Valore predefinito	Descrizione
id	string		ID risorsa
location	string		Percorso risorsa
name	string		Nome risorsa
properties.asyncExecution	boolean	False	Opzionale. Se impostato su true, il provisioning verrà completato non appena viene avviato lo script e non attenderà il completamento dello script.
properties.errorBlobManagedIdentity	RunCommandManagedIdentity		Identità gestita assegnata dall'utente che ha accesso al BLOB di archiviazione errorBlobUri. Usare un oggetto vuoto in caso di identità assegnata dal sistema. Assicurarsi che all'identità gestita sia stato concesso l'accesso al contenitore del BLOB con l'assegnazione di ruolo "Collaboratore ai dati dei BLOB di archiviazione". In caso di identità assegnata dall'utente, assicurarsi di aggiungerla con l'identità della macchina virtuale. Per altre informazioni sull'identità gestita ed esegui comando, vedere https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged
properties.errorBlobUri	string		Specifica il BLOB di archiviazione di Azure in cui verrà caricato il flusso di errori dello script. Usare un URI di firma di accesso condiviso con lettura, aggiunta, creazione, accesso in scrittura O usare l'identità gestita per fornire alla macchina virtuale l'accesso al BLOB. Fare riferimento al parametro errorBlobManagedIdentity.
properties.instanceView	VirtualMachineRunCommandInstanceView		La macchina virtuale esegue la visualizzazione dell'istanza del comando.
properties.outputBlobManagedIdentity	RunCommandManagedIdentity		Identità gestita assegnata dall'utente che ha accesso al BLOB di archiviazione outputBlobUri. Usare un oggetto vuoto in caso di identità assegnata dal sistema. Assicurarsi che all'identità gestita sia stato concesso l'accesso al contenitore del BLOB con l'assegnazione di ruolo "Collaboratore ai dati dei BLOB di archiviazione". In caso di identità assegnata dall'utente, assicurarsi di aggiungerla con l'identità della macchina virtuale. Per altre informazioni sull'identità gestita ed esegui comando, vedere https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged
properties.outputBlobUri	string		Specifica il BLOB di archiviazione di Azure in cui verrà caricato il flusso di output dello script. Usare un URI di firma di accesso condiviso con lettura, aggiunta, creazione, accesso in scrittura O usare l'identità gestita per fornire alla macchina virtuale l'accesso al BLOB. Fare riferimento al parametro outputBlobManagedIdentity.
properties.parameters	RunCommandInputParameter[]		Parametri utilizzati dallo script.
properties.protectedParameters	RunCommandInputParameter[]		Parametri utilizzati dallo script.
properties.provisioningState	string		Stato di provisioning, visualizzato solo nella risposta. Se treatFailureAsDeploymentFailure impostato su true, qualsiasi errore nello script non riuscirà la distribuzione e ProvisioningState verrà contrassegnato come Non riuscito. Se treatFailureAsDeploymentFailure impostato su false, ProvisioningState riflette solo se il comando di esecuzione è stato eseguito o meno dalla piattaforma delle estensioni, non indicherà se lo script non è riuscito in caso di errori di script. Vedere la visualizzazione dell'istanza del comando di esecuzione in caso di errori di script per visualizzare executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results
properties.runAsPassword	string		Specifica la password dell'account utente nella macchina virtuale durante l'esecuzione del comando di esecuzione.
properties.runAsUser	string		Specifica l'account utente nella macchina virtuale durante l'esecuzione del comando di esecuzione.
properties.source	VirtualMachineRunCommandScriptSource		Origine dello script del comando di esecuzione.
properties.timeoutInSeconds	integer		Timeout in secondi per eseguire il comando di esecuzione.
properties.treatFailureAsDeploymentFailure	boolean	False	Opzionale. Se impostato su true, qualsiasi errore nello script non riuscirà la distribuzione e ProvisioningState verrà contrassegnato come Non riuscito. Se impostato su false, ProvisioningState riflette solo se il comando di esecuzione è stato eseguito o meno dalla piattaforma delle estensioni, non indicherà se lo script non è riuscito in caso di errori di script. Vedere la visualizzazione dell'istanza del comando di esecuzione in caso di errori di script per visualizzare executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results
tags	object		Tag delle risorse
type	string		Tipo di risorsa

VirtualMachineRunCommandInstanceView

Visualizzazione dell'istanza di un comando di esecuzione di una macchina virtuale.

Nome	Tipo	Descrizione
endTime	string	Ora di fine dello script.
error	string	Flusso di errori dello script.
executionMessage	string	Comunicare gli errori di configurazione dello script o i messaggi di esecuzione.
executionState	ExecutionState	Stato di esecuzione dello script.
exitCode	integer	Codice di uscita restituito dall'esecuzione di script.
output	string	Flusso di output dello script.
startTime	string	Ora di inizio dello script.
statuses	InstanceViewStatus[]	Informazioni sullo stato della risorsa.

VirtualMachineRunCommandScriptSource

Descrive le origini dello script per il comando di esecuzione. Usare solo uno script, scriptUri, commandId.

Nome	Tipo	Descrizione
commandId	string	Specifica un commandId di script predefinito predefinito.
script	string	Specifica il contenuto dello script da eseguire nella macchina virtuale.
scriptUri	string	Specifica il percorso di download dello script. Può essere un URI di firma di accesso condiviso di un BLOB di archiviazione di Azure con accesso in lettura o URI pubblico.
scriptUriManagedIdentity	RunCommandManagedIdentity	Identità gestita assegnata dall'utente che ha accesso a scriptUri in caso di BLOB di archiviazione di Azure. Usare un oggetto vuoto in caso di identità assegnata dal sistema. Assicurarsi che il BLOB di archiviazione di Azure esista e che all'identità gestita sia stato concesso l'accesso al contenitore del BLOB con l'assegnazione di ruolo "Lettore dati BLOB di archiviazione". In caso di identità assegnata dall'utente, assicurarsi di aggiungerla con l'identità della macchina virtuale. Per altre informazioni sull'identità gestita ed esegui comando, vedere https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged.