Virtual Machine Run Commands - Get By Virtual Machine

Tjänst:

Compute

API-version:

2024-07-01

Åtgärden för att hämta körningskommandot.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string	Namnet på resursgruppen.
runCommandName	path	True	string	Namnet på kommandot för körning av virtuell dator.
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	Det expanderingsuttryck som ska tillämpas på åtgärden.

Svar

Name	Typ	Description
200 OK	VirtualMachineRunCommand	OKEJ 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

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Get a run command.

Exempelbegäran

HTTP

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

Java

/**
 * Samples for VirtualMachineRunCommands GetByVirtualMachine.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/runCommandExamples/
     * VirtualMachineRunCommand_Get.json
     */
    /**
     * Sample code: Get a run command.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getARunCommand(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineRunCommands()
            .getByVirtualMachineWithResponse("myResourceGroup", "myVM", "myRunCommand", 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

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_get.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.get_by_virtual_machine(
        resource_group_name="myResourceGroup",
        vm_name="myVM",
        run_command_name="myRunCommand",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/runCommandExamples/VirtualMachineRunCommand_Get.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/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_Get.json
func ExampleVirtualMachineRunCommandsClient_GetByVirtualMachine() {
	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)
	}
	res, err := clientFactory.NewVirtualMachineRunCommandsClient().GetByVirtualMachine(ctx, "myResourceGroup", "myVM", "myRunCommand", &armcompute.VirtualMachineRunCommandsClientGetByVirtualMachineOptions{Expand: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %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 get the run command.
 *
 * @summary The operation to get the run command.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/runCommandExamples/VirtualMachineRunCommand_Get.json
 */
async function getARunCommand() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmName = "myVM";
  const runCommandName = "myRunCommand";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineRunCommands.getByVirtualMachine(
    resourceGroupName,
    vmName,
    runCommandName,
  );
  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_Get.json
// this example is just showing the usage of "VirtualMachineRunCommands_GetByVirtualMachine" 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
VirtualMachineRunCommandResource result = await virtualMachineRunCommand.GetAsync();

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

Exempelsvar

Statuskod:

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": "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 Compute-tjänsten.
ExecutionState	Körningsstatus för skript.
InnerError	Inre felinformation.
InstanceViewStatus	Status för instansvy.
RunCommandInputParameter	Beskriver egenskaperna för en körningskommandoparameter.
RunCommandManagedIdentity	Innehåller clientId eller objectId (använd endast ett, inte båda) för en användartilldelad hanterad identitet som har åtkomst till lagringsblob som används i Kör kommando. Använd ett tomt RunCommandManagedIdentity-objekt i händelse av 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 måste du lägga 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 körningskommando för en virtuell dator.
VirtualMachineRunCommandScriptSource	Beskriver skriptkällorna för körningskommandot. Använd endast ett skript, scriptUri, commandId.

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 Compute-tjänsten.

Name	Typ	Description
error	ApiError	Api-fel.

ExecutionState

Körningsstatus för skript.

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	Tidpunkten för statusen.

RunCommandInputParameter

Beskriver egenskaperna för en körningskommandoparameter.

Name	Typ	Description
name	string	Namnet på körningskommandoparametern.
value	string	Parametervärdet för körningskommandot.

RunCommandManagedIdentity

Innehåller clientId eller objectId (använd endast ett, inte båda) för en användartilldelad hanterad identitet som har åtkomst till lagringsblob som används i Kör kommando. Använd ett tomt RunCommandManagedIdentity-objekt i händelse av 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 måste du lägga 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

VirtualMachineRunCommand

Beskriver ett körningskommando för virtuell dator.

Name	Typ	Standardvärde	Description
id	string		Resurs-ID
location	string		Resursplats
name	string		Resursnamn
properties.asyncExecution	boolean	False	Valfri. Om värdet är true slutförs etableringen så snart skriptet startar och väntar inte på att skriptet ska slutföras.
properties.errorBlobManagedIdentity	RunCommandManagedIdentity		Användartilldelad hanterad identitet som har åtkomst till errorBlobUri-lagringsblob. Använd ett tomt objekt om det finns en systemtilldelad identitet. Kontrollera att den hanterade identiteten har fått åtkomst till blobcontainern med rolltilldelningen "Storage Blob Data Contributor". När det gäller användartilldelad identitet måste du lägga 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
properties.errorBlobUri	string		Anger den Azure Storage-blob där skriptfelströmmen ska laddas upp. Använd en SAS-URI med läs-, tilläggs-, skapa-, skrivåtkomst eller använd hanterad identitet för att ge den virtuella datorn åtkomst till bloben. Se parametern errorBlobManagedIdentity.
properties.instanceView	VirtualMachineRunCommandInstanceView		Den virtuella datorn kör kommandoinstansvyn.
properties.outputBlobManagedIdentity	RunCommandManagedIdentity		Användartilldelad hanterad identitet som har åtkomst till utdataBlobUri-lagringsblob. Använd ett tomt objekt om det finns en systemtilldelad identitet. Kontrollera att den hanterade identiteten har fått åtkomst till blobcontainern med rolltilldelningen "Storage Blob Data Contributor". När det gäller användartilldelad identitet måste du lägga 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
properties.outputBlobUri	string		Anger den Azure Storage-blob där skriptutdataströmmen ska laddas upp. Använd en SAS-URI med läs-, tilläggs-, skapa-, skrivåtkomst eller använd hanterad identitet för att ge den virtuella datorn åtkomst till bloben. Se parametern outputBlobManagedIdentity.
properties.parameters	RunCommandInputParameter[]		Parametrarna som används av skriptet.
properties.protectedParameters	RunCommandInputParameter[]		Parametrarna som används av skriptet.
properties.provisioningState	string		Etableringstillståndet, som bara visas i svaret. Om treatFailureAsDeploymentFailure har angetts till true kommer eventuella fel i skriptet att misslyckas och ProvisioningState markeras som Misslyckades. Om treatFailureAsDeploymentFailure är inställt på false, skulle ProvisioningState bara återspegla om körningskommandot kördes eller inte av tilläggsplattformen, det skulle inte ange om skriptet misslyckades vid skriptfel. Se instansvyn för körningskommandot i händelse av skriptfel för att se executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results
properties.runAsPassword	string		Anger lösenordet för användarkontot på den virtuella datorn när körningskommandot körs.
properties.runAsUser	string		Anger användarkontot på den virtuella datorn när körningskommandot körs.
properties.source	VirtualMachineRunCommandScriptSource		Källan till körningskommandoskriptet.
properties.timeoutInSeconds	integer		Tidsgränsen i sekunder för att köra körningskommandot.
properties.treatFailureAsDeploymentFailure	boolean	False	Valfri. Om värdet är true kommer eventuella fel i skriptet att misslyckas med distributionen och ProvisioningState markeras som Misslyckades. Om värdet är falskt skulle ProvisioningState bara återspegla om körningskommandot kördes eller inte av tilläggsplattformen, det skulle inte ange om skriptet misslyckades vid skriptfel. Se instansvyn för körningskommandot i händelse av skriptfel för att se executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results
tags	object		Resurstaggar
type	string		Resurstyp

VirtualMachineRunCommandInstanceView

Instansvyn för ett körningskommando för en virtuell dator.

Name	Typ	Description
endTime	string	Sluttid för skript.
error	string	Skriptfelström.
executionMessage	string	Kommunicera skriptkonfigurationsfel eller körningsmeddelanden.
executionState	ExecutionState	Körningsstatus för skript.
exitCode	integer	Slutkod som returneras från skriptkörning.
output	string	Utdataström för skript.
startTime	string	Starttid för skript.
statuses	InstanceViewStatus[]	Information om resursstatus.

VirtualMachineRunCommandScriptSource

Beskriver skriptkällorna för körningskommandot. Använd endast ett skript, scriptUri, commandId.

Name	Typ	Description
commandId	string	Anger ett commandId för fördefinierat inbyggt skript.
script	string	Anger skriptinnehållet som ska köras på den virtuella datorn.
scriptUri	string	Anger platsen för skripthämtning. Det kan vara antingen SAS-URI för en Azure-lagringsblob med läsåtkomst eller offentlig URI.
scriptUriManagedIdentity	RunCommandManagedIdentity	Användartilldelad hanterad identitet som har åtkomst till scriptUri vid Azure Storage-blob. Använd ett tomt objekt om det finns en systemtilldelad identitet. Kontrollera att Azure Storage-bloben finns och att den hanterade identiteten har fått åtkomst till blobcontainern med rolltilldelningen "Storage Blob Data Reader". När det gäller användartilldelad identitet måste du lägga 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.