Virtual Machine Run Commands - Create Or Update

Szolgáltatás:

Compute

API-verzió:

2024-11-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-11-01

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
runCommandName	path	True	string	A VirtualMachineRunCommand neve
subscriptionId	path	True	string minLength: 1	A cél-előfizetés azonosítója.
vmName	path	True	string	A VirtualMachine neve
api-version	query	True	string minLength: 1	A művelethez használandó API-verzió.

Kérelem törzse

Name	Kötelező	Típus	Description
location	True	string	Az a földrajzi hely, ahol az erőforrás él
properties.asyncExecution		boolean	Opcionális. Ha igaz értékre van állítva, a kiépítés a szkript indí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éssel rendelkezik az errorBlobUri storage blobhoz. Rendszer által hozzárendelt identitás esetén használjon üres objektumot. 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 Blob Data Contributor" szerepkör-hozzárendeléssel. Felhasználó által hozzárendelt identitás esetén győződjön meg arról, hogy a virtuális gép identitása alatt adja hozzá. A felügyelt identitással és a parancs futtatásával kapcsolatos további információkért tekintse meg https://aka.ms/ManagedIdentity és https://aka.ms/RunCommandManaged
properties.errorBlobUri		string	Megadja azt az Azure Storage-blobot, ahová a szkripthiba-stream fel lesz töltve. Sas URI használata olvasási, hozzáfűzési, létrehozási, írási hozzáféréssel vagy felügyelt identitással a virtuális gép blobhoz való hozzáférésének biztosításához. Tekintse meg a errorBlobManagedIdentity paramétert.
properties.outputBlobManagedIdentity		RunCommandManagedIdentity	Felhasználó által hozzárendelt felügyelt identitás, amely hozzáfér az outputBlobUri storage-blobhoz. Rendszer által hozzárendelt identitás esetén használjon üres objektumot. 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 Blob Data Contributor" szerepkör-hozzárendeléssel. Felhasználó által hozzárendelt identitás esetén győződjön meg arról, hogy a virtuális gép identitása alatt adja hozzá. A felügyelt identitással és a parancs futtatásával kapcsolatos további információkért tekintse meg 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 használata olvasási, hozzáfűzési, létrehozási, írási hozzáféréssel vagy felügyelt identitással a virtuális gép blobhoz való hozzáférésének biztosításához. Tekintse meg a 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 (int32)	A futtatási parancs végrehajtásának időtúllépése másodpercben.
properties.treatFailureAsDeploymentFailure		boolean	Opcionális. Ha igaz értékre van állítva, a szkript minden hibája meghiúsul, a ProvisioningState pedig sikertelenként lesz megjelölve. Ha hamis értékre van állítva, a ProvisioningState csak azt tükrözné, hogy a futtatási parancsot a bővítményplatform futtatta-e, nem jelzi, hogy szkripthiba esetén a szkript meghiúsult-e. A futtatási parancs példánynézete parancsfájlhibák esetén a végrehajtásMessage, kimenet, hiba: 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	A "VirtualMachineRunCommand" erőforrás frissítési művelete sikeres volt
201 Created	VirtualMachineRunCommand	A "VirtualMachineRunCommand" erőforrás létrehozási művelete sikeres volt Fejlécek Location: string Retry-After: integer
Other Status Codes	CloudError	Váratlan hibaválasz.

Biztonság

azure_auth

Azure Active Directory Oauth2-folyamat.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

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

Példák

Create or update a run command.

Mintakérelem

HTTP

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/250861bb6a886b75255edfa0aa5ee2dd0d6e7a11/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-11-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");
require("dotenv/config");

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

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-11-01/examples/runCommandExamples/VirtualMachineRunCommand_CreateOrUpdate.json
// this example is just showing the usage of "VirtualMachineRunCommands_CreateOrUpdate" 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 VirtualMachineResource created on azure
// for more information of creating VirtualMachineResource, please refer to the document of VirtualMachineResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string vmName = "myVM";
ResourceIdentifier virtualMachineResourceId = VirtualMachineResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, vmName);
VirtualMachineResource virtualMachine = client.GetVirtualMachineResource(virtualMachineResourceId);

// get the collection of this VirtualMachineRunCommandResource
VirtualMachineRunCommandCollection collection = virtualMachine.GetVirtualMachineRunCommands();

// invoke the operation
string runCommandName = "myRunCommand";
VirtualMachineRunCommandData data = new VirtualMachineRunCommandData(new AzureLocation("West US"))
{
    Source = new VirtualMachineRunCommandScriptSource
    {
        ScriptUri = new Uri("https://mystorageaccount.blob.core.windows.net/scriptcontainer/scriptURI"),
    },
    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/MyScriptoutput.txt"),
    ErrorBlobUri = new Uri("https://mystorageaccount.blob.core.windows.net/scriptcontainer/scriptURI"),
    OutputBlobManagedIdentity = new RunCommandManagedIdentity
    {
        ClientId = "22d35efb-0c99-4041-8c5b-6d24db33a69a",
    },
    TreatFailureAsDeploymentFailure = false,
};
ArmOperation<VirtualMachineRunCommandResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, runCommandName, data);
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

Mintaválasz

Állapotkó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": {
      "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"
  }
}

Állapotkód:

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.
createdByType	Az erőforrást létrehozó identitás típusa.
ExecutionState	Szkriptvégrehajtás állapota.
InnerError	Belső hiba részletei.
InstanceViewStatus	Példánynézet állapota.
RunCommandInputParameter	A futtatási parancsparaméter tulajdonságait ismerteti.
RunCommandManagedIdentity	Olyan felhasználó által hozzárendelt felügyelt identitás ügyfélazonosító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. Használjon egy üres RunCommandManagedIdentity objektumot rendszer által hozzárendelt identitás esetén. Győződjön meg arról, hogy az Azure Storage-blob létezik scriptUri esetén, és a felügyelt identitás hozzáférést kapott a blob tárolóhoz a "Storage Blob Data Reader" szerepkör-hozzárendeléssel a scriptUri blob és a "Storage Blob Data Contributor" szerepkörrel a hozzáfűző blobok esetében (outputBlobUri, errorBlobUri). Felhasználó által hozzárendelt identitás esetén győződjön meg arról, hogy a virtuális gép identitása alatt adja hozzá. A felügyelt identitással és a parancs futtatásával kapcsolatos további információkért tekintse meg https://aka.ms/ManagedIdentity és https://aka.ms/RunCommandManaged.
StatusLevelTypes	A szintkód.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
VirtualMachineRunCommand	Egy virtuális gép futtatási parancsát ismerteti.
VirtualMachineRunCommandInstanceView	Virtuális gép futtatási parancsának példánynézete.
VirtualMachineRunCommandScriptSource	A parancs futtatásához használt szkriptforrásokat ismerteti. Csak egy szkriptet használjon, szkripturit és commandId azonosítót.

ApiError

Objektum

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

Objektum

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

Objektum

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

Name	Típus	Description
error	ApiError	Api-hiba.

createdByType

Enumerálás

Az erőforrást létrehozó identitás típusa.

Érték	Description
User
Application
ManagedIdentity
Key

ExecutionState

Enumerálás

Szkriptvégrehajtás állapota.

Érték	Description
Unknown
Pending
Running
Failed
Succeeded
TimedOut
Canceled

InnerError

Objektum

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

Objektum

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 (date-time)	Az állapot időpontja.

RunCommandInputParameter

Objektum

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

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

RunCommandManagedIdentity

Objektum

Olyan felhasználó által hozzárendelt felügyelt identitás ügyfélazonosító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. Használjon egy üres RunCommandManagedIdentity objektumot rendszer által hozzárendelt identitás esetén. Győződjön meg arról, hogy az Azure Storage-blob létezik scriptUri esetén, és a felügyelt identitás hozzáférést kapott a blob tárolóhoz a "Storage Blob Data Reader" szerepkör-hozzárendeléssel a scriptUri blob és a "Storage Blob Data Contributor" szerepkörrel a hozzáfűző blobok esetében (outputBlobUri, errorBlobUri). Felhasználó által hozzárendelt identitás esetén győződjön meg arról, hogy a virtuális gép identitása alatt adja hozzá. A felügyelt identitással és a parancs futtatásával kapcsolatos további információkért tekintse meg https://aka.ms/ManagedIdentity és https://aka.ms/RunCommandManaged.

Name	Típus	Description
clientId	string	A felhasználó által hozzárendelt felügyelt identitás ügyfélazonosítója (GUID-értéke). Ha ez meg van adva, az ObjectId nem használható.
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

Enumerálás

A szintkód.

Érték	Description
Info
Warning
Error

systemData

Objektum

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

VirtualMachineRunCommand

Objektum

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

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Az a földrajzi hely, ahol az erőforrás él
name	string	Az erőforrás neve
properties.asyncExecution	boolean	Opcionális. Ha igaz értékre van állítva, a kiépítés a szkript indí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éssel rendelkezik az errorBlobUri storage blobhoz. Rendszer által hozzárendelt identitás esetén használjon üres objektumot. 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 Blob Data Contributor" szerepkör-hozzárendeléssel. Felhasználó által hozzárendelt identitás esetén győződjön meg arról, hogy a virtuális gép identitása alatt adja hozzá. A felügyelt identitással és a parancs futtatásával kapcsolatos további információkért tekintse meg https://aka.ms/ManagedIdentity és https://aka.ms/RunCommandManaged
properties.errorBlobUri	string	Megadja azt az Azure Storage-blobot, ahová a szkripthiba-stream fel lesz töltve. Sas URI használata olvasási, hozzáfűzési, létrehozási, írási hozzáféréssel vagy felügyelt identitással a virtuális gép blobhoz való hozzáférésének biztosításához. Tekintse meg a errorBlobManagedIdentity paramétert.
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. Rendszer által hozzárendelt identitás esetén használjon üres objektumot. 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 Blob Data Contributor" szerepkör-hozzárendeléssel. Felhasználó által hozzárendelt identitás esetén győződjön meg arról, hogy a virtuális gép identitása alatt adja hozzá. A felügyelt identitással és a parancs futtatásával kapcsolatos további információkért tekintse meg 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 használata olvasási, hozzáfűzési, létrehozási, írási hozzáféréssel vagy felügyelt identitással a virtuális gép blobhoz való hozzáférésének biztosításához. Tekintse meg a 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 igaz, a szkriptben lévő hibák sikertelenek lesznek, a ProvisioningState pedig sikertelenként lesz megjelölve. Ha a TreatFailureAsDeploymentFailure értéke hamis, a ProvisioningState csak azt tükrözné, hogy a futtatási parancsot a bővítményplatform futtatta-e, nem jelzi, hogy szkripthiba esetén a szkript meghiúsult-e. A futtatási parancs példánynézete parancsfájlhibák esetén a végrehajtásMessage, kimenet, hiba: 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 (int32)	A futtatási parancs végrehajtásának időtúllépése másodpercben.
properties.treatFailureAsDeploymentFailure	boolean	Opcionális. Ha igaz értékre van állítva, a szkript minden hibája meghiúsul, a ProvisioningState pedig sikertelenként lesz megjelölve. Ha hamis értékre van állítva, a ProvisioningState csak azt tükrözné, hogy a futtatási parancsot a bővítményplatform futtatta-e, nem jelzi, hogy szkripthiba esetén a szkript meghiúsult-e. A futtatási parancs példánynézete parancsfájlhibák esetén a végrehajtásMessage, kimenet, hiba: https://aka.ms/runcommandmanaged#get-execution-status-and-results
systemData	systemData	A createdBy és a modifiedBy adatokat tartalmazó Azure Resource Manager-metaadatok.
tags	object	Erőforráscímkék.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

VirtualMachineRunCommandInstanceView

Objektum

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

Name	Típus	Description
endTime	string (date-time)	A szkript befejezési ideje.
error	string	Szkripthiba-adatfolyam.
executionMessage	string	Szkriptkonfigurációs hibák vagy végrehajtási üzenetek kommunikálása.
executionState	ExecutionState	Szkriptvégrehajtás állapota.
exitCode	integer (int32)	Kilépés a szkript végrehajtásából visszaadott kódból.
output	string	Szkript kimeneti adatfolyama.
startTime	string (date-time)	Szkript kezdési ideje.
statuses	InstanceViewStatus[]	Az erőforrás állapotadatai.

VirtualMachineRunCommandScriptSource

Objektum

A parancs futtatásához használt szkriptforrásokat ismerteti. Csak egy szkriptet használjon, szkripturit és commandId azonosítót.

Name	Típus	Description
commandId	string	Előre definiált beépített szkript parancsazonosí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 egy 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 Azure Storage-blob esetén rendelkezik hozzáféréssel a scriptUri-hoz. Rendszer által hozzárendelt identitás esetén használjon üres objektumot. 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 Blob Data Reader" szerepkör-hozzárendeléssel. Felhasználó által hozzárendelt identitás esetén győződjön meg arról, hogy a virtuális gép identitása alatt adja hozzá. A felügyelt identitással és a parancs futtatásával kapcsolatos további információkért tekintse meg https://aka.ms/ManagedIdentity és https://aka.ms/RunCommandManaged.