Virtual Machines - Run Command

참조

서비스:: Compute

API 버전:: 2024-03-01

VM에서 명령을 실행합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
resourceGroupName	path	True	string	리소스 그룹의 이름.
subscriptionId	path	True	string	Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명 구독 ID는 모든 서비스 호출에 대한 URI의 파트를 형성합니다.
vmName	path	True	string	가상 머신의 이름입니다.
api-version	query	True	string	클라이언트 API 버전.

요청 본문

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

Name	필수	형식	Description
commandId	True	string	실행 명령 ID입니다.
parameters		RunCommandInputParameter[]	실행 명령 매개 변수입니다.
script		string[]	선택 사항입니다. 실행할 스크립트입니다. 이 값이 지정되면 지정된 스크립트가 명령의 기본 스크립트를 재정의합니다.

응답

Name	형식	Description
200 OK	RunCommandResult	정상 Media Types: "application/json", "text/json"
202 Accepted		수락됨 Media Types: "application/json", "text/json"

Name

형식

Description

200 OK

RunCommandResult

정상

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

202 Accepted

수락됨

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

보안

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	사용자 계정 가장

예제

VirtualMachineRunCommand

Sample request

POST https://management.azure.com/subscriptions/24fb23e3-6ba3-41f0-9b6e-e41131d5d61e/resourceGroups/crptestar98131/providers/Microsoft.Compute/virtualMachines/vm3036/runCommand?api-version=2024-03-01

{
  "commandId": "RunPowerShellScript"
}


import com.azure.resourcemanager.compute.models.RunCommandInput;

/**
 * Samples for VirtualMachines RunCommand.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/runCommandExamples/
     * VirtualMachineRunCommand.json
     */
    /**
     * Sample code: VirtualMachineRunCommand.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void virtualMachineRunCommand(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachines().runCommand("crptestar98131", "vm3036",
            new RunCommandInput().withCommandId("RunPowerShellScript"), 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 typing import Any, IO, Union

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.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="24fb23e3-6ba3-41f0-9b6e-e41131d5d61e",
    )

    response = client.virtual_machines.begin_run_command(
        resource_group_name="crptestar98131",
        vm_name="vm3036",
        parameters={"commandId": "RunPowerShellScript"},
    ).result()
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/runCommandExamples/VirtualMachineRunCommand.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/azcore/to"
	"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.json
func ExampleVirtualMachinesClient_BeginRunCommand() {
	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.NewVirtualMachinesClient().BeginRunCommand(ctx, "crptestar98131", "vm3036", armcompute.RunCommandInput{
		CommandID: to.Ptr("RunPowerShellScript"),
	}, 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.RunCommandResult = armcompute.RunCommandResult{
	// 	Value: []*armcompute.InstanceViewStatus{
	// 		{
	// 			Code: to.Ptr("ComponentStatus/StdOut/succeeded"),
	// 			DisplayStatus: to.Ptr("Provisioning succeeded"),
	// 			Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 			Message: to.Ptr("This is a sample script with parameters value1 value2"),
	// 		},
	// 		{
	// 			Code: to.Ptr("ComponentStatus/StdErr/succeeded"),
	// 			DisplayStatus: to.Ptr("Provisioning succeeded"),
	// 			Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 			Message: to.Ptr(""),
	// 	}},
	// }
}

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 Run command on the VM.
 *
 * @summary Run command on the VM.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/runCommandExamples/VirtualMachineRunCommand.json
 */
async function virtualMachineRunCommand() {
  const subscriptionId =
    process.env["COMPUTE_SUBSCRIPTION_ID"] || "24fb23e3-6ba3-41f0-9b6e-e41131d5d61e";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "crptestar98131";
  const vmName = "vm3036";
  const parameters = { commandId: "RunPowerShellScript" };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachines.beginRunCommandAndWait(
    resourceGroupName,
    vmName,
    parameters,
  );
  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

{
  "value": [
    {
      "code": "ComponentStatus/StdOut/succeeded",
      "level": "Info",
      "displayStatus": "Provisioning succeeded",
      "message": "This is a sample script with parameters value1 value2"
    },
    {
      "code": "ComponentStatus/StdErr/succeeded",
      "level": "Info",
      "displayStatus": "Provisioning succeeded",
      "message": ""
    }
  ]
}

Status code:: 202

Location: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/westus/operations/{operationId}&monitor=true&api-version=2024-03-01

정의

Name	Description
InstanceViewStatus	인스턴스 보기 상태.
RunCommandInput	Virtual Machine 매개 변수를 캡처합니다.
RunCommandInputParameter	실행 명령 매개 변수의 속성을 설명합니다.
RunCommandResult
StatusLevelTypes	수준 코드입니다.

InstanceViewStatus

인스턴스 보기 상태.

Name	형식	Description
code	string	상태 코드입니다.
displayStatus	string	상태 대한 짧은 지역화 가능 레이블입니다.
level	StatusLevelTypes	수준 코드입니다.
message	string	경고 및 오류 메시지를 포함하여 자세한 상태 메시지입니다.
time	string	상태 시간입니다.

RunCommandInput

Virtual Machine 매개 변수를 캡처합니다.

Name	형식	Description
commandId	string	실행 명령 ID입니다.
parameters	RunCommandInputParameter[]	실행 명령 매개 변수입니다.
script	string[]	선택 사항입니다. 실행할 스크립트입니다. 이 값이 지정되면 지정된 스크립트가 명령의 기본 스크립트를 재정의합니다.

RunCommandInputParameter

실행 명령 매개 변수의 속성을 설명합니다.

Name	형식	Description
name	string	실행 명령 매개 변수 이름입니다.
value	string	run 명령 매개 변수 값입니다.

RunCommandResult

Name	형식	Description
value	InstanceViewStatus[]	명령 작업 응답을 실행합니다.

StatusLevelTypes

수준 코드입니다.

Name	형식	Description
Error	string
Info	string
Warning	string

다음을 통해 공유

Virtual Machines - Run Command

URI 매개 변수

요청 본문

응답

보안

azure_auth

Scopes

예제

VirtualMachineRunCommand

Sample request

Sample response

정의

InstanceViewStatus

RunCommandInput

RunCommandInputParameter

RunCommandResult

StatusLevelTypes

추가 리소스