Virtual Machine Run Commands - Get By Virtual Machine

Referencia

Service:: Compute

API Version:: 2024-03-01

A futtatási parancs lekéréséhez szükséges művelet.

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

With optional parameters:

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string	Az erőforráscsoport neve.
runCommandName	path	True	string	A virtuális gép futtatási parancsának neve.
subscriptionId	path	True	string	Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés-azonosító az URI részét képezi minden szolgáltatáshíváshoz.
vmName	path	True	string	A futtatási parancsot tartalmazó virtuális gép neve.
api-version	query	True	string	Client API-verzió.
$expand	query		string	A műveletre alkalmazni kívánt kibontási kifejezés.

Válaszok

Name	Típus	Description
200 OK	VirtualMachineRunCommand	OK Media Types: "application/json", "text/json"
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg. Media Types: "application/json", "text/json"

Name

Típus

Description

200 OK

VirtualMachineRunCommand

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

Other Status Codes

CloudError

Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

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

Biztonság

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	felhasználói fiók megszemélyesítése

Példák

Get a run command.

Sample Request

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


/**
 * Samples for VirtualMachineRunCommands GetByVirtualMachine.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-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

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

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

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

Sample Response

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

Definíciók

Name	Description
ApiError	Api-hiba.
ApiErrorBase	Api-hibabázis.
CloudError	Hibaválasz a Számítási szolgáltatástól.
ExecutionState	A szkript végrehajtásának állapota.
InnerError	Belső hiba részletei.
InstanceViewStatus	Példánynézet állapota.
RunCommandInputParameter	Egy futtatási parancsparaméter tulajdonságait ismerteti.
RunCommandManagedIdentity	Olyan felhasználó által hozzárendelt felügyelt identitás ügyfélazonosítóját vagy objectId azonosítóját tartalmazza (csak egyet, nem mindkettőt), amely hozzáféréssel rendelkezik a Futtatás parancsban használt tárolóblobhoz. Rendszer által hozzárendelt identitás esetén használjon egy üres RunCommandManagedIdentity objektumot. Győződjön meg arról, hogy az Azure Storage-blob létezik scriptUri esetén, és a felügyelt identitás hozzáférést kapott a blob tárolóhoz a "Storage Blob Data Reader" szerepkör-hozzárendeléssel a scriptUri blob és a hozzáfűző blobok "Storage Blob Data Contributor" szerepkörével (outputBlobUri, errorBlobUri). Felhasználó által hozzárendelt identitás esetén győződjön meg arról, hogy hozzáadja azt a virtuális gép identitásához. A felügyelt identitással és a parancs futtatásával kapcsolatos további információkért tekintse meg a és https://aka.ms/RunCommandManageda parancsothttps://aka.ms/ManagedIdentity.
StatusLevelTypes	A szintkód.
VirtualMachineRunCommand	Egy virtuális gép futtatási parancsát ismerteti.
VirtualMachineRunCommandInstanceView	Egy virtuális gép futtatási parancsának példánynézete.
VirtualMachineRunCommandScriptSource	A futtatási parancs szkriptforrásainak ismertetése. Csak egy szkriptet, scriptUri-t és commandId-t használjon.

ApiError

Api-hiba.

Name	Típus	Description
code	string	A hibakód.
details	ApiErrorBase[]	Az API-hiba részletei
innererror	InnerError	Az API belső hibája
message	string	A hibaüzenet.
target	string	Az adott hiba célja.

ApiErrorBase

Api-hibabázis.

Name	Típus	Description
code	string	A hibakód.
message	string	A hibaüzenet.
target	string	Az adott hiba célja.

CloudError

Hibaválasz a Számítási szolgáltatástól.

Name	Típus	Description
error	ApiError	Api-hiba.

ExecutionState

A szkript végrehajtásának állapota.

Name	Típus	Description
Canceled	string
Failed	string
Pending	string
Running	string
Succeeded	string
TimedOut	string
Unknown	string

InnerError

Belső hiba részletei.

Name	Típus	Description
errordetail	string	A belső hibaüzenet vagy kivételkép.
exceptiontype	string	A kivétel típusa.

InstanceViewStatus

Példánynézet állapota.

Name	Típus	Description
code	string	Az állapotkód.
displayStatus	string	Az állapot rövid honosítható címkéje.
level	StatusLevelTypes	A szintkód.
message	string	A részletes állapotüzenet, beleértve a riasztásokat és a hibaüzeneteket is.
time	string	Az állapot időpontja.

RunCommandInputParameter

Egy futtatási parancsparaméter tulajdonságait ismerteti.

Name	Típus	Description
name	string	A futtatási parancs paraméterének neve.
value	string	A futtatási parancs paraméterének értéke.

RunCommandManagedIdentity

Olyan felhasználó által hozzárendelt felügyelt identitás ügyfélazonosítóját vagy objectId azonosítóját tartalmazza (csak egyet, nem mindkettőt), amely hozzáféréssel rendelkezik a Futtatás parancsban használt tárolóblobhoz. Rendszer által hozzárendelt identitás esetén használjon egy üres RunCommandManagedIdentity objektumot. Győződjön meg arról, hogy az Azure Storage-blob létezik scriptUri esetén, és a felügyelt identitás hozzáférést kapott a blob tárolóhoz a "Storage Blob Data Reader" szerepkör-hozzárendeléssel a scriptUri blob és a hozzáfűző blobok "Storage Blob Data Contributor" szerepkörével (outputBlobUri, errorBlobUri). Felhasználó által hozzárendelt identitás esetén győződjön meg arról, hogy hozzáadja azt a virtuális gép identitásához. A felügyelt identitással és a parancs futtatásával kapcsolatos további információkért tekintse meg a és https://aka.ms/RunCommandManageda parancsothttps://aka.ms/ManagedIdentity.

Name	Típus	Description
clientId	string	A felhasználó által hozzárendelt felügyelt identitás ügyfélazonosítója (GUID-értéke). Az ObjectId nem használható, ha ez meg van adva.
objectId	string	A felhasználó által hozzárendelt felügyelt identitás objektumazonosítója (GUID-értéke). A ClientId nem használható, ha ez meg van adva.

StatusLevelTypes

A szintkód.

Name	Típus	Description
Error	string
Info	string
Warning	string