Azure Native v1.102.0, May 2 23

azure-native.compute.VirtualMachineRunCommandByVirtualMachine

Explore with Pulumi AI

Describes a Virtual Machine run command. API Version: 2021-03-01.

Example Usage

Create or update a run command.

using System.Collections.Generic;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var virtualMachineRunCommandByVirtualMachine = new AzureNative.Compute.VirtualMachineRunCommandByVirtualMachine("virtualMachineRunCommandByVirtualMachine", new()
    {
        AsyncExecution = false,
        Location = "West US",
        Parameters = new[]
        {
            new AzureNative.Compute.Inputs.RunCommandInputParameterArgs
            {
                Name = "param1",
                Value = "value1",
            },
            new AzureNative.Compute.Inputs.RunCommandInputParameterArgs
            {
                Name = "param2",
                Value = "value2",
            },
        },
        ResourceGroupName = "myResourceGroup",
        RunAsPassword = "<runAsPassword>",
        RunAsUser = "user1",
        RunCommandName = "myRunCommand",
        Source = new AzureNative.Compute.Inputs.VirtualMachineRunCommandScriptSourceArgs
        {
            Script = "Write-Host Hello World!",
        },
        TimeoutInSeconds = 3600,
        VmName = "myVM",
    });

});

package main

import (
	compute "github.com/pulumi/pulumi-azure-native/sdk/go/azure/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.NewVirtualMachineRunCommandByVirtualMachine(ctx, "virtualMachineRunCommandByVirtualMachine", &compute.VirtualMachineRunCommandByVirtualMachineArgs{
			AsyncExecution: pulumi.Bool(false),
			Location:       pulumi.String("West US"),
			Parameters: []compute.RunCommandInputParameterArgs{
				{
					Name:  pulumi.String("param1"),
					Value: pulumi.String("value1"),
				},
				{
					Name:  pulumi.String("param2"),
					Value: pulumi.String("value2"),
				},
			},
			ResourceGroupName: pulumi.String("myResourceGroup"),
			RunAsPassword:     pulumi.String("<runAsPassword>"),
			RunAsUser:         pulumi.String("user1"),
			RunCommandName:    pulumi.String("myRunCommand"),
			Source: &compute.VirtualMachineRunCommandScriptSourceArgs{
				Script: pulumi.String("Write-Host Hello World!"),
			},
			TimeoutInSeconds: pulumi.Int(3600),
			VmName:           pulumi.String("myVM"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.compute.VirtualMachineRunCommandByVirtualMachine;
import com.pulumi.azurenative.compute.VirtualMachineRunCommandByVirtualMachineArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var virtualMachineRunCommandByVirtualMachine = new VirtualMachineRunCommandByVirtualMachine("virtualMachineRunCommandByVirtualMachine", VirtualMachineRunCommandByVirtualMachineArgs.builder()        
            .asyncExecution(false)
            .location("West US")
            .parameters(            
                Map.ofEntries(
                    Map.entry("name", "param1"),
                    Map.entry("value", "value1")
                ),
                Map.ofEntries(
                    Map.entry("name", "param2"),
                    Map.entry("value", "value2")
                ))
            .resourceGroupName("myResourceGroup")
            .runAsPassword("<runAsPassword>")
            .runAsUser("user1")
            .runCommandName("myRunCommand")
            .source(Map.of("script", "Write-Host Hello World!"))
            .timeoutInSeconds(3600)
            .vmName("myVM")
            .build());

    }
}

import pulumi
import pulumi_azure_native as azure_native

virtual_machine_run_command_by_virtual_machine = azure_native.compute.VirtualMachineRunCommandByVirtualMachine("virtualMachineRunCommandByVirtualMachine",
    async_execution=False,
    location="West US",
    parameters=[
        {
            "name": "param1",
            "value": "value1",
        },
        {
            "name": "param2",
            "value": "value2",
        },
    ],
    resource_group_name="myResourceGroup",
    run_as_password="<runAsPassword>",
    run_as_user="user1",
    run_command_name="myRunCommand",
    source=azure_native.compute.VirtualMachineRunCommandScriptSourceArgs(
        script="Write-Host Hello World!",
    ),
    timeout_in_seconds=3600,
    vm_name="myVM")

import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const virtualMachineRunCommandByVirtualMachine = new azure_native.compute.VirtualMachineRunCommandByVirtualMachine("virtualMachineRunCommandByVirtualMachine", {
    asyncExecution: false,
    location: "West US",
    parameters: [
        {
            name: "param1",
            value: "value1",
        },
        {
            name: "param2",
            value: "value2",
        },
    ],
    resourceGroupName: "myResourceGroup",
    runAsPassword: "<runAsPassword>",
    runAsUser: "user1",
    runCommandName: "myRunCommand",
    source: {
        script: "Write-Host Hello World!",
    },
    timeoutInSeconds: 3600,
    vmName: "myVM",
});

resources:
  virtualMachineRunCommandByVirtualMachine:
    type: azure-native:compute:VirtualMachineRunCommandByVirtualMachine
    properties:
      asyncExecution: false
      location: West US
      parameters:
        - name: param1
          value: value1
        - name: param2
          value: value2
      resourceGroupName: myResourceGroup
      runAsPassword: <runAsPassword>
      runAsUser: user1
      runCommandName: myRunCommand
      source:
        script: Write-Host Hello World!
      timeoutInSeconds: 3600
      vmName: myVM

Create VirtualMachineRunCommandByVirtualMachine Resource

new VirtualMachineRunCommandByVirtualMachine(name: string, args: VirtualMachineRunCommandByVirtualMachineArgs, opts?: CustomResourceOptions);

@overload
def VirtualMachineRunCommandByVirtualMachine(resource_name: str,
                                             opts: Optional[ResourceOptions] = None,
                                             async_execution: Optional[bool] = None,
                                             error_blob_uri: Optional[str] = None,
                                             location: Optional[str] = None,
                                             output_blob_uri: Optional[str] = None,
                                             parameters: Optional[Sequence[RunCommandInputParameterArgs]] = None,
                                             protected_parameters: Optional[Sequence[RunCommandInputParameterArgs]] = None,
                                             resource_group_name: Optional[str] = None,
                                             run_as_password: Optional[str] = None,
                                             run_as_user: Optional[str] = None,
                                             run_command_name: Optional[str] = None,
                                             source: Optional[VirtualMachineRunCommandScriptSourceArgs] = None,
                                             tags: Optional[Mapping[str, str]] = None,
                                             timeout_in_seconds: Optional[int] = None,
                                             vm_name: Optional[str] = None)
@overload
def VirtualMachineRunCommandByVirtualMachine(resource_name: str,
                                             args: VirtualMachineRunCommandByVirtualMachineArgs,
                                             opts: Optional[ResourceOptions] = None)

func NewVirtualMachineRunCommandByVirtualMachine(ctx *Context, name string, args VirtualMachineRunCommandByVirtualMachineArgs, opts ...ResourceOption) (*VirtualMachineRunCommandByVirtualMachine, error)

public VirtualMachineRunCommandByVirtualMachine(string name, VirtualMachineRunCommandByVirtualMachineArgs args, CustomResourceOptions? opts = null)

public VirtualMachineRunCommandByVirtualMachine(String name, VirtualMachineRunCommandByVirtualMachineArgs args)
public VirtualMachineRunCommandByVirtualMachine(String name, VirtualMachineRunCommandByVirtualMachineArgs args, CustomResourceOptions options)

type: azure-native:compute:VirtualMachineRunCommandByVirtualMachine
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args VirtualMachineRunCommandByVirtualMachineArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args VirtualMachineRunCommandByVirtualMachineArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args VirtualMachineRunCommandByVirtualMachineArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args VirtualMachineRunCommandByVirtualMachineArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args VirtualMachineRunCommandByVirtualMachineArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

VirtualMachineRunCommandByVirtualMachine Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The VirtualMachineRunCommandByVirtualMachine resource accepts the following input properties:

ResourceGroupName string: The name of the resource group.
VmName string: The name of the virtual machine where the run command should be created or updated.
AsyncExecution bool: Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete.
ErrorBlobUri string: Specifies the Azure storage blob where script error stream will be uploaded.
Location string: Resource location
OutputBlobUri string: Specifies the Azure storage blob where script output stream will be uploaded.
Parameters List<Pulumi.AzureNative.Compute.Inputs.RunCommandInputParameterArgs>: The parameters used by the script.
ProtectedParameters List<Pulumi.AzureNative.Compute.Inputs.RunCommandInputParameterArgs>: The parameters used by the script.
RunAsPassword string: Specifies the user account password on the VM when executing the run command.
RunAsUser string: Specifies the user account on the VM when executing the run command.
RunCommandName string: The name of the virtual machine run command.
Source Pulumi.AzureNative.Compute.Inputs.VirtualMachineRunCommandScriptSourceArgs: The source of the run command script.
Tags Dictionary<string, string>: Resource tags
TimeoutInSeconds int: The timeout in seconds to execute the run command.

ResourceGroupName string: The name of the resource group.
VmName string: The name of the virtual machine where the run command should be created or updated.
AsyncExecution bool: Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete.
ErrorBlobUri string: Specifies the Azure storage blob where script error stream will be uploaded.
Location string: Resource location
OutputBlobUri string: Specifies the Azure storage blob where script output stream will be uploaded.
Parameters []RunCommandInputParameterArgs: The parameters used by the script.
ProtectedParameters []RunCommandInputParameterArgs: The parameters used by the script.
RunAsPassword string: Specifies the user account password on the VM when executing the run command.
RunAsUser string: Specifies the user account on the VM when executing the run command.
RunCommandName string: The name of the virtual machine run command.
Source VirtualMachineRunCommandScriptSourceArgs: The source of the run command script.
Tags map[string]string: Resource tags
TimeoutInSeconds int: The timeout in seconds to execute the run command.

resourceGroupName String: The name of the resource group.
vmName String: The name of the virtual machine where the run command should be created or updated.
asyncExecution Boolean: Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete.
errorBlobUri String: Specifies the Azure storage blob where script error stream will be uploaded.
location String: Resource location
outputBlobUri String: Specifies the Azure storage blob where script output stream will be uploaded.
parameters List<RunCommandInputParameterArgs>: The parameters used by the script.
protectedParameters List<RunCommandInputParameterArgs>: The parameters used by the script.
runAsPassword String: Specifies the user account password on the VM when executing the run command.
runAsUser String: Specifies the user account on the VM when executing the run command.
runCommandName String: The name of the virtual machine run command.
source VirtualMachineRunCommandScriptSourceArgs: The source of the run command script.
tags Map<String,String>: Resource tags
timeoutInSeconds Integer: The timeout in seconds to execute the run command.

resourceGroupName string: The name of the resource group.
vmName string: The name of the virtual machine where the run command should be created or updated.
asyncExecution boolean: Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete.
errorBlobUri string: Specifies the Azure storage blob where script error stream will be uploaded.
location string: Resource location
outputBlobUri string: Specifies the Azure storage blob where script output stream will be uploaded.
parameters RunCommandInputParameterArgs[]: The parameters used by the script.
protectedParameters RunCommandInputParameterArgs[]: The parameters used by the script.
runAsPassword string: Specifies the user account password on the VM when executing the run command.
runAsUser string: Specifies the user account on the VM when executing the run command.
runCommandName string: The name of the virtual machine run command.
source VirtualMachineRunCommandScriptSourceArgs: The source of the run command script.
tags {[key: string]: string}: Resource tags
timeoutInSeconds number: The timeout in seconds to execute the run command.

resource_group_name str: The name of the resource group.
vm_name str: The name of the virtual machine where the run command should be created or updated.
async_execution bool: Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete.
error_blob_uri str: Specifies the Azure storage blob where script error stream will be uploaded.
location str: Resource location
output_blob_uri str: Specifies the Azure storage blob where script output stream will be uploaded.
parameters Sequence[RunCommandInputParameterArgs]: The parameters used by the script.
protected_parameters Sequence[RunCommandInputParameterArgs]: The parameters used by the script.
run_as_password str: Specifies the user account password on the VM when executing the run command.
run_as_user str: Specifies the user account on the VM when executing the run command.
run_command_name str: The name of the virtual machine run command.
source VirtualMachineRunCommandScriptSourceArgs: The source of the run command script.
tags Mapping[str, str]: Resource tags
timeout_in_seconds int: The timeout in seconds to execute the run command.

resourceGroupName String: The name of the resource group.
vmName String: The name of the virtual machine where the run command should be created or updated.
asyncExecution Boolean: Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete.
errorBlobUri String: Specifies the Azure storage blob where script error stream will be uploaded.
location String: Resource location
outputBlobUri String: Specifies the Azure storage blob where script output stream will be uploaded.
parameters List<Property Map>: The parameters used by the script.
protectedParameters List<Property Map>: The parameters used by the script.
runAsPassword String: Specifies the user account password on the VM when executing the run command.
runAsUser String: Specifies the user account on the VM when executing the run command.
runCommandName String: The name of the virtual machine run command.
source Property Map: The source of the run command script.
tags Map<String>: Resource tags
timeoutInSeconds Number: The timeout in seconds to execute the run command.

Outputs

All input properties are implicitly available as output properties. Additionally, the VirtualMachineRunCommandByVirtualMachine resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
InstanceView Pulumi.AzureNative.Compute.Outputs.VirtualMachineRunCommandInstanceViewResponse: The virtual machine run command instance view.
Name string: Resource name
ProvisioningState string: The provisioning state, which only appears in the response.
Type string: Resource type

Id string: The provider-assigned unique ID for this managed resource.
InstanceView VirtualMachineRunCommandInstanceViewResponse: The virtual machine run command instance view.
Name string: Resource name
ProvisioningState string: The provisioning state, which only appears in the response.
Type string: Resource type

id String: The provider-assigned unique ID for this managed resource.
instanceView VirtualMachineRunCommandInstanceViewResponse: The virtual machine run command instance view.
name String: Resource name
provisioningState String: The provisioning state, which only appears in the response.
type String: Resource type

id string: The provider-assigned unique ID for this managed resource.
instanceView VirtualMachineRunCommandInstanceViewResponse: The virtual machine run command instance view.
name string: Resource name
provisioningState string: The provisioning state, which only appears in the response.
type string: Resource type

id str: The provider-assigned unique ID for this managed resource.
instance_view VirtualMachineRunCommandInstanceViewResponse: The virtual machine run command instance view.
name str: Resource name
provisioning_state str: The provisioning state, which only appears in the response.
type str: Resource type

id String: The provider-assigned unique ID for this managed resource.
instanceView Property Map: The virtual machine run command instance view.
name String: Resource name
provisioningState String: The provisioning state, which only appears in the response.
type String: Resource type

Supporting Types

InstanceViewStatusResponse

Code string: The status code.
DisplayStatus string: The short localizable label for the status.
Level string: The level code.
Message string: The detailed status message, including for alerts and error messages.
Time string: The time of the status.

Code string: The status code.
DisplayStatus string: The short localizable label for the status.
Level string: The level code.
Message string: The detailed status message, including for alerts and error messages.
Time string: The time of the status.

code String: The status code.
displayStatus String: The short localizable label for the status.
level String: The level code.
message String: The detailed status message, including for alerts and error messages.
time String: The time of the status.

code string: The status code.
displayStatus string: The short localizable label for the status.
level string: The level code.
message string: The detailed status message, including for alerts and error messages.
time string: The time of the status.

code str: The status code.
display_status str: The short localizable label for the status.
level str: The level code.
message str: The detailed status message, including for alerts and error messages.
time str: The time of the status.

code String: The status code.
displayStatus String: The short localizable label for the status.
level String: The level code.
message String: The detailed status message, including for alerts and error messages.
time String: The time of the status.

RunCommandInputParameter

Name string: The run command parameter name.
Value string: The run command parameter value.

Name string: The run command parameter name.
Value string: The run command parameter value.

name String: The run command parameter name.
value String: The run command parameter value.

name string: The run command parameter name.
value string: The run command parameter value.

name str: The run command parameter name.
value str: The run command parameter value.

name String: The run command parameter name.
value String: The run command parameter value.

RunCommandInputParameterResponse

Name string: The run command parameter name.
Value string: The run command parameter value.

Name string: The run command parameter name.
Value string: The run command parameter value.

name String: The run command parameter name.
value String: The run command parameter value.

name string: The run command parameter name.
value string: The run command parameter value.

name str: The run command parameter name.
value str: The run command parameter value.

name String: The run command parameter name.
value String: The run command parameter value.

VirtualMachineRunCommandInstanceViewResponse

EndTime string: Script end time.
Error string: Script error stream.
ExecutionMessage string: Communicate script configuration errors or execution messages.
ExecutionState string: Script execution status.
ExitCode int: Exit code returned from script execution.
Output string: Script output stream.
StartTime string: Script start time.
Statuses List<Pulumi.AzureNative.Compute.Inputs.InstanceViewStatusResponse>: The resource status information.

EndTime string: Script end time.
Error string: Script error stream.
ExecutionMessage string: Communicate script configuration errors or execution messages.
ExecutionState string: Script execution status.
ExitCode int: Exit code returned from script execution.
Output string: Script output stream.
StartTime string: Script start time.
Statuses []InstanceViewStatusResponse: The resource status information.

endTime String: Script end time.
error String: Script error stream.
executionMessage String: Communicate script configuration errors or execution messages.
executionState String: Script execution status.
exitCode Integer: Exit code returned from script execution.
output String: Script output stream.
startTime String: Script start time.
statuses List<InstanceViewStatusResponse>: The resource status information.

endTime string: Script end time.
error string: Script error stream.
executionMessage string: Communicate script configuration errors or execution messages.
executionState string: Script execution status.
exitCode number: Exit code returned from script execution.
output string: Script output stream.
startTime string: Script start time.
statuses InstanceViewStatusResponse[]: The resource status information.

end_time str: Script end time.
error str: Script error stream.
execution_message str: Communicate script configuration errors or execution messages.
execution_state str: Script execution status.
exit_code int: Exit code returned from script execution.
output str: Script output stream.
start_time str: Script start time.
statuses Sequence[InstanceViewStatusResponse]: The resource status information.

endTime String: Script end time.
error String: Script error stream.
executionMessage String: Communicate script configuration errors or execution messages.
executionState String: Script execution status.
exitCode Number: Exit code returned from script execution.
output String: Script output stream.
startTime String: Script start time.
statuses List<Property Map>: The resource status information.

VirtualMachineRunCommandScriptSource

CommandId string: Specifies a commandId of predefined built-in script.
Script string: Specifies the script content to be executed on the VM.
ScriptUri string: Specifies the script download location.

CommandId string: Specifies a commandId of predefined built-in script.
Script string: Specifies the script content to be executed on the VM.
ScriptUri string: Specifies the script download location.

commandId String: Specifies a commandId of predefined built-in script.
script String: Specifies the script content to be executed on the VM.
scriptUri String: Specifies the script download location.

commandId string: Specifies a commandId of predefined built-in script.
script string: Specifies the script content to be executed on the VM.
scriptUri string: Specifies the script download location.

command_id str: Specifies a commandId of predefined built-in script.
script str: Specifies the script content to be executed on the VM.
script_uri str: Specifies the script download location.

commandId String: Specifies a commandId of predefined built-in script.
script String: Specifies the script content to be executed on the VM.
scriptUri String: Specifies the script download location.

VirtualMachineRunCommandScriptSourceResponse

CommandId string: Specifies a commandId of predefined built-in script.
Script string: Specifies the script content to be executed on the VM.
ScriptUri string: Specifies the script download location.

CommandId string: Specifies a commandId of predefined built-in script.
Script string: Specifies the script content to be executed on the VM.
ScriptUri string: Specifies the script download location.

commandId String: Specifies a commandId of predefined built-in script.
script String: Specifies the script content to be executed on the VM.
scriptUri String: Specifies the script download location.

commandId string: Specifies a commandId of predefined built-in script.
script string: Specifies the script content to be executed on the VM.
scriptUri string: Specifies the script download location.

command_id str: Specifies a commandId of predefined built-in script.
script str: Specifies the script content to be executed on the VM.
script_uri str: Specifies the script download location.

commandId String: Specifies a commandId of predefined built-in script.
script String: Specifies the script content to be executed on the VM.
scriptUri String: Specifies the script download location.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:compute:VirtualMachineRunCommandByVirtualMachine myRunCommand /subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/runCommands/myRunCommand

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0