Virtual Machine Scale Set VM Run Commands - Update

Служба:

Compute

Версия API:

2024-03-01

Операция обновления виртуальной машины VMSS выполнить команду .

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
instanceId	path	True	string	Идентификатор экземпляра виртуальной машины.
resourceGroupName	path	True	string	Имя группы ресурсов.
runCommandName	path	True	string	Имя команды выполнения виртуальной машины.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.
vmScaleSetName	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"

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

azure_auth

Поток OAuth2 в Azure Active Directory

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

Области

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

Примеры

Update VirtualMachineScaleSet VM run command.

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

HTTP

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

{
  "properties": {
    "source": {
      "scriptUri": "https://mystorageaccount.blob.core.windows.net/scriptcontainer/MyScript.ps1",
      "scriptUriManagedIdentity": {
        "objectId": "4231e4d2-33e4-4e23-96b2-17888afa6072"
      }
    }
  }
}

Java

import com.azure.resourcemanager.compute.models.RunCommandManagedIdentity;
import com.azure.resourcemanager.compute.models.VirtualMachineRunCommandScriptSource;
import com.azure.resourcemanager.compute.models.VirtualMachineRunCommandUpdate;

/**
 * Samples for VirtualMachineScaleSetVMRunCommands Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/runCommandExamples/
     * VirtualMachineScaleSetVMRunCommand_Update.json
     */
    /**
     * Sample code: Update VirtualMachineScaleSet VM run command.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateVirtualMachineScaleSetVMRunCommand(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineScaleSetVMRunCommands().update(
            "myResourceGroup", "myvmScaleSet", "0", "myRunCommand",
            new VirtualMachineRunCommandUpdate().withSource(new VirtualMachineRunCommandScriptSource()
                .withScriptUri("https://mystorageaccount.blob.core.windows.net/scriptcontainer/MyScript.ps1")
                .withScriptUriManagedIdentity(
                    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

Python

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_scale_set_vm_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_scale_set_vm_run_commands.begin_update(
        resource_group_name="myResourceGroup",
        vm_scale_set_name="myvmScaleSet",
        instance_id="0",
        run_command_name="myRunCommand",
        run_command={
            "properties": {
                "source": {
                    "scriptUri": "https://mystorageaccount.blob.core.windows.net/scriptcontainer/MyScript.ps1",
                    "scriptUriManagedIdentity": {"objectId": "4231e4d2-33e4-4e23-96b2-17888afa6072"},
                }
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_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

Go

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/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_Update.json
func ExampleVirtualMachineScaleSetVMRunCommandsClient_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.NewVirtualMachineScaleSetVMRunCommandsClient().BeginUpdate(ctx, "myResourceGroup", "myvmScaleSet", "0", "myRunCommand", armcompute.VirtualMachineRunCommandUpdate{
		Properties: &armcompute.VirtualMachineRunCommandProperties{
			Source: &armcompute.VirtualMachineRunCommandScriptSource{
				ScriptURI: to.Ptr("https://mystorageaccount.blob.core.windows.net/scriptcontainer/MyScript.ps1"),
				ScriptURIManagedIdentity: &armcompute.RunCommandManagedIdentity{
					ObjectID: to.Ptr("4231e4d2-33e4-4e23-96b2-17888afa6072"),
				},
			},
		},
	}, 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/virtualMachineScaleSets/virtualMachines/runCommands"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/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{
	// 			ScriptURI: to.Ptr("https://mystorageaccount.blob.core.windows.net/scriptcontainer/MyScript.ps1"),
	// 		},
	// 		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 update the VMSS VM run command.
 *
 * @summary The operation to update the VMSS VM run command.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_Update.json
 */
async function updateVirtualMachineScaleSetVMRunCommand() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmScaleSetName = "myvmScaleSet";
  const instanceId = "0";
  const runCommandName = "myRunCommand";
  const runCommand = {
    source: {
      scriptUri: "https://mystorageaccount.blob.core.windows.net/scriptcontainer/MyScript.ps1",
      scriptUriManagedIdentity: {
        objectId: "4231e4d2-33e4-4e23-96b2-17888afa6072",
      },
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineScaleSetVMRunCommands.beginUpdateAndWait(
    resourceGroupName,
    vmScaleSetName,
    instanceId,
    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

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-03-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_Update.json
// this example is just showing the usage of "VirtualMachineScaleSetVMRunCommands_Update" 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 VirtualMachineScaleSetVmRunCommandResource created on azure
// for more information of creating VirtualMachineScaleSetVmRunCommandResource, please refer to the document of VirtualMachineScaleSetVmRunCommandResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string virtualMachineScaleSetName = "myvmScaleSet";
string instanceId = "0";
string runCommandName = "myRunCommand";
ResourceIdentifier virtualMachineScaleSetVmRunCommandResourceId = VirtualMachineScaleSetVmRunCommandResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualMachineScaleSetName, instanceId, runCommandName);
VirtualMachineScaleSetVmRunCommandResource virtualMachineScaleSetVmRunCommand = client.GetVirtualMachineScaleSetVmRunCommandResource(virtualMachineScaleSetVmRunCommandResourceId);

// invoke the operation
VirtualMachineRunCommandUpdate runCommand = new VirtualMachineRunCommandUpdate()
{
    Source = new VirtualMachineRunCommandScriptSource()
    {
        ScriptUri = new Uri("https://mystorageaccount.blob.core.windows.net/scriptcontainer/MyScript.ps1"),
        ScriptUriManagedIdentity = new RunCommandManagedIdentity()
        {
            ObjectId = "4231e4d2-33e4-4e23-96b2-17888afa6072",
        },
    },
};
ArmOperation<VirtualMachineScaleSetVmRunCommandResource> lro = await virtualMachineScaleSetVmRunCommand.UpdateAsync(WaitUntil.Completed, runCommand);
VirtualMachineScaleSetVmRunCommandResource result = lro.Value;

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

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

Код состояния:

200

{
  "name": "myRunCommand",
  "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/runCommands/myRunCommand",
  "location": "westus",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "source": {
      "scriptUri": "https://mystorageaccount.blob.core.windows.net/scriptcontainer/MyScript.ps1"
    },
    "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

VirtualMachineRunCommand

Описывает команду выполнения виртуальной машины.

Имя	Тип	Default value	Описание
id	string		Идентификатор ресурса
location	string		Расположение ресурса
name	string		Имя ресурса
properties.asyncExecution	boolean	False	Необязательный элемент. Если задано значение true, подготовка завершится сразу после запуска скрипта и не будет ожидать завершения скрипта.
properties.errorBlobManagedIdentity	RunCommandManagedIdentity		Управляемое удостоверение, назначаемое пользователем, которое имеет доступ к blob-объекту хранилища errorBlobUri. Используйте пустой объект в случае назначаемого системой удостоверения. Убедитесь, что управляемому удостоверению предоставлен доступ к контейнеру BLOB-объектов с назначением роли "Участник данных BLOB-объектов хранилища". В случае назначаемого пользователем удостоверения убедитесь, что вы добавили его в удостоверение виртуальной машины. Дополнительные сведения об управляемом удостоверении и выполнении команды см. в https://aka.ms/ManagedIdentity и https://aka.ms/RunCommandManaged
properties.errorBlobUri	string		Указывает большой двоичный объект хранилища Azure, куда будет отправляться поток ошибок скрипта. Используйте URI SAS с доступом на чтение, добавление, создание, запись или используйте управляемое удостоверение, чтобы предоставить виртуальной машине доступ к большому двоичному объекту. См. параметр errorBlobManagedIdentity.
properties.instanceView	VirtualMachineRunCommandInstanceView		Представление экземпляра команды запуска виртуальной машины.
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.provisioningState	string		Состояние подготовки, которое отображается только в ответе. Если параметру treatFailureAsDeploymentFailure присвоено значение true, любой сбой в сценарии приведет к сбою развертывания, а ProvisioningState будет помечен как Failed. Если параметру treatFailureAsDeploymentFailure присвоено значение false, ProvisioningState будет отражать только то, была ли запущена команда выполнения платформой расширений, она не будет указывать, произошел ли сбой скрипта в случае сбоя скрипта. Просмотрите представление экземпляра команды run в случае сбоя скрипта, чтобы увидеть executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results
properties.runAsPassword	string		Указывает пароль учетной записи пользователя на виртуальной машине при выполнении команды выполнения.
properties.runAsUser	string		Указывает учетную запись пользователя на виртуальной машине при выполнении команды выполнения.
properties.source	VirtualMachineRunCommandScriptSource		Источник скрипта выполнения команд.
properties.timeoutInSeconds	integer		Время ожидания в секундах для выполнения команды выполнения.
properties.treatFailureAsDeploymentFailure	boolean	False	Необязательный элемент. Если задано значение true, любой сбой в скрипте приведет к сбою развертывания, а ProvisioningState будет помечен как Сбой. Если задано значение false, ProvisioningState будет отражать только выполнение команды выполнения платформой расширений, и не будет указывать, произошел ли сбой скрипта в случае сбоя скрипта. Просмотрите представление экземпляра команды run в случае сбоя скрипта, чтобы увидеть executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results
tags	object		Теги ресурсов
type	string		Тип ресурса

VirtualMachineRunCommandInstanceView

Представление экземпляра команды выполнения виртуальной машины.

Имя	Тип	Описание
endTime	string	Время окончания скрипта.
error	string	Поток ошибок скрипта.
executionMessage	string	Сообщите об ошибках конфигурации скрипта или сообщениях о выполнении.
executionState	ExecutionState	Состояние выполнения скрипта.
exitCode	integer	Код выхода, возвращенный при выполнении скрипта.
output	string	Выходной поток скрипта.
startTime	string	Время запуска скрипта.
statuses	InstanceViewStatus[]	Сведения о состоянии ресурса.

VirtualMachineRunCommandScriptSource

Описывает источники скриптов для команды выполнения. Используйте только один из скриптов, scriptUri, commandId.

Имя	Тип	Описание
commandId	string	Задает commandId предопределенного встроенного скрипта.
script	string	Указывает содержимое скрипта, выполняемого на виртуальной машине.
scriptUri	string	Указывает расположение для скачивания скрипта. Это может быть URI SAS большого двоичного объекта хранилища Azure с доступом на чтение или общедоступный URI.
scriptUriManagedIdentity	RunCommandManagedIdentity	Управляемое удостоверение, назначаемое пользователем, которое имеет доступ к scriptUri в случае большого двоичного объекта хранилища Azure. Используйте пустой объект в случае назначаемого системой удостоверения. Убедитесь, что blob-объект службы хранилища Azure существует и управляемому удостоверению предоставлен доступ к контейнеру BLOB-объектов с назначением роли "Читатель данных BLOB-объектов хранилища". В случае назначаемого пользователем удостоверения убедитесь, что вы добавили его в удостоверение виртуальной машины. Дополнительные сведения об управляемом удостоверении и выполнении команды см. в разделе https://aka.ms/ManagedIdentity и https://aka.ms/RunCommandManaged.

VirtualMachineRunCommandUpdate

Описывает команду выполнения виртуальной машины.

Имя	Тип	Default value	Описание
properties.asyncExecution	boolean	False	Необязательный элемент. Если задано значение true, подготовка завершится сразу после запуска скрипта и не будет ожидать завершения скрипта.
properties.errorBlobManagedIdentity	RunCommandManagedIdentity		Управляемое удостоверение, назначаемое пользователем, которое имеет доступ к blob-объекту хранилища errorBlobUri. Используйте пустой объект в случае назначаемого системой удостоверения. Убедитесь, что управляемому удостоверению предоставлен доступ к контейнеру BLOB-объектов с назначением роли "Участник данных BLOB-объектов хранилища". В случае назначаемого пользователем удостоверения убедитесь, что вы добавили его в удостоверение виртуальной машины. Дополнительные сведения об управляемом удостоверении и выполнении команды см. в https://aka.ms/ManagedIdentity и https://aka.ms/RunCommandManaged
properties.errorBlobUri	string		Указывает большой двоичный объект хранилища Azure, куда будет отправляться поток ошибок скрипта. Используйте URI SAS с доступом на чтение, добавление, создание, запись или используйте управляемое удостоверение, чтобы предоставить виртуальной машине доступ к большому двоичному объекту. См. параметр errorBlobManagedIdentity.
properties.instanceView	VirtualMachineRunCommandInstanceView		Представление экземпляра команды запуска виртуальной машины.
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.provisioningState	string		Состояние подготовки, которое отображается только в ответе. Если параметру treatFailureAsDeploymentFailure присвоено значение true, любой сбой в сценарии приведет к сбою развертывания, а ProvisioningState будет помечен как Failed. Если параметру treatFailureAsDeploymentFailure присвоено значение false, ProvisioningState будет отражать только то, была ли запущена команда выполнения платформой расширений, она не будет указывать, произошел ли сбой скрипта в случае сбоя скрипта. Просмотрите представление экземпляра команды run в случае сбоя скрипта, чтобы увидеть executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results
properties.runAsPassword	string		Указывает пароль учетной записи пользователя на виртуальной машине при выполнении команды выполнения.
properties.runAsUser	string		Указывает учетную запись пользователя на виртуальной машине при выполнении команды выполнения.
properties.source	VirtualMachineRunCommandScriptSource		Источник скрипта выполнения команд.
properties.timeoutInSeconds	integer		Время ожидания в секундах для выполнения команды выполнения.
properties.treatFailureAsDeploymentFailure	boolean	False	Необязательный элемент. Если задано значение true, любой сбой в скрипте приведет к сбою развертывания, а ProvisioningState будет помечен как Сбой. Если задано значение false, ProvisioningState будет отражать только выполнение команды выполнения платформой расширений, и не будет указывать, произошел ли сбой скрипта в случае сбоя скрипта. Просмотрите представление экземпляра команды run в случае сбоя скрипта, чтобы увидеть executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results
tags	object		Теги ресурсов