Virtual Machine Run Commands - Update

Služba:

Compute

Verze rozhraní API:

2024-07-01

Operace pro aktualizaci příkazu run.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků.
runCommandName	path	True	string	Název příkazu spuštění virtuálního počítače.
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného tvoří součást identifikátoru URI pro každé volání služby.
vmName	path	True	string	Název virtuálního počítače, na kterém se má příkaz spustit aktualizovat.
api-version	query	True	string	Verze rozhraní API klienta.

Text požadavku

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

Name	Typ	Description
properties.asyncExecution	boolean	Volitelný. Pokud je hodnota true, zřizování se dokončí, jakmile se skript spustí a nečeká na dokončení skriptu.
properties.errorBlobManagedIdentity	RunCommandManagedIdentity	Spravovaná identita přiřazená uživatelem, která má přístup k objektu blob úložiště errorBlobUri. V případě identity přiřazené systémem použijte prázdný objekt. Ujistěte se, že spravovaná identita získala přístup k kontejneru objektu blob s přiřazením role Přispěvatel dat objektů blob služby Storage. V případě identity přiřazené uživatelem se ujistěte, že ji přidáte do identity virtuálního počítače. Další informace o spravované identitě a příkazu Spustit najdete v tématu https://aka.ms/ManagedIdentity a https://aka.ms/RunCommandManaged
properties.errorBlobUri	string	Určuje objekt blob úložiště Azure, kde se nahraje chybový stream skriptu. K poskytnutí přístupu k objektu blob použijte identifikátor URI SAS se čtením, připojením, vytvořením, přístupem k zápisu nebo spravovanou identitou. Projděte si parametr errorBlobManagedIdentity.
properties.outputBlobManagedIdentity	RunCommandManagedIdentity	Spravovaná identita přiřazená uživatelem, která má přístup k výstupnímu objektu blob úložištěBlobUri. V případě identity přiřazené systémem použijte prázdný objekt. Ujistěte se, že spravovaná identita získala přístup k kontejneru objektu blob s přiřazením role Přispěvatel dat objektů blob služby Storage. V případě identity přiřazené uživatelem se ujistěte, že ji přidáte do identity virtuálního počítače. Další informace o spravované identitě a příkazu Spustit najdete v tématu https://aka.ms/ManagedIdentity a https://aka.ms/RunCommandManaged
properties.outputBlobUri	string	Určuje objekt blob úložiště Azure, ve kterém se nahraje výstupní datový proud skriptu. K poskytnutí přístupu k objektu blob použijte identifikátor URI SAS se čtením, připojením, vytvořením, přístupem k zápisu nebo spravovanou identitou. Projděte si výstupní parametrBlobManagedIdentity.
properties.parameters	RunCommandInputParameter[]	Parametry používané skriptem.
properties.protectedParameters	RunCommandInputParameter[]	Parametry používané skriptem.
properties.runAsPassword	string	Určuje heslo uživatelského účtu na virtuálním počítači při spuštění příkazu run.
properties.runAsUser	string	Určuje uživatelský účet na virtuálním počítači při spuštění příkazu spustit.
properties.source	VirtualMachineRunCommandScriptSource	Zdroj skriptu příkazu run.
properties.timeoutInSeconds	integer	Časový limit v sekundách pro spuštění příkazu.
properties.treatFailureAsDeploymentFailure	boolean	Volitelný. Pokud je nastavená hodnota true, selhání ve skriptu selže nasazení a ProvisioningState se označí jako Neúspěšné. Pokud nastavíte hodnotu false, ProvisioningState bude odrážet pouze to, jestli byl příkaz spuštění spuštěný nebo ne platformou rozšíření, nezoznačuje, jestli skript selhal v případě selhání skriptu. Zobrazení spuštění příkazu instance v případě selhání skriptu zobrazit executionMessage, výstup, chyba: https://aka.ms/runcommandmanaged#get-execution-status-and-results
tags	object	Značky prostředků

Odpovědi

Name	Typ	Description
200 OK	VirtualMachineRunCommand	OK Media Types: "application/json", "text/json"
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala. Media Types: "application/json", "text/json"

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Update a run command.

Ukázkový požadavek

HTTP

PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/runCommands/myRunCommand?api-version=2024-07-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"
    }
  }
}

Java

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

Python

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

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/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-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

JavaScript

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

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-07-01/examples/runCommandExamples/VirtualMachineRunCommand_Update.json
// this example is just showing the usage of "VirtualMachineRunCommands_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 VirtualMachineRunCommandResource created on azure
// for more information of creating VirtualMachineRunCommandResource, please refer to the document of VirtualMachineRunCommandResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string vmName = "myVM";
string runCommandName = "myRunCommand";
ResourceIdentifier virtualMachineRunCommandResourceId = VirtualMachineRunCommandResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, vmName, runCommandName);
VirtualMachineRunCommandResource virtualMachineRunCommand = client.GetVirtualMachineRunCommandResource(virtualMachineRunCommandResourceId);

// invoke the operation
VirtualMachineRunCommandUpdate runCommand = new VirtualMachineRunCommandUpdate
{
    Source = new VirtualMachineRunCommandScriptSource
    {
        Script = "Write-Host Hello World! ; Remove-Item C:\test\testFile.txt",
    },
    Parameters = { new RunCommandInputParameter("param1", "value1"), new RunCommandInputParameter("param2", "value2") },
    AsyncExecution = false,
    RunAsUser = "user1",
    RunAsPassword = "<runAsPassword>",
    TimeoutInSeconds = 3600,
    OutputBlobUri = new Uri("https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/outputUri"),
    ErrorBlobUri = new Uri("https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt"),
    ErrorBlobManagedIdentity = new RunCommandManagedIdentity
    {
        ObjectId = "4231e4d2-33e4-4e23-96b2-17888afa6072",
    },
};
ArmOperation<VirtualMachineRunCommandResource> lro = await virtualMachineRunCommand.UpdateAsync(WaitUntil.Completed, runCommand);
VirtualMachineRunCommandResource 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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
ApiError	Chyba rozhraní API
ApiErrorBase	Základ chyb rozhraní API.
CloudError	Odpověď na chybu z výpočetní služby
ExecutionState	Stav spuštění skriptu.
InnerError	Podrobnosti vnitřní chyby.
InstanceViewStatus	Stav zobrazení instance
RunCommandInputParameter	Popisuje vlastnosti parametru příkazu run.
RunCommandManagedIdentity	Obsahuje clientId nebo objectId (použijte pouze jednu, ne obě) spravované identity přiřazené uživatelem, která má přístup k objektu blob úložiště používanému v příkazu Spustit. V případě identity přiřazené systémem použijte prázdný objekt RunCommandManagedIdentity. Ujistěte se, že objekt blob úložiště Azure existuje v případě scriptUri a spravovaná identita má udělený přístup ke kontejneru objektů blob s přiřazením role Čtenář dat objektů blob služby Storage s objekty blob scriptUri a Přispěvatelem dat objektů blob úložiště pro doplňovací objekty blob (outputBlobUri, errorBlobUri). V případě identity přiřazené uživatelem se ujistěte, že ji přidáte pod identitu virtuálního počítače. Další informace o spravované identitě a příkazu Spustit najdete v tématu https://aka.ms/ManagedIdentity a https://aka.ms/RunCommandManaged.
StatusLevelTypes	Kód úrovně.
VirtualMachineRunCommand	Popisuje příkaz spuštění virtuálního počítače.
VirtualMachineRunCommandInstanceView	Zobrazení instance příkazu spuštění virtuálního počítače.
VirtualMachineRunCommandScriptSource	Popisuje zdroje skriptů pro příkaz spustit. Použijte pouze jeden skript, scriptUri, commandId.
VirtualMachineRunCommandUpdate	Popisuje příkaz spuštění virtuálního počítače.

ApiError

Chyba rozhraní API

Name	Typ	Description
code	string	Kód chyby.
details	ApiErrorBase[]	Podrobnosti o chybě rozhraní API
innererror	InnerError	Vnitřní chyba rozhraní API
message	string	Chybová zpráva.
target	string	Cíl konkrétní chyby.

ApiErrorBase

Základ chyb rozhraní API.

Name	Typ	Description
code	string	Kód chyby.
message	string	Chybová zpráva.
target	string	Cíl konkrétní chyby.

CloudError

Odpověď na chybu z výpočetní služby

Name	Typ	Description
error	ApiError	Chyba rozhraní API

ExecutionState

Stav spuštění skriptu.

Name	Typ	Description
Canceled	string
Failed	string
Pending	string
Running	string
Succeeded	string
TimedOut	string
Unknown	string

InnerError

Podrobnosti vnitřní chyby.

Name	Typ	Description
errordetail	string	Vnitřní chybová zpráva nebo výpis výjimky.
exceptiontype	string	Typ výjimky.

InstanceViewStatus

Stav zobrazení instance

Name	Typ	Description
code	string	Stavový kód.
displayStatus	string	Krátký lokalizovatelný popisek stavu.
level	StatusLevelTypes	Kód úrovně.
message	string	Podrobná stavová zpráva, včetně výstrah a chybových zpráv.
time	string	Čas stavu.

RunCommandInputParameter

Popisuje vlastnosti parametru příkazu run.

Name	Typ	Description
name	string	Název parametru příkazu run.
value	string	Hodnota parametru příkazu run.

RunCommandManagedIdentity

Obsahuje clientId nebo objectId (použijte pouze jednu, ne obě) spravované identity přiřazené uživatelem, která má přístup k objektu blob úložiště používanému v příkazu Spustit. V případě identity přiřazené systémem použijte prázdný objekt RunCommandManagedIdentity. Ujistěte se, že objekt blob úložiště Azure existuje v případě scriptUri a spravovaná identita má udělený přístup ke kontejneru objektů blob s přiřazením role Čtenář dat objektů blob služby Storage s objekty blob scriptUri a Přispěvatelem dat objektů blob úložiště pro doplňovací objekty blob (outputBlobUri, errorBlobUri). V případě identity přiřazené uživatelem se ujistěte, že ji přidáte pod identitu virtuálního počítače. Další informace o spravované identitě a příkazu Spustit najdete v tématu https://aka.ms/ManagedIdentity a https://aka.ms/RunCommandManaged.

Name	Typ	Description
clientId	string	ID klienta (hodnota GUID) spravované identity přiřazené uživatelem Id objektu by se nemělo používat, pokud je k dispozici.
objectId	string	ID objektu (hodnota GUID) spravované identity přiřazené uživatelem Id klienta by se nemělo používat, pokud je k dispozici.

StatusLevelTypes

Kód úrovně.

Name	Typ	Description
Error	string
Info	string
Warning	string

VirtualMachineRunCommand

Popisuje příkaz spuštění virtuálního počítače.

Name	Typ	Default value	Description
id	string		ID prostředku
location	string		Umístění prostředku
name	string		Název prostředku
properties.asyncExecution	boolean	False	Volitelný. Pokud je hodnota true, zřizování se dokončí, jakmile se skript spustí a nečeká na dokončení skriptu.
properties.errorBlobManagedIdentity	RunCommandManagedIdentity		Spravovaná identita přiřazená uživatelem, která má přístup k objektu blob úložiště errorBlobUri. V případě identity přiřazené systémem použijte prázdný objekt. Ujistěte se, že spravovaná identita získala přístup k kontejneru objektu blob s přiřazením role Přispěvatel dat objektů blob služby Storage. V případě identity přiřazené uživatelem se ujistěte, že ji přidáte do identity virtuálního počítače. Další informace o spravované identitě a příkazu Spustit najdete v tématu https://aka.ms/ManagedIdentity a https://aka.ms/RunCommandManaged
properties.errorBlobUri	string		Určuje objekt blob úložiště Azure, kde se nahraje chybový stream skriptu. K poskytnutí přístupu k objektu blob použijte identifikátor URI SAS se čtením, připojením, vytvořením, přístupem k zápisu nebo spravovanou identitou. Projděte si parametr errorBlobManagedIdentity.
properties.instanceView	VirtualMachineRunCommandInstanceView		Virtuální počítač spustí zobrazení instance příkazu.
properties.outputBlobManagedIdentity	RunCommandManagedIdentity		Spravovaná identita přiřazená uživatelem, která má přístup k výstupnímu objektu blob úložištěBlobUri. V případě identity přiřazené systémem použijte prázdný objekt. Ujistěte se, že spravovaná identita získala přístup k kontejneru objektu blob s přiřazením role Přispěvatel dat objektů blob služby Storage. V případě identity přiřazené uživatelem se ujistěte, že ji přidáte do identity virtuálního počítače. Další informace o spravované identitě a příkazu Spustit najdete v tématu https://aka.ms/ManagedIdentity a https://aka.ms/RunCommandManaged
properties.outputBlobUri	string		Určuje objekt blob úložiště Azure, ve kterém se nahraje výstupní datový proud skriptu. K poskytnutí přístupu k objektu blob použijte identifikátor URI SAS se čtením, připojením, vytvořením, přístupem k zápisu nebo spravovanou identitou. Projděte si výstupní parametrBlobManagedIdentity.
properties.parameters	RunCommandInputParameter[]		Parametry používané skriptem.
properties.protectedParameters	RunCommandInputParameter[]		Parametry používané skriptem.
properties.provisioningState	string		Stav zřizování, který se zobrazí pouze v odpovědi. Pokud je léčbaFailureAsDeploymentFailure nastavená na hodnotu true, selhání skriptu selže při nasazení a provisioningState se označí jako Neúspěšné. Pokud je zacházíFailureAsDeploymentFailure nastavená na false, provisioningState by odrážel pouze to, jestli byl příkaz spuštění spuštěn nebo ne platformou rozšíření, neznačí, jestli skript selhal v případě selhání skriptu. Zobrazení spuštění příkazu instance v případě selhání skriptu zobrazit executionMessage, výstup, chyba: https://aka.ms/runcommandmanaged#get-execution-status-and-results
properties.runAsPassword	string		Určuje heslo uživatelského účtu na virtuálním počítači při spuštění příkazu run.
properties.runAsUser	string		Určuje uživatelský účet na virtuálním počítači při spuštění příkazu spustit.
properties.source	VirtualMachineRunCommandScriptSource		Zdroj skriptu příkazu run.
properties.timeoutInSeconds	integer		Časový limit v sekundách pro spuštění příkazu.
properties.treatFailureAsDeploymentFailure	boolean	False	Volitelný. Pokud je nastavená hodnota true, selhání ve skriptu selže nasazení a ProvisioningState se označí jako Neúspěšné. Pokud nastavíte hodnotu false, ProvisioningState bude odrážet pouze to, jestli byl příkaz spuštění spuštěný nebo ne platformou rozšíření, nezoznačuje, jestli skript selhal v případě selhání skriptu. Zobrazení spuštění příkazu instance v případě selhání skriptu zobrazit executionMessage, výstup, chyba: https://aka.ms/runcommandmanaged#get-execution-status-and-results
tags	object		Značky prostředků
type	string		Typ prostředku

VirtualMachineRunCommandInstanceView

Zobrazení instance příkazu spuštění virtuálního počítače.

Name	Typ	Description
endTime	string	Čas ukončení skriptu.
error	string	Stream chyb skriptu
executionMessage	string	Komunikujte s chybami konfigurace skriptu nebo zprávami o spuštění.
executionState	ExecutionState	Stav spuštění skriptu.
exitCode	integer	Ukončete kód vrácený ze spuštění skriptu.
output	string	Výstupní datový proud skriptu
startTime	string	Čas spuštění skriptu.
statuses	InstanceViewStatus[]	Informace o stavu zdroje

VirtualMachineRunCommandScriptSource

Popisuje zdroje skriptů pro příkaz spustit. Použijte pouze jeden skript, scriptUri, commandId.

Name	Typ	Description
commandId	string	Určuje commandId předdefinovaného předdefinovaného skriptu.
script	string	Určuje obsah skriptu, který se má na virtuálním počítači spustit.
scriptUri	string	Určuje umístění stahování skriptu. Může to být identifikátor URI SAS objektu blob úložiště Azure s přístupem pro čtení nebo veřejným identifikátorem URI.
scriptUriManagedIdentity	RunCommandManagedIdentity	Spravovaná identita přiřazená uživatelem, která má přístup k identifikátoru scriptUri v případě objektu blob úložiště Azure. V případě identity přiřazené systémem použijte prázdný objekt. Ujistěte se, že objekt blob úložiště Azure existuje, a spravovaná identita má udělený přístup k kontejneru objektu blob s přiřazením role Čtenář dat objektů blob služby Storage. V případě identity přiřazené uživatelem se ujistěte, že ji přidáte do identity virtuálního počítače. Další informace o spravované identitě a příkazu Spustit najdete v tématu https://aka.ms/ManagedIdentity a https://aka.ms/RunCommandManaged.

VirtualMachineRunCommandUpdate

Popisuje příkaz spuštění virtuálního počítače.

Name	Typ	Default value	Description
properties.asyncExecution	boolean	False	Volitelný. Pokud je hodnota true, zřizování se dokončí, jakmile se skript spustí a nečeká na dokončení skriptu.
properties.errorBlobManagedIdentity	RunCommandManagedIdentity		Spravovaná identita přiřazená uživatelem, která má přístup k objektu blob úložiště errorBlobUri. V případě identity přiřazené systémem použijte prázdný objekt. Ujistěte se, že spravovaná identita získala přístup k kontejneru objektu blob s přiřazením role Přispěvatel dat objektů blob služby Storage. V případě identity přiřazené uživatelem se ujistěte, že ji přidáte do identity virtuálního počítače. Další informace o spravované identitě a příkazu Spustit najdete v tématu https://aka.ms/ManagedIdentity a https://aka.ms/RunCommandManaged
properties.errorBlobUri	string		Určuje objekt blob úložiště Azure, kde se nahraje chybový stream skriptu. K poskytnutí přístupu k objektu blob použijte identifikátor URI SAS se čtením, připojením, vytvořením, přístupem k zápisu nebo spravovanou identitou. Projděte si parametr errorBlobManagedIdentity.
properties.instanceView	VirtualMachineRunCommandInstanceView		Virtuální počítač spustí zobrazení instance příkazu.
properties.outputBlobManagedIdentity	RunCommandManagedIdentity		Spravovaná identita přiřazená uživatelem, která má přístup k výstupnímu objektu blob úložištěBlobUri. V případě identity přiřazené systémem použijte prázdný objekt. Ujistěte se, že spravovaná identita získala přístup k kontejneru objektu blob s přiřazením role Přispěvatel dat objektů blob služby Storage. V případě identity přiřazené uživatelem se ujistěte, že ji přidáte do identity virtuálního počítače. Další informace o spravované identitě a příkazu Spustit najdete v tématu https://aka.ms/ManagedIdentity a https://aka.ms/RunCommandManaged
properties.outputBlobUri	string		Určuje objekt blob úložiště Azure, ve kterém se nahraje výstupní datový proud skriptu. K poskytnutí přístupu k objektu blob použijte identifikátor URI SAS se čtením, připojením, vytvořením, přístupem k zápisu nebo spravovanou identitou. Projděte si výstupní parametrBlobManagedIdentity.
properties.parameters	RunCommandInputParameter[]		Parametry používané skriptem.
properties.protectedParameters	RunCommandInputParameter[]		Parametry používané skriptem.
properties.provisioningState	string		Stav zřizování, který se zobrazí pouze v odpovědi. Pokud je léčbaFailureAsDeploymentFailure nastavená na hodnotu true, selhání skriptu selže při nasazení a provisioningState se označí jako Neúspěšné. Pokud je zacházíFailureAsDeploymentFailure nastavená na false, provisioningState by odrážel pouze to, jestli byl příkaz spuštění spuštěn nebo ne platformou rozšíření, neznačí, jestli skript selhal v případě selhání skriptu. Zobrazení spuštění příkazu instance v případě selhání skriptu zobrazit executionMessage, výstup, chyba: https://aka.ms/runcommandmanaged#get-execution-status-and-results
properties.runAsPassword	string		Určuje heslo uživatelského účtu na virtuálním počítači při spuštění příkazu run.
properties.runAsUser	string		Určuje uživatelský účet na virtuálním počítači při spuštění příkazu spustit.
properties.source	VirtualMachineRunCommandScriptSource		Zdroj skriptu příkazu run.
properties.timeoutInSeconds	integer		Časový limit v sekundách pro spuštění příkazu.
properties.treatFailureAsDeploymentFailure	boolean	False	Volitelný. Pokud je nastavená hodnota true, selhání ve skriptu selže nasazení a ProvisioningState se označí jako Neúspěšné. Pokud nastavíte hodnotu false, ProvisioningState bude odrážet pouze to, jestli byl příkaz spuštění spuštěný nebo ne platformou rozšíření, nezoznačuje, jestli skript selhal v případě selhání skriptu. Zobrazení spuštění příkazu instance v případě selhání skriptu zobrazit executionMessage, výstup, chyba: https://aka.ms/runcommandmanaged#get-execution-status-and-results
tags	object		Značky prostředků