Virtual Machine Run Commands - Update

Ссылка

Служба:: Compute

Версия API:: 2024-03-01

Операция обновления команды выполнения.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string	Имя группы ресурсов.
runCommandName	path	True	string	Имя команды выполнения виртуальной машины.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.
vmName	path	True	string	Имя виртуальной машины, на которой должна быть обновлена команда выполнения.
api-version	query	True	string	Версия API клиента.

Текст запроса

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

Имя	Тип	Описание
properties.asyncExecution	boolean	Необязательный элемент. Если задано значение true, подготовка завершится сразу после запуска скрипта и не будет ожидать завершения скрипта.
properties.errorBlobManagedIdentity	RunCommandManagedIdentity	Управляемое удостоверение, назначаемое пользователем, которое имеет доступ к blob-объекту хранилища errorBlobUri. Используйте пустой объект в случае назначаемого системой удостоверения. Убедитесь, что управляемому удостоверению предоставлен доступ к контейнеру BLOB-объектов с назначением роли "Участник данных BLOB-объектов хранилища". В случае назначаемого пользователем удостоверения убедитесь, что вы добавили его в удостоверение виртуальной машины. Дополнительные сведения об управляемом удостоверении и выполнении команды см. в https://aka.ms/ManagedIdentity и https://aka.ms/RunCommandManaged
properties.errorBlobUri	string	Указывает большой двоичный объект хранилища Azure, куда будет отправляться поток ошибок скрипта. Используйте URI SAS с доступом на чтение, добавление, создание, запись или используйте управляемое удостоверение, чтобы предоставить виртуальной машине доступ к большому двоичному объекту. См. параметр errorBlobManagedIdentity.
properties.outputBlobManagedIdentity	RunCommandManagedIdentity	Управляемое удостоверение, назначаемое пользователем, которое имеет доступ к большому двоичному объекту хранилища outputBlobUri. Используйте пустой объект в случае назначаемого системой удостоверения. Убедитесь, что управляемому удостоверению предоставлен доступ к контейнеру BLOB-объектов с назначением роли "Участник данных BLOB-объектов хранилища". В случае назначаемого пользователем удостоверения убедитесь, что вы добавили его в удостоверение виртуальной машины. Дополнительные сведения об управляемом удостоверении и выполнении команды см. в https://aka.ms/ManagedIdentity и https://aka.ms/RunCommandManaged
properties.outputBlobUri	string	Указывает большой двоичный объект службы хранилища Azure, куда будет отправляться поток вывода скрипта. Используйте URI SAS с доступом на чтение, добавление, создание, запись или используйте управляемое удостоверение, чтобы предоставить виртуальной машине доступ к большому двоичному объекту. См. параметр outputBlobManagedIdentity.
properties.parameters	RunCommandInputParameter[]	Параметры, используемые скриптом.
properties.protectedParameters	RunCommandInputParameter[]	Параметры, используемые скриптом.
properties.runAsPassword	string	Указывает пароль учетной записи пользователя на виртуальной машине при выполнении команды выполнения.
properties.runAsUser	string	Указывает учетную запись пользователя на виртуальной машине при выполнении команды выполнения.
properties.source	VirtualMachineRunCommandScriptSource	Источник скрипта выполнения команд.
properties.timeoutInSeconds	integer	Время ожидания в секундах для выполнения команды выполнения.
properties.treatFailureAsDeploymentFailure	boolean	Необязательный элемент. Если задано значение true, любой сбой в скрипте приведет к сбою развертывания, а ProvisioningState будет помечен как Сбой. Если задано значение false, ProvisioningState будет отражать только выполнение команды выполнения платформой расширений, и не будет указывать, произошел ли сбой скрипта в случае сбоя скрипта. Просмотрите представление экземпляра команды run в случае сбоя скрипта, чтобы увидеть executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results
tags	object	Теги ресурсов

Ответы

Имя	Тип	Описание
200 OK	VirtualMachineRunCommand	ОК Media Types: "application/json", "text/json"
Other Status Codes	CloudError	Ответ об ошибке, описывающий причину сбоя операции. Media Types: "application/json", "text/json"

Имя

Тип

Описание

200 OK

VirtualMachineRunCommand

ОК

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

Other Status Codes

CloudError

Ответ об ошибке, описывающий причину сбоя операции.

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

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Update a run command.

Образец запроса

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

{
  "properties": {
    "source": {
      "script": "Write-Host Hello World! ; Remove-Item C:\test\testFile.txt"
    },
    "parameters": [
      {
        "name": "param1",
        "value": "value1"
      },
      {
        "name": "param2",
        "value": "value2"
      }
    ],
    "asyncExecution": false,
    "runAsUser": "user1",
    "runAsPassword": "<runAsPassword>",
    "timeoutInSeconds": 3600,
    "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/outputUri",
    "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt",
    "errorBlobManagedIdentity": {
      "objectId": "4231e4d2-33e4-4e23-96b2-17888afa6072"
    }
  }
}


import com.azure.resourcemanager.compute.models.RunCommandInputParameter;
import com.azure.resourcemanager.compute.models.RunCommandManagedIdentity;
import com.azure.resourcemanager.compute.models.VirtualMachineRunCommandScriptSource;
import com.azure.resourcemanager.compute.models.VirtualMachineRunCommandUpdate;
import java.util.Arrays;

/**
 * Samples for VirtualMachineRunCommands Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/runCommandExamples/
     * VirtualMachineRunCommand_Update.json
     */
    /**
     * Sample code: Update a run command.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateARunCommand(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineRunCommands()
            .update("myResourceGroup", "myVM", "myRunCommand", new VirtualMachineRunCommandUpdate()
                .withSource(new VirtualMachineRunCommandScriptSource()
                    .withScript("Write-Host Hello World! ; Remove-Item C:\test\testFile.txt"))
                .withParameters(Arrays.asList(new RunCommandInputParameter().withName("param1").withValue("value1"),
                    new RunCommandInputParameter().withName("param2").withValue("value2")))
                .withAsyncExecution(false).withRunAsUser("user1").withRunAsPassword("fakeTokenPlaceholder")
                .withTimeoutInSeconds(3600)
                .withOutputBlobUri("https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/outputUri")
                .withErrorBlobUri("https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt")
                .withErrorBlobManagedIdentity(
                    new RunCommandManagedIdentity().withObjectId("4231e4d2-33e4-4e23-96b2-17888afa6072")),
                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_update.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.begin_update(
        resource_group_name="myResourceGroup",
        vm_name="myVM",
        run_command_name="myRunCommand",
        run_command={
            "properties": {
                "asyncExecution": False,
                "errorBlobManagedIdentity": {"objectId": "4231e4d2-33e4-4e23-96b2-17888afa6072"},
                "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt",
                "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/outputUri",
                "parameters": [{"name": "param1", "value": "value1"}, {"name": "param2", "value": "value2"}],
                "runAsPassword": "<runAsPassword>",
                "runAsUser": "user1",
                "source": {"script": "Write-Host Hello World! ; Remove-Item C:\test\testFile.txt"},
                "timeoutInSeconds": 3600,
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/runCommandExamples/VirtualMachineRunCommand_Update.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_Update.json
func ExampleVirtualMachineRunCommandsClient_BeginUpdate() {
	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.NewVirtualMachineRunCommandsClient().BeginUpdate(ctx, "myResourceGroup", "myVM", "myRunCommand", armcompute.VirtualMachineRunCommandUpdate{
		Properties: &armcompute.VirtualMachineRunCommandProperties{
			AsyncExecution: to.Ptr(false),
			ErrorBlobManagedIdentity: &armcompute.RunCommandManagedIdentity{
				ObjectID: to.Ptr("4231e4d2-33e4-4e23-96b2-17888afa6072"),
			},
			ErrorBlobURI:  to.Ptr("https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt"),
			OutputBlobURI: to.Ptr("https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/outputUri"),
			Parameters: []*armcompute.RunCommandInputParameter{
				{
					Name:  to.Ptr("param1"),
					Value: to.Ptr("value1"),
				},
				{
					Name:  to.Ptr("param2"),
					Value: to.Ptr("value2"),
				}},
			RunAsPassword: to.Ptr("<runAsPassword>"),
			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),
		},
	}, 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.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 update the run command.
 *
 * @summary The operation to update the run command.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/runCommandExamples/VirtualMachineRunCommand_Update.json
 */
async function updateARunCommand() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmName = "myVM";
  const runCommandName = "myRunCommand";
  const runCommand = {
    asyncExecution: false,
    errorBlobManagedIdentity: {
      objectId: "4231e4d2-33e4-4e23-96b2-17888afa6072",
    },
    errorBlobUri: "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt",
    outputBlobUri:
      "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/outputUri",
    parameters: [
      { name: "param1", value: "value1" },
      { name: "param2", value: "value2" },
    ],
    runAsPassword: "<runAsPassword>",
    runAsUser: "user1",
    source: {
      script: "Write-Host Hello World! ; Remove-Item C:\test\testFile.txt",
    },
    timeoutInSeconds: 3600,
  };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineRunCommands.beginUpdateAndWait(
    resourceGroupName,
    vmName,
    runCommandName,
    runCommand,
  );
  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

Пример ответа

Код состояния:: 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": "Updating",
    "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	Содержит clientId или objectId (используйте только один, а не оба) управляемого удостоверения, назначаемого пользователем, который имеет доступ к большому двоичному объекту хранилища, используемому в команде run. Используйте пустой объект RunCommandManagedIdentity в случае назначаемого системой удостоверения. Убедитесь, что blob-объект хранилища Azure существует в случае scriptUri и управляемому удостоверению предоставлен доступ к контейнеру BLOB-объектов с назначением роли "Читатель данных BLOB-объектов хранилища" с большим двоичным объектом scriptUri и "Участник данных BLOB-объектов хранилища" для добавочных BLOB-объектов(outputBlobUri, errorBlobUri). В случае назначаемого пользователем удостоверения убедитесь, что вы добавили его в удостоверение виртуальной машины. Дополнительные сведения об управляемом удостоверении и выполнении команды см. в разделе https://aka.ms/ManagedIdentity и https://aka.ms/RunCommandManaged.
StatusLevelTypes	Код уровня.
VirtualMachineRunCommand	Описывает команду выполнения виртуальной машины.
VirtualMachineRunCommandInstanceView	Представление экземпляра команды выполнения виртуальной машины.
VirtualMachineRunCommandScriptSource	Описывает источники скриптов для команды выполнения. Используйте только один из скриптов, scriptUri, commandId.
VirtualMachineRunCommandUpdate	Описывает команду выполнения виртуальной машины.

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	Имя параметра команды запуска.
value	string	Значение параметра команды выполнения.

RunCommandManagedIdentity

Содержит clientId или objectId (используйте только один, а не оба) управляемого удостоверения, назначаемого пользователем, который имеет доступ к большому двоичному объекту хранилища, используемому в команде run. Используйте пустой объект RunCommandManagedIdentity в случае назначаемого системой удостоверения. Убедитесь, что blob-объект хранилища Azure существует в случае scriptUri и управляемому удостоверению предоставлен доступ к контейнеру BLOB-объектов с назначением роли "Читатель данных BLOB-объектов хранилища" с большим двоичным объектом scriptUri и "Участник данных BLOB-объектов хранилища" для добавочных BLOB-объектов(outputBlobUri, errorBlobUri). В случае назначаемого пользователем удостоверения убедитесь, что вы добавили его в удостоверение виртуальной машины. Дополнительные сведения об управляемом удостоверении и выполнении команды см. в разделе https://aka.ms/ManagedIdentity и https://aka.ms/RunCommandManaged.

Имя	Тип	Описание
clientId	string	Идентификатор клиента (значение GUID) управляемого удостоверения, назначаемого пользователем. ObjectId не следует использовать, если он указан.
objectId	string	Идентификатор объекта (значение GUID) управляемого удостоверения, назначаемого пользователем. ClientId не следует использовать, если он указан.

StatusLevelTypes

Код уровня.

Имя	Тип	Описание
Error	string
Info	string
Warning	string