Virtual Machine Run Commands - Create Or Update

Service:

Compute

API Version:

2024-03-01

A futtatási parancs létrehozásához vagy frissítéséhez szükséges művelet.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string	Az erőforráscsoport neve.
runCommandName	path	True	string	A virtuális gép futtatási parancsának neve.
subscriptionId	path	True	string	Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés-azonosító az URI részét képezi minden szolgáltatáshíváshoz.
vmName	path	True	string	Annak a virtuális gépnek a neve, ahol a futtatási parancsot létre kell hozni vagy frissíteni kell.
api-version	query	True	string	Client API-verzió.

Kérelem törzse

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

Name	Kötelező	Típus	Description
location	True	string	Erőforrás helye
properties.asyncExecution		boolean	Választható. Ha true (igaz) értékre van állítva, a kiépítés a szkript elindításakor azonnal befejeződik, és nem várja meg, amíg a szkript befejeződik.
properties.errorBlobManagedIdentity		RunCommandManagedIdentity	Felhasználó által hozzárendelt felügyelt identitás, amely hozzáfér az errorBlobUri storage blobhoz. Használjon üres objektumot rendszer által hozzárendelt identitás esetén. Győződjön meg arról, hogy a felügyelt identitás hozzáférést kapott a blob tárolóhoz a "Storage-blobadatok közreműködője" szerepkör-hozzárendeléssel. Felhasználó által hozzárendelt identitás esetén győződjön meg arról, hogy hozzáadja azt a virtuális gép identitásához. A felügyelt identitással és a parancs futtatásával kapcsolatos további információkért lásd: https://aka.ms/ManagedIdentity és https://aka.ms/RunCommandManaged
properties.errorBlobUri		string	Megadja azt az Azure Storage-blobot, ahová a szkripthibák streamje fel lesz töltve. SAS URI-t használjon olvasási, hozzáfűzési, létrehozási, írási hozzáféréssel, vagy használjon felügyelt identitást a virtuális gép blobhoz való hozzáférésének biztosításához. Lásd: errorBlobManagedIdentity paraméter.
properties.outputBlobManagedIdentity		RunCommandManagedIdentity	Felhasználó által hozzárendelt felügyelt identitás, amely hozzáfér az outputBlobUri storage blobhoz. Használjon üres objektumot rendszer által hozzárendelt identitás esetén. Győződjön meg arról, hogy a felügyelt identitás hozzáférést kapott a blob tárolóhoz a "Storage-blobadatok közreműködője" szerepkör-hozzárendeléssel. Felhasználó által hozzárendelt identitás esetén győződjön meg arról, hogy hozzáadja azt a virtuális gép identitásához. A felügyelt identitással és a parancs futtatásával kapcsolatos további információkért lásd: https://aka.ms/ManagedIdentity és https://aka.ms/RunCommandManaged
properties.outputBlobUri		string	Megadja azt az Azure Storage-blobot, ahová a szkript kimeneti streamje fel lesz töltve. SAS URI-t használjon olvasási, hozzáfűzési, létrehozási, írási hozzáféréssel, vagy használjon felügyelt identitást a virtuális gép blobhoz való hozzáférésének biztosításához. Tekintse meg az outputBlobManagedIdentity paramétert.
properties.parameters		RunCommandInputParameter[]	A szkript által használt paraméterek.
properties.protectedParameters		RunCommandInputParameter[]	A szkript által használt paraméterek.
properties.runAsPassword		string	Megadja a felhasználói fiók jelszavát a virtuális gépen a futtatási parancs végrehajtásakor.
properties.runAsUser		string	Megadja a virtuális gép felhasználói fiókját a futtatási parancs végrehajtásakor.
properties.source		VirtualMachineRunCommandScriptSource	A futtatási parancsszkript forrása.
properties.timeoutInSeconds		integer	A futtatási parancs végrehajtásának időtúllépése másodpercben.
properties.treatFailureAsDeploymentFailure		boolean	Választható. Ha true (igaz) értékre van állítva, a szkript bármely hibája meghiúsul az üzembe helyezés során, a ProvisioningState pedig Sikertelenként lesz megjelölve. Ha false (hamis) értékre van állítva, a ProvisioningState csak azt tükrözi, hogy a futtatási parancsot a bővítményplatform futtatta-e, nem jelzi, hogy a szkript meghiúsult-e szkripthibák esetén. Az executionMessage, output, error megtekintéséhez tekintse meg a futtatási parancs példánynézetét szkripthibák esetén: https://aka.ms/runcommandmanaged#get-execution-status-and-results
tags		object	Erőforráscímkék

Válaszok

Name	Típus	Description
200 OK	VirtualMachineRunCommand	OK Media Types: "application/json", "text/json"
201 Created	VirtualMachineRunCommand	Létrehozva Media Types: "application/json", "text/json"
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg. Media Types: "application/json", "text/json"

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

Create or update a run command.

Sample Request

HTTP

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

{
  "location": "West US",
  "properties": {
    "source": {
      "scriptUri": "https://mystorageaccount.blob.core.windows.net/scriptcontainer/scriptURI"
    },
    "parameters": [
      {
        "name": "param1",
        "value": "value1"
      },
      {
        "name": "param2",
        "value": "value2"
      }
    ],
    "asyncExecution": false,
    "treatFailureAsDeploymentFailure": false,
    "runAsUser": "user1",
    "runAsPassword": "<runAsPassword>",
    "timeoutInSeconds": 3600,
    "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt",
    "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/scriptcontainer/scriptURI",
    "outputBlobManagedIdentity": {
      "clientId": "22d35efb-0c99-4041-8c5b-6d24db33a69a"
    }
  }
}

Java

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

/**
 * Samples for VirtualMachineRunCommands CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/runCommandExamples/
     * VirtualMachineRunCommand_CreateOrUpdate.json
     */
    /**
     * Sample code: Create or update a run command.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createOrUpdateARunCommand(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineRunCommands().createOrUpdate(
            "myResourceGroup", "myVM", "myRunCommand",
            new VirtualMachineRunCommandInner().withLocation("West US")
                .withSource(new VirtualMachineRunCommandScriptSource()
                    .withScriptUri("https://mystorageaccount.blob.core.windows.net/scriptcontainer/scriptURI"))
                .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/MyScriptoutput.txt")
                .withErrorBlobUri("https://mystorageaccount.blob.core.windows.net/scriptcontainer/scriptURI")
                .withOutputBlobManagedIdentity(
                    new RunCommandManagedIdentity().withClientId("22d35efb-0c99-4041-8c5b-6d24db33a69a"))
                .withTreatFailureAsDeploymentFailure(false),
            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_run_command_create_or_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_create_or_update(
        resource_group_name="myResourceGroup",
        vm_name="myVM",
        run_command_name="myRunCommand",
        run_command={
            "location": "West US",
            "properties": {
                "asyncExecution": False,
                "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/scriptcontainer/scriptURI",
                "outputBlobManagedIdentity": {"clientId": "22d35efb-0c99-4041-8c5b-6d24db33a69a"},
                "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt",
                "parameters": [{"name": "param1", "value": "value1"}, {"name": "param2", "value": "value2"}],
                "runAsPassword": "<runAsPassword>",
                "runAsUser": "user1",
                "source": {"scriptUri": "https://mystorageaccount.blob.core.windows.net/scriptcontainer/scriptURI"},
                "timeoutInSeconds": 3600,
                "treatFailureAsDeploymentFailure": False,
            },
        },
    ).result()
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/runCommandExamples/VirtualMachineRunCommand_CreateOrUpdate.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/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_CreateOrUpdate.json
func ExampleVirtualMachineRunCommandsClient_BeginCreateOrUpdate() {
	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().BeginCreateOrUpdate(ctx, "myResourceGroup", "myVM", "myRunCommand", armcompute.VirtualMachineRunCommand{
		Location: to.Ptr("West US"),
		Properties: &armcompute.VirtualMachineRunCommandProperties{
			AsyncExecution: to.Ptr(false),
			ErrorBlobURI:   to.Ptr("https://mystorageaccount.blob.core.windows.net/scriptcontainer/scriptURI"),
			OutputBlobManagedIdentity: &armcompute.RunCommandManagedIdentity{
				ClientID: to.Ptr("22d35efb-0c99-4041-8c5b-6d24db33a69a"),
			},
			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"),
				}},
			RunAsPassword: to.Ptr("<runAsPassword>"),
			RunAsUser:     to.Ptr("user1"),
			Source: &armcompute.VirtualMachineRunCommandScriptSource{
				ScriptURI: to.Ptr("https://mystorageaccount.blob.core.windows.net/scriptcontainer/scriptURI"),
			},
			TimeoutInSeconds:                to.Ptr[int32](3600),
			TreatFailureAsDeploymentFailure: to.Ptr(false),
		},
	}, 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{
	// 			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 create or update the run command.
 *
 * @summary The operation to create or update the run command.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/runCommandExamples/VirtualMachineRunCommand_CreateOrUpdate.json
 */
async function createOrUpdateARunCommand() {
  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,
    errorBlobUri: "https://mystorageaccount.blob.core.windows.net/scriptcontainer/scriptURI",
    location: "West US",
    outputBlobManagedIdentity: {
      clientId: "22d35efb-0c99-4041-8c5b-6d24db33a69a",
    },
    outputBlobUri:
      "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt",
    parameters: [
      { name: "param1", value: "value1" },
      { name: "param2", value: "value2" },
    ],
    runAsPassword: "<runAsPassword>",
    runAsUser: "user1",
    source: {
      scriptUri: "https://mystorageaccount.blob.core.windows.net/scriptcontainer/scriptURI",
    },
    timeoutInSeconds: 3600,
    treatFailureAsDeploymentFailure: false,
  };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineRunCommands.beginCreateOrUpdateAndWait(
    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

Sample Response

Status code:

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": {
      "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": "Succeeded",
    "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt",
    "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt"
  }
}

Status code:

201

{
  "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": {
      "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": "Creating",
    "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt",
    "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt"
  }
}

Definíciók

Name	Description
ApiError	API-hiba.
ApiErrorBase	API-hibabázis.
CloudError	Hibaválasz a Compute szolgáltatástól.
ExecutionState	A szkript végrehajtásának állapota.
InnerError	Belső hiba részletei.
InstanceViewStatus	Példánynézet állapota.
RunCommandInputParameter	Egy futtatási parancsparaméter tulajdonságait ismerteti.
RunCommandManagedIdentity	Olyan felhasználó által hozzárendelt felügyelt identitás clientId-ját vagy objectId azonosítóját tartalmazza (csak egyet, nem mindkettőt), amely hozzáféréssel rendelkezik a Futtatás parancsban használt tárolóblobhoz. Rendszer által hozzárendelt identitás esetén használjon üres RunCommandManagedIdentity objektumot. Győződjön meg arról, hogy az Azure Storage-blob létezik a scriptUri esetében, és a felügyelt identitás hozzáférést kapott a blob tárolóhoz a "Storage-blobadatok olvasója" szerepkör-hozzárendeléssel a scriptUri blob és a "Storage-blobadatok közreműködője" szerepkörrel a hozzáfűző blobok esetében (outputBlobUri, errorBlobUri). Felhasználó által hozzárendelt identitás esetén mindenképpen adja hozzá a virtuális gép identitásához. A felügyelt identitással és a parancs futtatásával kapcsolatos további információkért tekintse meg a és https://aka.ms/RunCommandManageda parancsothttps://aka.ms/ManagedIdentity.
StatusLevelTypes	A szintkód.
VirtualMachineRunCommand	Egy virtuális gép futtatási parancsát ismerteti.
VirtualMachineRunCommandInstanceView	Egy virtuális gép futtatási parancsának példánynézete.
VirtualMachineRunCommandScriptSource	A futtatási parancs szkriptforrásainak ismertetése. Csak egy szkriptet, scriptUrit és commandId-t használjon.

ApiError

API-hiba.

Name	Típus	Description
code	string	A hibakód.
details	ApiErrorBase[]	Az API-hiba részletei
innererror	InnerError	Az API belső hibája
message	string	A hibaüzenet.
target	string	Az adott hiba célja.

ApiErrorBase

API-hibabázis.

Name	Típus	Description
code	string	A hibakód.
message	string	A hibaüzenet.
target	string	Az adott hiba célja.

CloudError

Hibaválasz a Compute szolgáltatástól.

Name	Típus	Description
error	ApiError	API-hiba.

ExecutionState

A szkript végrehajtásának állapota.

Name	Típus	Description
Canceled	string
Failed	string
Pending	string
Running	string
Succeeded	string
TimedOut	string
Unknown	string

InnerError

Belső hiba részletei.

Name	Típus	Description
errordetail	string	A belső hibaüzenet vagy kivételkép.
exceptiontype	string	A kivétel típusa.

InstanceViewStatus

Példánynézet állapota.

Name	Típus	Description
code	string	Az állapotkód.
displayStatus	string	Az állapot rövid honosítható címkéje.
level	StatusLevelTypes	A szintkód.
message	string	A részletes állapotüzenet, beleértve a riasztásokat és a hibaüzeneteket is.
time	string	Az állapot időpontja.

RunCommandInputParameter

Egy futtatási parancsparaméter tulajdonságait ismerteti.

Name	Típus	Description
name	string	A parancsfuttatási paraméter neve.
value	string	A futtatás parancsparaméterének értéke.

RunCommandManagedIdentity

Olyan felhasználó által hozzárendelt felügyelt identitás clientId-ját vagy objectId azonosítóját tartalmazza (csak egyet, nem mindkettőt), amely hozzáféréssel rendelkezik a Futtatás parancsban használt tárolóblobhoz. Rendszer által hozzárendelt identitás esetén használjon üres RunCommandManagedIdentity objektumot. Győződjön meg arról, hogy az Azure Storage-blob létezik a scriptUri esetében, és a felügyelt identitás hozzáférést kapott a blob tárolóhoz a "Storage-blobadatok olvasója" szerepkör-hozzárendeléssel a scriptUri blob és a "Storage-blobadatok közreműködője" szerepkörrel a hozzáfűző blobok esetében (outputBlobUri, errorBlobUri). Felhasználó által hozzárendelt identitás esetén mindenképpen adja hozzá a virtuális gép identitásához. A felügyelt identitással és a parancs futtatásával kapcsolatos további információkért tekintse meg a és https://aka.ms/RunCommandManageda parancsothttps://aka.ms/ManagedIdentity.

Name	Típus	Description
clientId	string	A felhasználó által hozzárendelt felügyelt identitás ügyfél-azonosítója (GUID-értéke). Az ObjectId nem használható, ha ez meg van adva.
objectId	string	A felhasználó által hozzárendelt felügyelt identitás objektumazonosítója (GUID-értéke). A ClientId nem használható, ha ez meg van adva.

StatusLevelTypes

A szintkód.

Name	Típus	Description
Error	string
Info	string
Warning	string

VirtualMachineRunCommand

Egy virtuális gép futtatási parancsát ismerteti.

Name	Típus	Alapértelmezett érték	Description
id	string		Erőforrás-azonosító
location	string		Erőforrás helye
name	string		Erőforrás neve
properties.asyncExecution	boolean	False	Választható. Ha true (igaz) értékre van állítva, a kiépítés a szkript elindításakor azonnal befejeződik, és nem várja meg, amíg a szkript befejeződik.
properties.errorBlobManagedIdentity	RunCommandManagedIdentity		Felhasználó által hozzárendelt felügyelt identitás, amely hozzáfér az errorBlobUri storage blobhoz. Használjon üres objektumot rendszer által hozzárendelt identitás esetén. Győződjön meg arról, hogy a felügyelt identitás hozzáférést kapott a blob tárolóhoz a "Storage-blobadatok közreműködője" szerepkör-hozzárendeléssel. Felhasználó által hozzárendelt identitás esetén győződjön meg arról, hogy hozzáadja azt a virtuális gép identitásához. A felügyelt identitással és a parancs futtatásával kapcsolatos további információkért lásd: https://aka.ms/ManagedIdentity és https://aka.ms/RunCommandManaged
properties.errorBlobUri	string		Megadja azt az Azure Storage-blobot, ahová a szkripthibák streamje fel lesz töltve. SAS URI-t használjon olvasási, hozzáfűzési, létrehozási, írási hozzáféréssel, vagy használjon felügyelt identitást a virtuális gép blobhoz való hozzáférésének biztosításához. Lásd: errorBlobManagedIdentity paraméter.
properties.instanceView	VirtualMachineRunCommandInstanceView		A virtuális gép futtatja a parancspéldány nézetét.
properties.outputBlobManagedIdentity	RunCommandManagedIdentity		Felhasználó által hozzárendelt felügyelt identitás, amely hozzáfér az outputBlobUri storage blobhoz. Használjon üres objektumot rendszer által hozzárendelt identitás esetén. Győződjön meg arról, hogy a felügyelt identitás hozzáférést kapott a blob tárolóhoz a "Storage-blobadatok közreműködője" szerepkör-hozzárendeléssel. Felhasználó által hozzárendelt identitás esetén győződjön meg arról, hogy hozzáadja azt a virtuális gép identitásához. A felügyelt identitással és a parancs futtatásával kapcsolatos további információkért lásd: https://aka.ms/ManagedIdentity és https://aka.ms/RunCommandManaged
properties.outputBlobUri	string		Megadja azt az Azure Storage-blobot, ahová a szkript kimeneti streamje fel lesz töltve. SAS URI-t használjon olvasási, hozzáfűzési, létrehozási, írási hozzáféréssel, vagy használjon felügyelt identitást a virtuális gép blobhoz való hozzáférésének biztosításához. Tekintse meg az outputBlobManagedIdentity paramétert.
properties.parameters	RunCommandInputParameter[]		A szkript által használt paraméterek.
properties.protectedParameters	RunCommandInputParameter[]		A szkript által használt paraméterek.
properties.provisioningState	string		A kiépítési állapot, amely csak a válaszban jelenik meg. Ha a treatFailureAsDeploymentFailure értéke true (igaz), a szkript bármely hibája sikertelen lesz az üzembe helyezés során, a ProvisioningState pedig Sikertelenként lesz megjelölve. Ha a treatFailureAsDeploymentFailure értéke hamis, a ProvisioningState csak azt tükrözi, hogy a futtatási parancsot futtatta-e a bővítményplatform, nem jelzi, hogy a szkript meghiúsult-e szkripthibák esetén. Az executionMessage, output, error megtekintéséhez tekintse meg a futtatási parancs példánynézetét szkripthibák esetén: https://aka.ms/runcommandmanaged#get-execution-status-and-results
properties.runAsPassword	string		Megadja a felhasználói fiók jelszavát a virtuális gépen a futtatási parancs végrehajtásakor.
properties.runAsUser	string		Megadja a virtuális gép felhasználói fiókját a futtatási parancs végrehajtásakor.
properties.source	VirtualMachineRunCommandScriptSource		A futtatási parancsszkript forrása.
properties.timeoutInSeconds	integer		A futtatási parancs végrehajtásának időtúllépése másodpercben.
properties.treatFailureAsDeploymentFailure	boolean	False	Választható. Ha true (igaz) értékre van állítva, a szkript bármely hibája meghiúsul az üzembe helyezés során, a ProvisioningState pedig Sikertelenként lesz megjelölve. Ha false (hamis) értékre van állítva, a ProvisioningState csak azt tükrözi, hogy a futtatási parancsot a bővítményplatform futtatta-e, nem jelzi, hogy a szkript meghiúsult-e szkripthibák esetén. Az executionMessage, output, error megtekintéséhez tekintse meg a futtatási parancs példánynézetét szkripthibák esetén: https://aka.ms/runcommandmanaged#get-execution-status-and-results
tags	object		Erőforráscímkék
type	string		Erőforrás típusa

VirtualMachineRunCommandInstanceView

Egy virtuális gép futtatási parancsának példánynézete.

Name	Típus	Description
endTime	string	A szkript befejezési ideje.
error	string	Szkripthiba-stream.
executionMessage	string	Szkriptkonfigurációs hibák vagy végrehajtási üzenetek közlése.
executionState	ExecutionState	A szkript végrehajtásának állapota.
exitCode	integer	Kilépési kód a szkript végrehajtásából.
output	string	Szkript kimeneti adatfolyama.
startTime	string	Szkript kezdési időpontja.
statuses	InstanceViewStatus[]	Az erőforrás állapotadatai.

VirtualMachineRunCommandScriptSource

A futtatási parancs szkriptforrásainak ismertetése. Csak egy szkriptet, scriptUrit és commandId-t használjon.

Name	Típus	Description
commandId	string	Az előre definiált beépített szkript commandId azonosítóját adja meg.
script	string	Megadja a virtuális gépen végrehajtandó szkripttartalmat.
scriptUri	string	Megadja a szkript letöltési helyét. Ez lehet olvasási hozzáféréssel rendelkező Azure Storage-blob SAS URI-ja vagy nyilvános URI.
scriptUriManagedIdentity	RunCommandManagedIdentity	Felhasználó által hozzárendelt felügyelt identitás, amely hozzáféréssel rendelkezik a scriptUri-hoz az Azure Storage-blob esetében. Használjon üres objektumot rendszer által hozzárendelt identitás esetén. Győződjön meg arról, hogy az Azure Storage-blob létezik, és a felügyelt identitás hozzáférést kapott a blob tárolóhoz a "Storage-blobadatok olvasója" szerepkör-hozzárendeléssel. Felhasználó által hozzárendelt identitás esetén győződjön meg arról, hogy hozzáadja azt a virtuális gép identitásához. A felügyelt identitással és a parancs futtatásával kapcsolatos további információkért tekintse meg a és https://aka.ms/RunCommandManageda parancsothttps://aka.ms/ManagedIdentity.