Virtual Machine Run Commands - Create Or Update

Service:

Compute

API-versie:

2024-07-01

De bewerking voor het maken of bijwerken van de opdracht uitvoeren.

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string	De naam van de resourcegroep.
runCommandName	path	True	string	De naam van de opdracht voor het uitvoeren van de virtuele machine.
subscriptionId	path	True	string	Abonnementsreferenties die het Microsoft Azure-abonnement uniek identificeren. De abonnements-id maakt deel uit van de URI voor elke serviceoproep.
vmName	path	True	string	De naam van de virtuele machine waarop de run-opdracht moet worden gemaakt of bijgewerkt.
api-version	query	True	string	Client-API-versie.

Aanvraagbody

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

Name	Vereist	Type	Description
location	True	string	Resourcelocatie
properties.asyncExecution		boolean	Facultatief. Als dit is ingesteld op true, wordt het inrichten voltooid zodra het script wordt gestart en wacht niet totdat het script is voltooid.
properties.errorBlobManagedIdentity		RunCommandManagedIdentity	Door de gebruiker toegewezen beheerde identiteit die toegang heeft tot errorBlobUri-opslagblobob. Gebruik een leeg object in het geval van door het systeem toegewezen identiteit. Zorg ervoor dat de beheerde identiteit toegang heeft gekregen tot de container van de blob met de roltoewijzing Opslagblobgegevensbijdrager. Zorg er in het geval van door de gebruiker toegewezen identiteit voor dat u deze toevoegt onder de identiteit van de VIRTUELE machine. Raadpleeg https://aka.ms/ManagedIdentity en https://aka.ms/RunCommandManaged voor meer informatie over beheerde identiteit en opdracht uitvoeren
properties.errorBlobUri		string	Hiermee geeft u de Azure Storage-blob op waar de scriptfoutstroom wordt geüpload. Gebruik een SAS-URI met lees-, toevoeg-, maak-, schrijftoegang OF gebruik beheerde identiteit om de VM-toegang tot de blob te bieden. Refer errorBlobManagedIdentity parameter.
properties.outputBlobManagedIdentity		RunCommandManagedIdentity	Door de gebruiker toegewezen beheerde identiteit die toegang heeft tot de blob outputBlobUri-opslag. Gebruik een leeg object in het geval van door het systeem toegewezen identiteit. Zorg ervoor dat de beheerde identiteit toegang heeft gekregen tot de container van de blob met de roltoewijzing Opslagblobgegevensbijdrager. Zorg er in het geval van door de gebruiker toegewezen identiteit voor dat u deze toevoegt onder de identiteit van de VIRTUELE machine. Raadpleeg https://aka.ms/ManagedIdentity en https://aka.ms/RunCommandManaged voor meer informatie over beheerde identiteit en opdracht uitvoeren
properties.outputBlobUri		string	Hiermee geeft u de Azure Storage-blob op waar de scriptuitvoerstroom wordt geüpload. Gebruik een SAS-URI met lees-, toevoeg-, maak-, schrijftoegang OF gebruik beheerde identiteit om de VM-toegang tot de blob te bieden. Refer outputBlobManagedIdentity parameter.
properties.parameters		RunCommandInputParameter[]	De parameters die door het script worden gebruikt.
properties.protectedParameters		RunCommandInputParameter[]	De parameters die door het script worden gebruikt.
properties.runAsPassword		string	Hiermee geeft u het wachtwoord voor het gebruikersaccount op de virtuele machine op bij het uitvoeren van de opdracht uitvoeren.
properties.runAsUser		string	Hiermee geeft u het gebruikersaccount op de virtuele machine bij het uitvoeren van de opdracht uitvoeren.
properties.source		VirtualMachineRunCommandScriptSource	De bron van het script voor de run-opdracht.
properties.timeoutInSeconds		integer	De time-out in seconden om de run-opdracht uit te voeren.
properties.treatFailureAsDeploymentFailure		boolean	Facultatief. Als deze optie is ingesteld op waar, mislukt een fout in het script de implementatie en wordt ProvisioningState gemarkeerd als Mislukt. Als deze optie is ingesteld op false, geeft ProvisioningState alleen aan of de run-opdracht al dan niet door het uitbreidingsplatform is uitgevoerd, wordt niet aangegeven of het script is mislukt in het geval van scriptfouten. Zie de exemplaarweergave van de uitvoeringsopdracht in het geval van scriptfouten om executionMessage, uitvoer, fout te zien: https://aka.ms/runcommandmanaged#get-execution-status-and-results
tags		object	Resourcetags

Antwoorden

Name	Type	Description
200 OK	VirtualMachineRunCommand	OK Media Types: "application/json", "text/json"
201 Created	VirtualMachineRunCommand	Geschapen Media Types: "application/json", "text/json"
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt. Media Types: "application/json", "text/json"

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Create or update a run command.

Voorbeeldaanvraag

HTTP

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/runCommands/myRunCommand?api-version=2024-07-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-07-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-07-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/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-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-07-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-07-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

Voorbeeldrespons

Statuscode:

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

Statuscode:

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

Definities

Name	Description
ApiError	Api-fout.
ApiErrorBase	Api-foutbasis.
CloudError	Een foutreactie van de Compute-service.
ExecutionState	Uitvoeringsstatus van script.
InnerError	Interne foutdetails.
InstanceViewStatus	Status van exemplaarweergave.
RunCommandInputParameter	Beschrijft de eigenschappen van een opdrachtparameter uitvoeren.
RunCommandManagedIdentity	Bevat clientId of objectId (gebruik slechts één, niet beide) van een door de gebruiker toegewezen beheerde identiteit die toegang heeft tot de opslagblob die wordt gebruikt in de opdracht Uitvoeren. Gebruik een leeg RunCommandManagedIdentity-object in het geval van door het systeem toegewezen identiteit. Zorg ervoor dat de Azure Storage-blob bestaat in het geval van scriptUri en dat de beheerde identiteit toegang heeft gekregen tot de container van de blob met de roltoewijzing Storage Blob Data Reader met scriptUri-blob en Inzender voor opslagblobs (outputBlobUri, errorBlobUri). In het geval van door de gebruiker toegewezen identiteit moet u deze toevoegen onder de identiteit van de VIRTUELE machine. Raadpleeg https://aka.ms/ManagedIdentity en https://aka.ms/RunCommandManagedvoor meer informatie over beheerde identiteit en Opdracht uitvoeren.
StatusLevelTypes	De niveaucode.
VirtualMachineRunCommand	Beschrijft een opdracht voor het uitvoeren van een virtuele machine.
VirtualMachineRunCommandInstanceView	De exemplaarweergave van een opdracht voor het uitvoeren van een virtuele machine.
VirtualMachineRunCommandScriptSource	Beschrijft de scriptbronnen voor de opdracht uitvoeren. Gebruik slechts één script, scriptUri, commandId.

ApiError

Api-fout.

Name	Type	Description
code	string	De foutcode.
details	ApiErrorBase[]	Details van de API-fout
innererror	InnerError	De interne API-fout
message	string	Het foutbericht.
target	string	Het doel van de specifieke fout.

ApiErrorBase

Api-foutbasis.

Name	Type	Description
code	string	De foutcode.
message	string	Het foutbericht.
target	string	Het doel van de specifieke fout.

CloudError

Een foutreactie van de Compute-service.

Name	Type	Description
error	ApiError	Api-fout.

ExecutionState

Uitvoeringsstatus van script.

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

InnerError

Interne foutdetails.

Name	Type	Description
errordetail	string	Het interne foutbericht of de uitzonderingsdump.
exceptiontype	string	Het uitzonderingstype.

InstanceViewStatus

Status van exemplaarweergave.

Name	Type	Description
code	string	De statuscode.
displayStatus	string	Het korte lokaliseerbare label voor de status.
level	StatusLevelTypes	De niveaucode.
message	string	Het gedetailleerde statusbericht, inclusief voor waarschuwingen en foutberichten.
time	string	Het tijdstip van de status.

RunCommandInputParameter

Beschrijft de eigenschappen van een opdrachtparameter uitvoeren.

Name	Type	Description
name	string	De parameternaam van de run-opdracht.
value	string	De parameterwaarde van de opdracht uitvoeren.

RunCommandManagedIdentity

Bevat clientId of objectId (gebruik slechts één, niet beide) van een door de gebruiker toegewezen beheerde identiteit die toegang heeft tot de opslagblob die wordt gebruikt in de opdracht Uitvoeren. Gebruik een leeg RunCommandManagedIdentity-object in het geval van door het systeem toegewezen identiteit. Zorg ervoor dat de Azure Storage-blob bestaat in het geval van scriptUri en dat de beheerde identiteit toegang heeft gekregen tot de container van de blob met de roltoewijzing Storage Blob Data Reader met scriptUri-blob en Inzender voor opslagblobs (outputBlobUri, errorBlobUri). In het geval van door de gebruiker toegewezen identiteit moet u deze toevoegen onder de identiteit van de VIRTUELE machine. Raadpleeg https://aka.ms/ManagedIdentity en https://aka.ms/RunCommandManagedvoor meer informatie over beheerde identiteit en Opdracht uitvoeren.

Name	Type	Description
clientId	string	Client-id (GUID-waarde) van de door de gebruiker toegewezen beheerde identiteit. ObjectId mag niet worden gebruikt als dit is opgegeven.
objectId	string	Object-id (GUID-waarde) van de door de gebruiker toegewezen beheerde identiteit. ClientId mag niet worden gebruikt als dit is opgegeven.

StatusLevelTypes

De niveaucode.

Name	Type	Description
Error	string
Info	string
Warning	string

VirtualMachineRunCommand

Beschrijft een opdracht voor het uitvoeren van een virtuele machine.

Name	Type	Default value	Description
id	string		Resource-id
location	string		Resourcelocatie
name	string		Resourcenaam
properties.asyncExecution	boolean	False	Facultatief. Als dit is ingesteld op true, wordt het inrichten voltooid zodra het script wordt gestart en wacht niet totdat het script is voltooid.
properties.errorBlobManagedIdentity	RunCommandManagedIdentity		Door de gebruiker toegewezen beheerde identiteit die toegang heeft tot errorBlobUri-opslagblobob. Gebruik een leeg object in het geval van door het systeem toegewezen identiteit. Zorg ervoor dat de beheerde identiteit toegang heeft gekregen tot de container van de blob met de roltoewijzing Opslagblobgegevensbijdrager. Zorg er in het geval van door de gebruiker toegewezen identiteit voor dat u deze toevoegt onder de identiteit van de VIRTUELE machine. Raadpleeg https://aka.ms/ManagedIdentity en https://aka.ms/RunCommandManaged voor meer informatie over beheerde identiteit en opdracht uitvoeren
properties.errorBlobUri	string		Hiermee geeft u de Azure Storage-blob op waar de scriptfoutstroom wordt geüpload. Gebruik een SAS-URI met lees-, toevoeg-, maak-, schrijftoegang OF gebruik beheerde identiteit om de VM-toegang tot de blob te bieden. Refer errorBlobManagedIdentity parameter.
properties.instanceView	VirtualMachineRunCommandInstanceView		De weergave van het opdrachtexemplaren van de virtuele machine wordt uitgevoerd.
properties.outputBlobManagedIdentity	RunCommandManagedIdentity		Door de gebruiker toegewezen beheerde identiteit die toegang heeft tot de blob outputBlobUri-opslag. Gebruik een leeg object in het geval van door het systeem toegewezen identiteit. Zorg ervoor dat de beheerde identiteit toegang heeft gekregen tot de container van de blob met de roltoewijzing Opslagblobgegevensbijdrager. Zorg er in het geval van door de gebruiker toegewezen identiteit voor dat u deze toevoegt onder de identiteit van de VIRTUELE machine. Raadpleeg https://aka.ms/ManagedIdentity en https://aka.ms/RunCommandManaged voor meer informatie over beheerde identiteit en opdracht uitvoeren
properties.outputBlobUri	string		Hiermee geeft u de Azure Storage-blob op waar de scriptuitvoerstroom wordt geüpload. Gebruik een SAS-URI met lees-, toevoeg-, maak-, schrijftoegang OF gebruik beheerde identiteit om de VM-toegang tot de blob te bieden. Refer outputBlobManagedIdentity parameter.
properties.parameters	RunCommandInputParameter[]		De parameters die door het script worden gebruikt.
properties.protectedParameters	RunCommandInputParameter[]		De parameters die door het script worden gebruikt.
properties.provisioningState	string		De inrichtingsstatus, die alleen in het antwoord wordt weergegeven. Als treatFailureAsDeploymentFailure is ingesteld op true, mislukt elke fout in het script de implementatie en wordt ProvisioningState gemarkeerd als Mislukt. Als treatFailureAsDeploymentFailure is ingesteld op false, geeft ProvisioningState alleen aan of de run-opdracht is uitgevoerd of niet door het uitbreidingsplatform, wordt niet aangegeven of het script is mislukt in het geval van scriptfouten. Zie de exemplaarweergave van de uitvoeringsopdracht in het geval van scriptfouten om executionMessage, uitvoer, fout te zien: https://aka.ms/runcommandmanaged#get-execution-status-and-results
properties.runAsPassword	string		Hiermee geeft u het wachtwoord voor het gebruikersaccount op de virtuele machine op bij het uitvoeren van de opdracht uitvoeren.
properties.runAsUser	string		Hiermee geeft u het gebruikersaccount op de virtuele machine bij het uitvoeren van de opdracht uitvoeren.
properties.source	VirtualMachineRunCommandScriptSource		De bron van het script voor de run-opdracht.
properties.timeoutInSeconds	integer		De time-out in seconden om de run-opdracht uit te voeren.
properties.treatFailureAsDeploymentFailure	boolean	False	Facultatief. Als deze optie is ingesteld op waar, mislukt een fout in het script de implementatie en wordt ProvisioningState gemarkeerd als Mislukt. Als deze optie is ingesteld op false, geeft ProvisioningState alleen aan of de run-opdracht al dan niet door het uitbreidingsplatform is uitgevoerd, wordt niet aangegeven of het script is mislukt in het geval van scriptfouten. Zie de exemplaarweergave van de uitvoeringsopdracht in het geval van scriptfouten om executionMessage, uitvoer, fout te zien: https://aka.ms/runcommandmanaged#get-execution-status-and-results
tags	object		Resourcetags
type	string		Resourcetype

VirtualMachineRunCommandInstanceView

De exemplaarweergave van een opdracht voor het uitvoeren van een virtuele machine.

Name	Type	Description
endTime	string	Eindtijd script.
error	string	Scriptfoutstroom.
executionMessage	string	Scriptconfiguratiefouten of uitvoeringsberichten communiceren.
executionState	ExecutionState	Uitvoeringsstatus van script.
exitCode	integer	Afsluitcode die is geretourneerd na het uitvoeren van scripts.
output	string	Scriptuitvoerstroom.
startTime	string	Begintijd van script.
statuses	InstanceViewStatus[]	De informatie over de resourcestatus.

VirtualMachineRunCommandScriptSource

Beschrijft de scriptbronnen voor de opdracht uitvoeren. Gebruik slechts één script, scriptUri, commandId.

Name	Type	Description
commandId	string	Hiermee geeft u een commandId van vooraf gedefinieerd ingebouwd script.
script	string	Hiermee geeft u de scriptinhoud op die moet worden uitgevoerd op de virtuele machine.
scriptUri	string	Hiermee geeft u de locatie voor het downloaden van scripts op. Dit kan een SAS-URI zijn van een Azure Storage-blob met leestoegang of openbare URI.
scriptUriManagedIdentity	RunCommandManagedIdentity	Door de gebruiker toegewezen beheerde identiteit die toegang heeft tot scriptUri in het geval van Een Azure Storage-blob. Gebruik een leeg object in het geval van door het systeem toegewezen identiteit. Zorg ervoor dat de Azure Storage-blob bestaat en dat de beheerde identiteit toegang heeft gekregen tot de container van de blob met de roltoewijzing Opslagblobgegevenslezer. Zorg er in het geval van door de gebruiker toegewezen identiteit voor dat u deze toevoegt onder de identiteit van de VIRTUELE machine. Raadpleeg https://aka.ms/ManagedIdentity en https://aka.ms/RunCommandManagedvoor meer informatie over beheerde identiteit en Opdracht uitvoeren.