Virtual Machine Run Commands - List By Virtual Machine

Referens

Service:: Compute

API Version:: 2024-03-01

Åtgärden för att hämta alla körningskommandon för en virtuell dator.

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

With optional parameters:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string	Namnet på resursgruppen.
subscriptionId	path	True	string	Prenumerationsautentiseringsuppgifter som unikt identifierar Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
vmName	path	True	string	Namnet på den virtuella datorn som innehåller körningskommandot.
api-version	query	True	string	Klient-API-version.
$expand	query		string	Expanderingsuttrycket som ska tillämpas på åtgärden.

Svar

Name	Typ	Description
200 OK	VirtualMachineRunCommandsListResult	OK Media Types: "application/json", "text/json"
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades. Media Types: "application/json", "text/json"

Name

Typ

Description

200 OK

VirtualMachineRunCommandsListResult

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

Other Status Codes

CloudError

Felsvar som beskriver varför åtgärden misslyckades.

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

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

List run commands in a Virtual Machine.

Sample Request

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


/**
 * Samples for VirtualMachineRunCommands ListByVirtualMachine.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/runCommandExamples/
     * VirtualMachineRunCommand_List.json
     */
    /**
     * Sample code: List run commands in a Virtual Machine.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listRunCommandsInAVirtualMachine(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineRunCommands()
            .listByVirtualMachine("myResourceGroup", "myVM", null, com.azure.core.util.Context.NONE);
    }
}

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

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_list.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.list_by_virtual_machine(
        resource_group_name="myResourceGroup",
        vm_name="myVM",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/runCommandExamples/VirtualMachineRunCommand_List.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

package armcompute_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/runCommandExamples/VirtualMachineRunCommand_List.json
func ExampleVirtualMachineRunCommandsClient_NewListByVirtualMachinePager() {
	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)
	}
	pager := clientFactory.NewVirtualMachineRunCommandsClient().NewListByVirtualMachinePager("myResourceGroup", "myVM", &armcompute.VirtualMachineRunCommandsClientListByVirtualMachineOptions{Expand: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.VirtualMachineRunCommandsListResult = armcompute.VirtualMachineRunCommandsListResult{
		// 	Value: []*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!"),
		// 				},
		// 				TimeoutInSeconds: to.Ptr[int32](0),
		// 				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

const { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to The operation to get all run commands of a Virtual Machine.
 *
 * @summary The operation to get all run commands of a Virtual Machine.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/runCommandExamples/VirtualMachineRunCommand_List.json
 */
async function listRunCommandsInAVirtualMachine() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmName = "myVM";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.virtualMachineRunCommands.listByVirtualMachine(
    resourceGroupName,
    vmName,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

Sample Response

Status code:: 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"
      }
    }
  ]
}

Definitioner

Name	Description
ApiError	API-fel.
ApiErrorBase	Api-felbas.
CloudError	Ett felsvar från Beräkningstjänsten.
ExecutionState	Skriptkörningsstatus.
InnerError	Inre felinformation.
InstanceViewStatus	Status för instansvy.
RunCommandInputParameter	Beskriver egenskaperna för en körningskommandoparameter.
RunCommandManagedIdentity	Innehåller clientId eller objectId (använd bara ett, inte båda) för en användartilldelad hanterad identitet som har åtkomst till lagringsblob som används i Kör kommandot. Använd ett tomt RunCommandManagedIdentity-objekt vid systemtilldelad identitet. Kontrollera att Azure Storage-bloben finns i händelse av scriptUri och att den hanterade identiteten har fått åtkomst till blobcontainern med rolltilldelningen "Storage Blob Data Reader" med scriptUri-blob och "Storage Blob Data Contributor" för Tilläggsblobbar (outputBlobUri, errorBlobUri). När det gäller användartilldelad identitet kontrollerar du att du lägger till den under den virtuella datorns identitet. Mer information om hanterad identitet och Kör kommando finns i https://aka.ms/ManagedIdentity och https://aka.ms/RunCommandManaged.
StatusLevelTypes	Nivåkoden.
VirtualMachineRunCommand	Beskriver ett körningskommando för virtuell dator.
VirtualMachineRunCommandInstanceView	Instansvyn för ett virtuellt datorkörningskommando.
VirtualMachineRunCommandScriptSource	Beskriver skriptkällorna för körningskommandot. Använd bara ett skript, scriptUri, commandId.
VirtualMachineRunCommandsListResult	Kommandoåtgärdssvaret Listkörning

ApiError

API-fel.

Name	Typ	Description
code	string	Felkoden.
details	ApiErrorBase[]	Api-felinformationen
innererror	InnerError	Api:ets inre fel
message	string	Felmeddelandet.
target	string	Målet för det specifika felet.

ApiErrorBase

Api-felbas.

Name	Typ	Description
code	string	Felkoden.
message	string	Felmeddelandet.
target	string	Målet för det specifika felet.

CloudError

Ett felsvar från Beräkningstjänsten.

Name	Typ	Description
error	ApiError	API-fel.

ExecutionState

Skriptkörningsstatus.

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

InnerError

Inre felinformation.

Name	Typ	Description
errordetail	string	Det interna felmeddelandet eller undantagsdumpen.
exceptiontype	string	Undantagstypen.

InstanceViewStatus

Status för instansvy.

Name	Typ	Description
code	string	Statuskoden.
displayStatus	string	Den korta localizable etiketten för statusen.
level	StatusLevelTypes	Nivåkoden.
message	string	Det detaljerade statusmeddelandet, inklusive för aviseringar och felmeddelanden.
time	string	Tiden för statusen.

RunCommandInputParameter

Beskriver egenskaperna för en körningskommandoparameter.

Name	Typ	Description
name	string	Kör kommandoparameterns namn.
value	string	Kör kommandoparametervärdet.

RunCommandManagedIdentity

Innehåller clientId eller objectId (använd bara ett, inte båda) för en användartilldelad hanterad identitet som har åtkomst till lagringsblob som används i Kör kommandot. Använd ett tomt RunCommandManagedIdentity-objekt vid systemtilldelad identitet. Kontrollera att Azure Storage-bloben finns i händelse av scriptUri och att den hanterade identiteten har fått åtkomst till blobcontainern med rolltilldelningen "Storage Blob Data Reader" med scriptUri-blob och "Storage Blob Data Contributor" för Tilläggsblobbar (outputBlobUri, errorBlobUri). När det gäller användartilldelad identitet kontrollerar du att du lägger till den under den virtuella datorns identitet. Mer information om hanterad identitet och Kör kommando finns i https://aka.ms/ManagedIdentity och https://aka.ms/RunCommandManaged.

Name	Typ	Description
clientId	string	Klient-ID (GUID-värde) för den användartilldelade hanterade identiteten. ObjectId bör inte användas om detta anges.
objectId	string	Objekt-ID (GUID-värde) för den användartilldelade hanterade identiteten. ClientId bör inte användas om detta anges.

StatusLevelTypes

Nivåkoden.

Name	Typ	Description
Error	string
Info	string
Warning	string