Virtual Machine Run Commands - List By Virtual Machine

リファレンス

Service:: Compute

API Version:: 2024-03-01

仮想マシンのすべての実行コマンドを取得する操作。

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 パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソースグループの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。
vmName	path	True	string	run コマンドを含む仮想マシンの名前。
api-version	query	True	string	クライアント API のバージョン。
$expand	query		string	操作に適用する展開式。

応答

名前	型	説明
200 OK	VirtualMachineRunCommandsListResult	OK Media Types: "application/json", "text/json"
Other Status Codes	CloudError	操作に失敗した理由を説明するエラー応答。 Media Types: "application/json", "text/json"

名前

型

説明

200 OK

VirtualMachineRunCommandsListResult

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

Other Status Codes

CloudError

操作に失敗した理由を説明するエラー応答。

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

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"
      }
    }
  ]
}

定義

名前	説明
ApiError	API エラー。
ApiErrorBase	API エラーベース。
CloudError	コンピューティングサービスからのエラー応答。
ExecutionState	スクリプトの実行状態。
InnerError	内部エラーの詳細。
InstanceViewStatus	インスタンスビューの状態。
RunCommandInputParameter	実行コマンドパラメーターのプロパティについて説明します。
RunCommandManagedIdentity	Run Command で使用されるストレージ BLOB にアクセスできるユーザー割り当てマネージド ID の clientId または objectId (両方ではなく 1 つだけを使用) が含まれます。システム割り当て ID の場合は、空の RunCommandManagedIdentity オブジェクトを使用します。 scriptUri の場合は Azure ストレージ BLOB が存在し、マネージド ID に BLOB のコンテナーへのアクセス権が与えられていることを確認します。また、"ストレージ BLOB データ閲覧者" ロールを割り当て、scriptUri BLOB を使用し、追加 BLOB (outputBlobUri、 errorBlobUri) に対して "ストレージ BLOB データ共同作成者" を割り当てるようにします。ユーザー割り当て ID の場合は、必ず VM の ID の下に追加してください。マネージド ID とコマンドの実行の詳細については、と https://aka.ms/RunCommandManagedを参照してくださいhttps://aka.ms/ManagedIdentity。
StatusLevelTypes	レベルコード。
VirtualMachineRunCommand	仮想マシンの実行コマンドについて説明します。
VirtualMachineRunCommandInstanceView	仮想マシンの実行コマンドのインスタンスビュー。
VirtualMachineRunCommandScriptSource	run コマンドのスクリプトソースについて説明します。 script、scriptUri、commandId の 1 つだけを使用します。
VirtualMachineRunCommandsListResult	List run コマンド操作の応答

ApiError

API エラー。

名前	型	説明
code	string	エラーコード。
details	ApiErrorBase[]	Api エラーの詳細
innererror	InnerError	Api の内部エラー
message	string	エラーメッセージ。
target	string	特定のエラーのターゲット。

ApiErrorBase

API エラーベース。

名前	型	説明
code	string	エラーコード。
message	string	エラーメッセージ。
target	string	特定のエラーのターゲット。

CloudError

コンピューティングサービスからのエラー応答。

名前	型	説明
error	ApiError	API エラー。

ExecutionState

スクリプトの実行状態。

名前	型	説明
Canceled	string
Failed	string
Pending	string
Running	string
Succeeded	string
TimedOut	string
Unknown	string

InnerError

内部エラーの詳細。

名前	型	説明
errordetail	string	内部エラーメッセージまたは例外ダンプ。
exceptiontype	string	例外の種類。

InstanceViewStatus

インスタンスビューの状態。

名前	型	説明
code	string	ステータスコード。
displayStatus	string	状態の短いローカライズ可能なラベル。
level	StatusLevelTypes	レベルコード。
message	string	アラートやエラーメッセージを含む詳細なステータスメッセージ。
time	string	状態の時刻。

RunCommandInputParameter

実行コマンドパラメーターのプロパティについて説明します。

名前	型	説明
name	string	run コマンドパラメーター名。
value	string	run コマンドパラメーターの値。

RunCommandManagedIdentity

Run Command で使用されるストレージ BLOB にアクセスできるユーザー割り当てマネージド ID の clientId または objectId (両方ではなく 1 つだけを使用) が含まれます。システム割り当て ID の場合は、空の RunCommandManagedIdentity オブジェクトを使用します。 scriptUri の場合は Azure ストレージ BLOB が存在し、マネージド ID に BLOB のコンテナーへのアクセス権が与えられていることを確認します。また、"ストレージ BLOB データ閲覧者" ロールを割り当て、scriptUri BLOB を使用し、追加 BLOB (outputBlobUri、 errorBlobUri) に対して "ストレージ BLOB データ共同作成者" を割り当てるようにします。ユーザー割り当て ID の場合は、必ず VM の ID の下に追加してください。マネージド ID とコマンドの実行の詳細については、と https://aka.ms/RunCommandManagedを参照してくださいhttps://aka.ms/ManagedIdentity。

名前	型	説明
clientId	string	ユーザー割り当てマネージド ID のクライアント ID (GUID 値)。これが指定されている場合は、ObjectId を使用しないでください。
objectId	string	ユーザー割り当てマネージド ID のオブジェクト ID (GUID 値)。これが指定されている場合は、ClientId を使用しないでください。

StatusLevelTypes

レベルコード。

名前	型	説明
Error	string
Info	string
Warning	string