azure-native.compute.VirtualMachineScaleSetVMRunCommand
Explore with Pulumi AI
Describes a Virtual Machine run command. API Version: 2021-03-01.
Example Usage
Create VirtualMachineScaleSet VM run command.
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var virtualMachineScaleSetVMRunCommand = new AzureNative.Compute.VirtualMachineScaleSetVMRunCommand("virtualMachineScaleSetVMRunCommand", new()
{
AsyncExecution = false,
InstanceId = "0",
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,
VmScaleSetName = "myvmScaleSet",
});
});
package main
import (
compute "github.com/pulumi/pulumi-azure-native-sdk/compute"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := compute.NewVirtualMachineScaleSetVMRunCommand(ctx, "virtualMachineScaleSetVMRunCommand", &compute.VirtualMachineScaleSetVMRunCommandArgs{
AsyncExecution: pulumi.Bool(false),
InstanceId: pulumi.String("0"),
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),
VmScaleSetName: pulumi.String("myvmScaleSet"),
})
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.VirtualMachineScaleSetVMRunCommand;
import com.pulumi.azurenative.compute.VirtualMachineScaleSetVMRunCommandArgs;
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 virtualMachineScaleSetVMRunCommand = new VirtualMachineScaleSetVMRunCommand("virtualMachineScaleSetVMRunCommand", VirtualMachineScaleSetVMRunCommandArgs.builder()
.asyncExecution(false)
.instanceId("0")
.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)
.vmScaleSetName("myvmScaleSet")
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
virtual_machine_scale_set_vm_run_command = azure_native.compute.VirtualMachineScaleSetVMRunCommand("virtualMachineScaleSetVMRunCommand",
async_execution=False,
instance_id="0",
location="West US",
parameters=[
azure_native.compute.RunCommandInputParameterArgs(
name="param1",
value="value1",
),
azure_native.compute.RunCommandInputParameterArgs(
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_scale_set_name="myvmScaleSet")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const virtualMachineScaleSetVMRunCommand = new azure_native.compute.VirtualMachineScaleSetVMRunCommand("virtualMachineScaleSetVMRunCommand", {
asyncExecution: false,
instanceId: "0",
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,
vmScaleSetName: "myvmScaleSet",
});
resources:
virtualMachineScaleSetVMRunCommand:
type: azure-native:compute:VirtualMachineScaleSetVMRunCommand
properties:
asyncExecution: false
instanceId: '0'
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
vmScaleSetName: myvmScaleSet
Create VirtualMachineScaleSetVMRunCommand Resource
new VirtualMachineScaleSetVMRunCommand(name: string, args: VirtualMachineScaleSetVMRunCommandArgs, opts?: CustomResourceOptions);
@overload
def VirtualMachineScaleSetVMRunCommand(resource_name: str,
opts: Optional[ResourceOptions] = None,
async_execution: Optional[bool] = None,
error_blob_uri: Optional[str] = None,
instance_id: 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_scale_set_name: Optional[str] = None)
@overload
def VirtualMachineScaleSetVMRunCommand(resource_name: str,
args: VirtualMachineScaleSetVMRunCommandArgs,
opts: Optional[ResourceOptions] = None)
func NewVirtualMachineScaleSetVMRunCommand(ctx *Context, name string, args VirtualMachineScaleSetVMRunCommandArgs, opts ...ResourceOption) (*VirtualMachineScaleSetVMRunCommand, error)
public VirtualMachineScaleSetVMRunCommand(string name, VirtualMachineScaleSetVMRunCommandArgs args, CustomResourceOptions? opts = null)
public VirtualMachineScaleSetVMRunCommand(String name, VirtualMachineScaleSetVMRunCommandArgs args)
public VirtualMachineScaleSetVMRunCommand(String name, VirtualMachineScaleSetVMRunCommandArgs args, CustomResourceOptions options)
type: azure-native:compute:VirtualMachineScaleSetVMRunCommand
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args VirtualMachineScaleSetVMRunCommandArgs
- 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 VirtualMachineScaleSetVMRunCommandArgs
- 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 VirtualMachineScaleSetVMRunCommandArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args VirtualMachineScaleSetVMRunCommandArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args VirtualMachineScaleSetVMRunCommandArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
VirtualMachineScaleSetVMRunCommand 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 VirtualMachineScaleSetVMRunCommand resource accepts the following input properties:
- Instance
Id string The instance ID of the virtual machine.
- Resource
Group stringName The name of the resource group.
- Vm
Scale stringSet Name The name of the VM scale set.
- 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 stringUri Specifies the Azure storage blob where script error stream will be uploaded.
- Location string
Resource location
- Output
Blob stringUri Specifies the Azure storage blob where script output stream will be uploaded.
- Parameters
List<Pulumi.
Azure Native. Compute. Inputs. Run Command Input Parameter Args> The parameters used by the script.
- Protected
Parameters List<Pulumi.Azure Native. Compute. Inputs. Run Command Input Parameter Args> The parameters used by the script.
- Run
As stringPassword Specifies the user account password on the VM when executing the run command.
- Run
As stringUser Specifies the user account on the VM when executing the run command.
- Run
Command stringName The name of the virtual machine run command.
- Source
Pulumi.
Azure Native. Compute. Inputs. Virtual Machine Run Command Script Source Args The source of the run command script.
- Dictionary<string, string>
Resource tags
- Timeout
In intSeconds The timeout in seconds to execute the run command.
- Instance
Id string The instance ID of the virtual machine.
- Resource
Group stringName The name of the resource group.
- Vm
Scale stringSet Name The name of the VM scale set.
- 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 stringUri Specifies the Azure storage blob where script error stream will be uploaded.
- Location string
Resource location
- Output
Blob stringUri Specifies the Azure storage blob where script output stream will be uploaded.
- Parameters
[]Run
Command Input Parameter Args The parameters used by the script.
- Protected
Parameters []RunCommand Input Parameter Args The parameters used by the script.
- Run
As stringPassword Specifies the user account password on the VM when executing the run command.
- Run
As stringUser Specifies the user account on the VM when executing the run command.
- Run
Command stringName The name of the virtual machine run command.
- Source
Virtual
Machine Run Command Script Source Args The source of the run command script.
- map[string]string
Resource tags
- Timeout
In intSeconds The timeout in seconds to execute the run command.
- instance
Id String The instance ID of the virtual machine.
- resource
Group StringName The name of the resource group.
- vm
Scale StringSet Name The name of the VM scale set.
- async
Execution Boolean Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete.
- error
Blob StringUri Specifies the Azure storage blob where script error stream will be uploaded.
- location String
Resource location
- output
Blob StringUri Specifies the Azure storage blob where script output stream will be uploaded.
- parameters
List<Run
Command Input Parameter Args> The parameters used by the script.
- protected
Parameters List<RunCommand Input Parameter Args> The parameters used by the script.
- run
As StringPassword Specifies the user account password on the VM when executing the run command.
- run
As StringUser Specifies the user account on the VM when executing the run command.
- run
Command StringName The name of the virtual machine run command.
- source
Virtual
Machine Run Command Script Source Args The source of the run command script.
- Map<String,String>
Resource tags
- timeout
In IntegerSeconds The timeout in seconds to execute the run command.
- instance
Id string The instance ID of the virtual machine.
- resource
Group stringName The name of the resource group.
- vm
Scale stringSet Name The name of the VM scale set.
- async
Execution boolean Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete.
- error
Blob stringUri Specifies the Azure storage blob where script error stream will be uploaded.
- location string
Resource location
- output
Blob stringUri Specifies the Azure storage blob where script output stream will be uploaded.
- parameters
Run
Command Input Parameter Args[] The parameters used by the script.
- protected
Parameters RunCommand Input Parameter Args[] The parameters used by the script.
- run
As stringPassword Specifies the user account password on the VM when executing the run command.
- run
As stringUser Specifies the user account on the VM when executing the run command.
- run
Command stringName The name of the virtual machine run command.
- source
Virtual
Machine Run Command Script Source Args The source of the run command script.
- {[key: string]: string}
Resource tags
- timeout
In numberSeconds The timeout in seconds to execute the run command.
- instance_
id str The instance ID of the virtual machine.
- resource_
group_ strname The name of the resource group.
- vm_
scale_ strset_ name The name of the VM scale set.
- 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_ struri Specifies the Azure storage blob where script error stream will be uploaded.
- location str
Resource location
- output_
blob_ struri Specifies the Azure storage blob where script output stream will be uploaded.
- parameters
Sequence[Run
Command Input Parameter Args] The parameters used by the script.
- protected_
parameters Sequence[RunCommand Input Parameter Args] The parameters used by the script.
- run_
as_ strpassword Specifies the user account password on the VM when executing the run command.
- run_
as_ struser Specifies the user account on the VM when executing the run command.
- run_
command_ strname The name of the virtual machine run command.
- source
Virtual
Machine Run Command Script Source Args The source of the run command script.
- Mapping[str, str]
Resource tags
- timeout_
in_ intseconds The timeout in seconds to execute the run command.
- instance
Id String The instance ID of the virtual machine.
- resource
Group StringName The name of the resource group.
- vm
Scale StringSet Name The name of the VM scale set.
- async
Execution Boolean Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete.
- error
Blob StringUri Specifies the Azure storage blob where script error stream will be uploaded.
- location String
Resource location
- output
Blob StringUri Specifies the Azure storage blob where script output stream will be uploaded.
- parameters List<Property Map>
The parameters used by the script.
- protected
Parameters List<Property Map> The parameters used by the script.
- run
As StringPassword Specifies the user account password on the VM when executing the run command.
- run
As StringUser Specifies the user account on the VM when executing the run command.
- run
Command StringName The name of the virtual machine run command.
- source Property Map
The source of the run command script.
- Map<String>
Resource tags
- timeout
In NumberSeconds The timeout in seconds to execute the run command.
Outputs
All input properties are implicitly available as output properties. Additionally, the VirtualMachineScaleSetVMRunCommand resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Instance
View Pulumi.Azure Native. Compute. Outputs. Virtual Machine Run Command Instance View Response The virtual machine run command instance view.
- Name string
Resource name
- Provisioning
State 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.
- Instance
View VirtualMachine Run Command Instance View Response The virtual machine run command instance view.
- Name string
Resource name
- Provisioning
State 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.
- instance
View VirtualMachine Run Command Instance View Response The virtual machine run command instance view.
- name String
Resource name
- provisioning
State 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.
- instance
View VirtualMachine Run Command Instance View Response The virtual machine run command instance view.
- name string
Resource name
- provisioning
State 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 VirtualMachine Run Command Instance View Response 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.
- instance
View Property Map The virtual machine run command instance view.
- name String
Resource name
- provisioning
State String The provisioning state, which only appears in the response.
- type String
Resource type
Supporting Types
InstanceViewStatusResponse
- Code string
The status code.
- Display
Status 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.
- Display
Status 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.
- display
Status 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.
- display
Status 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.
- display
Status 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
RunCommandInputParameterResponse
VirtualMachineRunCommandInstanceViewResponse
- End
Time string Script end time.
- Error string
Script error stream.
- Execution
Message string Communicate script configuration errors or execution messages.
- Execution
State string Script execution status.
- Exit
Code int Exit code returned from script execution.
- Output string
Script output stream.
- Start
Time string Script start time.
- Statuses
List<Pulumi.
Azure Native. Compute. Inputs. Instance View Status Response> The resource status information.
- End
Time string Script end time.
- Error string
Script error stream.
- Execution
Message string Communicate script configuration errors or execution messages.
- Execution
State string Script execution status.
- Exit
Code int Exit code returned from script execution.
- Output string
Script output stream.
- Start
Time string Script start time.
- Statuses
[]Instance
View Status Response The resource status information.
- end
Time String Script end time.
- error String
Script error stream.
- execution
Message String Communicate script configuration errors or execution messages.
- execution
State String Script execution status.
- exit
Code Integer Exit code returned from script execution.
- output String
Script output stream.
- start
Time String Script start time.
- statuses
List<Instance
View Status Response> The resource status information.
- end
Time string Script end time.
- error string
Script error stream.
- execution
Message string Communicate script configuration errors or execution messages.
- execution
State string Script execution status.
- exit
Code number Exit code returned from script execution.
- output string
Script output stream.
- start
Time string Script start time.
- statuses
Instance
View Status Response[] 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[Instance
View Status Response] The resource status information.
- end
Time String Script end time.
- error String
Script error stream.
- execution
Message String Communicate script configuration errors or execution messages.
- execution
State String Script execution status.
- exit
Code Number Exit code returned from script execution.
- output String
Script output stream.
- start
Time String Script start time.
- statuses List<Property Map>
The resource status information.
VirtualMachineRunCommandScriptSource
- 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.
VirtualMachineRunCommandScriptSourceResponse
- 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.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:compute:VirtualMachineScaleSetVMRunCommand myRunCommand /subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/runCommands/myRunCommand
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0