Virtual Machine Run Commands - List By Virtual Machine

Servizio:: Compute

Versione API:: 2025-11-01

Operazione per ottenere tutti i comandi di esecuzione di una macchina virtuale.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
subscriptionId	path	True	string minLength: 1	ID della sottoscrizione di destinazione.
vmName	path	True	string	Il nome della VirtualMachine
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.
$expand	query		string	Espressione di espansione da applicare all'operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	VirtualMachineRunCommandsListResult	La richiesta ha avuto esito positivo.
Other Status Codes	CloudError	Risposta di errore imprevista.

Sicurezza

azure_auth

Azure Active Directory OAuth2 Flow.

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

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

List run commands in a Virtual Machine.

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

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/Compute/stable/2025-11-01/examples/runCommandExamples/VirtualMachineRunCommand_List.json
// this example is just showing the usage of "VirtualMachineRunCommands_ListByVirtualMachine" operation, for the dependent resources, they will have to be created separately.

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

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

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

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

Console.WriteLine("Succeeded");

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

Risposta di esempio

Codice di stato:: 200

{
  "value": [
    {
      "name": "myRunCommand",
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/runCommands/myRunCommand",
      "type": "Microsoft.Compute/virtualMachines/runCommands",
      "location": "westus",
      "tags": {
        "tag1": "value1",
        "tag2": "value2"
      },
      "properties": {
        "source": {
          "script": "Write-Host Hello World!"
        },
        "parameters": [
          {
            "name": "param1",
            "value": "value1"
          },
          {
            "name": "param2",
            "value": "value2"
          }
        ],
        "asyncExecution": false,
        "treatFailureAsDeploymentFailure": false,
        "runAsUser": "user1",
        "timeoutInSeconds": 0,
        "provisioningState": "Succeeded",
        "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt",
        "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt"
      }
    }
  ]
}

Definizioni

Nome	Descrizione
ApiError	Errore API.
ApiErrorBase	Base di errore API.
CloudError	Risposta di errore dal servizio di calcolo.
createdByType	Tipo di identità che ha creato la risorsa.
ExecutionState	Stato di esecuzione dello script.
InnerError	Dettagli dell'errore interno.
InstanceViewStatus	Stato di visualizzazione dell'istanza.
RunCommandInputParameter	Vengono descritte le proprietà di un parametro del 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.
ScriptShellTypes	Tipi di shell di script.
StatusLevelTypes	Codice a livello.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
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. Utilizzare solo una di queste origini di script: script, scriptUri, commandId, galleryScriptReferenceId.
VirtualMachineRunCommandsListResult	Risposta dell'operazione di esecuzione elenco dei comandi

ApiError

Oggetto

Errore API.

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

ApiErrorBase

Oggetto

Base di errore API.

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

CloudError

Oggetto

Risposta di errore dal servizio di calcolo.

Nome	Tipo	Descrizione
error	ApiError	Errore API.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
User
Application
ManagedIdentity
Key

ExecutionState

Enumerazione

Stato di esecuzione dello script.

Valore	Descrizione
Unknown
Pending
Running
Failed
Succeeded
TimedOut
Canceled

InnerError

Oggetto

Dettagli dell'errore interno.

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

InstanceViewStatus

Oggetto

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 (date-time)	Ora dello stato.

RunCommandInputParameter

Oggetto

Vengono descritte le proprietà di un parametro del comando di esecuzione.

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

RunCommandManagedIdentity

Oggetto

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.

ScriptShellTypes

Enumerazione

Tipi di shell di script.

Valore	Descrizione
Default	Tipo di shell di script predefinito.
Powershell7	Tipo di shell di script Powershell7.

StatusLevelTypes

Enumerazione

Codice a livello.

Valore	Descrizione
Info
Warning
Error

systemData

Oggetto

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Il timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.