azure-native.hybridcompute.MachineRunCommand
Explore with Pulumi AI
Describes a Run Command Azure REST API version: 2023-10-03-preview.
Other available API versions: 2024-03-31-preview, 2024-05-20-preview, 2024-07-31-preview, 2024-09-10-preview, 2024-11-10-preview.
Example Usage
Create or Update a Run Command
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() => 
{
    var machineRunCommand = new AzureNative.HybridCompute.MachineRunCommand("machineRunCommand", new()
    {
        AsyncExecution = false,
        ErrorBlobUri = "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt",
        Location = "eastus2",
        MachineName = "myMachine",
        OutputBlobUri = "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt",
        Parameters = new[]
        {
            new AzureNative.HybridCompute.Inputs.RunCommandInputParameterArgs
            {
                Name = "param1",
                Value = "value1",
            },
            new AzureNative.HybridCompute.Inputs.RunCommandInputParameterArgs
            {
                Name = "param2",
                Value = "value2",
            },
        },
        ResourceGroupName = "myResourceGroup",
        RunAsPassword = "<runAsPassword>",
        RunAsUser = "user1",
        RunCommandName = "myRunCommand",
        Source = new AzureNative.HybridCompute.Inputs.MachineRunCommandScriptSourceArgs
        {
            Script = "Write-Host Hello World!",
        },
        TimeoutInSeconds = 3600,
    });
});
package main
import (
	hybridcompute "github.com/pulumi/pulumi-azure-native-sdk/hybridcompute/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := hybridcompute.NewMachineRunCommand(ctx, "machineRunCommand", &hybridcompute.MachineRunCommandArgs{
			AsyncExecution: pulumi.Bool(false),
			ErrorBlobUri:   pulumi.String("https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt"),
			Location:       pulumi.String("eastus2"),
			MachineName:    pulumi.String("myMachine"),
			OutputBlobUri:  pulumi.String("https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt"),
			Parameters: hybridcompute.RunCommandInputParameterArray{
				&hybridcompute.RunCommandInputParameterArgs{
					Name:  pulumi.String("param1"),
					Value: pulumi.String("value1"),
				},
				&hybridcompute.RunCommandInputParameterArgs{
					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: &hybridcompute.MachineRunCommandScriptSourceArgs{
				Script: pulumi.String("Write-Host Hello World!"),
			},
			TimeoutInSeconds: pulumi.Int(3600),
		})
		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.hybridcompute.MachineRunCommand;
import com.pulumi.azurenative.hybridcompute.MachineRunCommandArgs;
import com.pulumi.azurenative.hybridcompute.inputs.RunCommandInputParameterArgs;
import com.pulumi.azurenative.hybridcompute.inputs.MachineRunCommandScriptSourceArgs;
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 machineRunCommand = new MachineRunCommand("machineRunCommand", MachineRunCommandArgs.builder()
            .asyncExecution(false)
            .errorBlobUri("https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt")
            .location("eastus2")
            .machineName("myMachine")
            .outputBlobUri("https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt")
            .parameters(            
                RunCommandInputParameterArgs.builder()
                    .name("param1")
                    .value("value1")
                    .build(),
                RunCommandInputParameterArgs.builder()
                    .name("param2")
                    .value("value2")
                    .build())
            .resourceGroupName("myResourceGroup")
            .runAsPassword("<runAsPassword>")
            .runAsUser("user1")
            .runCommandName("myRunCommand")
            .source(MachineRunCommandScriptSourceArgs.builder()
                .script("Write-Host Hello World!")
                .build())
            .timeoutInSeconds(3600)
            .build());
    }
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const machineRunCommand = new azure_native.hybridcompute.MachineRunCommand("machineRunCommand", {
    asyncExecution: false,
    errorBlobUri: "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt",
    location: "eastus2",
    machineName: "myMachine",
    outputBlobUri: "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt",
    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,
});
import pulumi
import pulumi_azure_native as azure_native
machine_run_command = azure_native.hybridcompute.MachineRunCommand("machineRunCommand",
    async_execution=False,
    error_blob_uri="https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt",
    location="eastus2",
    machine_name="myMachine",
    output_blob_uri="https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt",
    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={
        "script": "Write-Host Hello World!",
    },
    timeout_in_seconds=3600)
resources:
  machineRunCommand:
    type: azure-native:hybridcompute:MachineRunCommand
    properties:
      asyncExecution: false
      errorBlobUri: https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt
      location: eastus2
      machineName: myMachine
      outputBlobUri: https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt
      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
Create MachineRunCommand Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new MachineRunCommand(name: string, args: MachineRunCommandArgs, opts?: CustomResourceOptions);@overload
def MachineRunCommand(resource_name: str,
                      args: MachineRunCommandArgs,
                      opts: Optional[ResourceOptions] = None)
@overload
def MachineRunCommand(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      machine_name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      protected_parameters: Optional[Sequence[RunCommandInputParameterArgs]] = None,
                      error_blob_managed_identity: Optional[RunCommandManagedIdentityArgs] = None,
                      error_blob_uri: Optional[str] = None,
                      output_blob_managed_identity: Optional[RunCommandManagedIdentityArgs] = None,
                      output_blob_uri: Optional[str] = None,
                      parameters: Optional[Sequence[RunCommandInputParameterArgs]] = None,
                      async_execution: Optional[bool] = None,
                      location: Optional[str] = None,
                      run_as_password: Optional[str] = None,
                      run_as_user: Optional[str] = None,
                      run_command_name: Optional[str] = None,
                      source: Optional[MachineRunCommandScriptSourceArgs] = None,
                      tags: Optional[Mapping[str, str]] = None,
                      timeout_in_seconds: Optional[int] = None)func NewMachineRunCommand(ctx *Context, name string, args MachineRunCommandArgs, opts ...ResourceOption) (*MachineRunCommand, error)public MachineRunCommand(string name, MachineRunCommandArgs args, CustomResourceOptions? opts = null)
public MachineRunCommand(String name, MachineRunCommandArgs args)
public MachineRunCommand(String name, MachineRunCommandArgs args, CustomResourceOptions options)
type: azure-native:hybridcompute:MachineRunCommand
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args MachineRunCommandArgs
- 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 MachineRunCommandArgs
- 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 MachineRunCommandArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args MachineRunCommandArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args MachineRunCommandArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var machineRunCommandResource = new AzureNative.HybridCompute.MachineRunCommand("machineRunCommandResource", new()
{
    MachineName = "string",
    ResourceGroupName = "string",
    ProtectedParameters = new[]
    {
        new AzureNative.HybridCompute.Inputs.RunCommandInputParameterArgs
        {
            Name = "string",
            Value = "string",
        },
    },
    ErrorBlobManagedIdentity = new AzureNative.HybridCompute.Inputs.RunCommandManagedIdentityArgs
    {
        ClientId = "string",
        ObjectId = "string",
    },
    ErrorBlobUri = "string",
    OutputBlobManagedIdentity = new AzureNative.HybridCompute.Inputs.RunCommandManagedIdentityArgs
    {
        ClientId = "string",
        ObjectId = "string",
    },
    OutputBlobUri = "string",
    Parameters = new[]
    {
        new AzureNative.HybridCompute.Inputs.RunCommandInputParameterArgs
        {
            Name = "string",
            Value = "string",
        },
    },
    AsyncExecution = false,
    Location = "string",
    RunAsPassword = "string",
    RunAsUser = "string",
    RunCommandName = "string",
    Source = new AzureNative.HybridCompute.Inputs.MachineRunCommandScriptSourceArgs
    {
        CommandId = "string",
        Script = "string",
        ScriptUri = "string",
        ScriptUriManagedIdentity = new AzureNative.HybridCompute.Inputs.RunCommandManagedIdentityArgs
        {
            ClientId = "string",
            ObjectId = "string",
        },
    },
    Tags = 
    {
        { "string", "string" },
    },
    TimeoutInSeconds = 0,
});
example, err := hybridcompute.NewMachineRunCommand(ctx, "machineRunCommandResource", &hybridcompute.MachineRunCommandArgs{
	MachineName:       pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	ProtectedParameters: hybridcompute.RunCommandInputParameterArray{
		&hybridcompute.RunCommandInputParameterArgs{
			Name:  pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	ErrorBlobManagedIdentity: &hybridcompute.RunCommandManagedIdentityArgs{
		ClientId: pulumi.String("string"),
		ObjectId: pulumi.String("string"),
	},
	ErrorBlobUri: pulumi.String("string"),
	OutputBlobManagedIdentity: &hybridcompute.RunCommandManagedIdentityArgs{
		ClientId: pulumi.String("string"),
		ObjectId: pulumi.String("string"),
	},
	OutputBlobUri: pulumi.String("string"),
	Parameters: hybridcompute.RunCommandInputParameterArray{
		&hybridcompute.RunCommandInputParameterArgs{
			Name:  pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	AsyncExecution: pulumi.Bool(false),
	Location:       pulumi.String("string"),
	RunAsPassword:  pulumi.String("string"),
	RunAsUser:      pulumi.String("string"),
	RunCommandName: pulumi.String("string"),
	Source: &hybridcompute.MachineRunCommandScriptSourceArgs{
		CommandId: pulumi.String("string"),
		Script:    pulumi.String("string"),
		ScriptUri: pulumi.String("string"),
		ScriptUriManagedIdentity: &hybridcompute.RunCommandManagedIdentityArgs{
			ClientId: pulumi.String("string"),
			ObjectId: pulumi.String("string"),
		},
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	TimeoutInSeconds: pulumi.Int(0),
})
var machineRunCommandResource = new MachineRunCommand("machineRunCommandResource", MachineRunCommandArgs.builder()
    .machineName("string")
    .resourceGroupName("string")
    .protectedParameters(RunCommandInputParameterArgs.builder()
        .name("string")
        .value("string")
        .build())
    .errorBlobManagedIdentity(RunCommandManagedIdentityArgs.builder()
        .clientId("string")
        .objectId("string")
        .build())
    .errorBlobUri("string")
    .outputBlobManagedIdentity(RunCommandManagedIdentityArgs.builder()
        .clientId("string")
        .objectId("string")
        .build())
    .outputBlobUri("string")
    .parameters(RunCommandInputParameterArgs.builder()
        .name("string")
        .value("string")
        .build())
    .asyncExecution(false)
    .location("string")
    .runAsPassword("string")
    .runAsUser("string")
    .runCommandName("string")
    .source(MachineRunCommandScriptSourceArgs.builder()
        .commandId("string")
        .script("string")
        .scriptUri("string")
        .scriptUriManagedIdentity(RunCommandManagedIdentityArgs.builder()
            .clientId("string")
            .objectId("string")
            .build())
        .build())
    .tags(Map.of("string", "string"))
    .timeoutInSeconds(0)
    .build());
machine_run_command_resource = azure_native.hybridcompute.MachineRunCommand("machineRunCommandResource",
    machine_name="string",
    resource_group_name="string",
    protected_parameters=[{
        "name": "string",
        "value": "string",
    }],
    error_blob_managed_identity={
        "client_id": "string",
        "object_id": "string",
    },
    error_blob_uri="string",
    output_blob_managed_identity={
        "client_id": "string",
        "object_id": "string",
    },
    output_blob_uri="string",
    parameters=[{
        "name": "string",
        "value": "string",
    }],
    async_execution=False,
    location="string",
    run_as_password="string",
    run_as_user="string",
    run_command_name="string",
    source={
        "command_id": "string",
        "script": "string",
        "script_uri": "string",
        "script_uri_managed_identity": {
            "client_id": "string",
            "object_id": "string",
        },
    },
    tags={
        "string": "string",
    },
    timeout_in_seconds=0)
const machineRunCommandResource = new azure_native.hybridcompute.MachineRunCommand("machineRunCommandResource", {
    machineName: "string",
    resourceGroupName: "string",
    protectedParameters: [{
        name: "string",
        value: "string",
    }],
    errorBlobManagedIdentity: {
        clientId: "string",
        objectId: "string",
    },
    errorBlobUri: "string",
    outputBlobManagedIdentity: {
        clientId: "string",
        objectId: "string",
    },
    outputBlobUri: "string",
    parameters: [{
        name: "string",
        value: "string",
    }],
    asyncExecution: false,
    location: "string",
    runAsPassword: "string",
    runAsUser: "string",
    runCommandName: "string",
    source: {
        commandId: "string",
        script: "string",
        scriptUri: "string",
        scriptUriManagedIdentity: {
            clientId: "string",
            objectId: "string",
        },
    },
    tags: {
        string: "string",
    },
    timeoutInSeconds: 0,
});
type: azure-native:hybridcompute:MachineRunCommand
properties:
    asyncExecution: false
    errorBlobManagedIdentity:
        clientId: string
        objectId: string
    errorBlobUri: string
    location: string
    machineName: string
    outputBlobManagedIdentity:
        clientId: string
        objectId: string
    outputBlobUri: string
    parameters:
        - name: string
          value: string
    protectedParameters:
        - name: string
          value: string
    resourceGroupName: string
    runAsPassword: string
    runAsUser: string
    runCommandName: string
    source:
        commandId: string
        script: string
        scriptUri: string
        scriptUriManagedIdentity:
            clientId: string
            objectId: string
    tags:
        string: string
    timeoutInSeconds: 0
MachineRunCommand Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The MachineRunCommand resource accepts the following input properties:
- MachineName string
- The name of the hybrid machine.
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- AsyncExecution bool
- Optional. If set to true, provisioning will complete as soon as script starts and will not wait for script to complete.
- ErrorBlob Pulumi.Managed Identity Azure Native. Hybrid Compute. Inputs. Run Command Managed Identity 
- User-assigned managed identity that has access to errorBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged
- ErrorBlob stringUri 
- Specifies the Azure storage blob where script error stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer errorBlobManagedIdentity parameter.
- Location string
- The geo-location where the resource lives
- OutputBlob Pulumi.Managed Identity Azure Native. Hybrid Compute. Inputs. Run Command Managed Identity 
- User-assigned managed identity that has access to outputBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged
- OutputBlob stringUri 
- Specifies the Azure storage blob where script output stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer outputBlobManagedIdentity parameter.
- Parameters
List<Pulumi.Azure Native. Hybrid Compute. Inputs. Run Command Input Parameter> 
- The parameters used by the script.
- ProtectedParameters List<Pulumi.Azure Native. Hybrid Compute. Inputs. Run Command Input Parameter> 
- The parameters used by the script.
- RunAs stringPassword 
- Specifies the user account password on the machine when executing the run command.
- RunAs stringUser 
- Specifies the user account on the machine when executing the run command.
- RunCommand stringName 
- The name of the run command.
- Source
Pulumi.Azure Native. Hybrid Compute. Inputs. Machine Run Command Script Source 
- The source of the run command script.
- Dictionary<string, string>
- Resource tags.
- TimeoutIn intSeconds 
- The timeout in seconds to execute the run command.
- MachineName string
- The name of the hybrid machine.
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- AsyncExecution bool
- Optional. If set to true, provisioning will complete as soon as script starts and will not wait for script to complete.
- ErrorBlob RunManaged Identity Command Managed Identity Args 
- User-assigned managed identity that has access to errorBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged
- ErrorBlob stringUri 
- Specifies the Azure storage blob where script error stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer errorBlobManagedIdentity parameter.
- Location string
- The geo-location where the resource lives
- OutputBlob RunManaged Identity Command Managed Identity Args 
- User-assigned managed identity that has access to outputBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged
- OutputBlob stringUri 
- Specifies the Azure storage blob where script output stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer outputBlobManagedIdentity parameter.
- Parameters
[]RunCommand Input Parameter Args 
- The parameters used by the script.
- ProtectedParameters []RunCommand Input Parameter Args 
- The parameters used by the script.
- RunAs stringPassword 
- Specifies the user account password on the machine when executing the run command.
- RunAs stringUser 
- Specifies the user account on the machine when executing the run command.
- RunCommand stringName 
- The name of the run command.
- Source
MachineRun Command Script Source Args 
- The source of the run command script.
- map[string]string
- Resource tags.
- TimeoutIn intSeconds 
- The timeout in seconds to execute the run command.
- machineName String
- The name of the hybrid machine.
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- asyncExecution Boolean
- Optional. If set to true, provisioning will complete as soon as script starts and will not wait for script to complete.
- errorBlob RunManaged Identity Command Managed Identity 
- User-assigned managed identity that has access to errorBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged
- errorBlob StringUri 
- Specifies the Azure storage blob where script error stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer errorBlobManagedIdentity parameter.
- location String
- The geo-location where the resource lives
- outputBlob RunManaged Identity Command Managed Identity 
- User-assigned managed identity that has access to outputBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged
- outputBlob StringUri 
- Specifies the Azure storage blob where script output stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer outputBlobManagedIdentity parameter.
- parameters
List<RunCommand Input Parameter> 
- The parameters used by the script.
- protectedParameters List<RunCommand Input Parameter> 
- The parameters used by the script.
- runAs StringPassword 
- Specifies the user account password on the machine when executing the run command.
- runAs StringUser 
- Specifies the user account on the machine when executing the run command.
- runCommand StringName 
- The name of the run command.
- source
MachineRun Command Script Source 
- The source of the run command script.
- Map<String,String>
- Resource tags.
- timeoutIn IntegerSeconds 
- The timeout in seconds to execute the run command.
- machineName string
- The name of the hybrid machine.
- resourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- asyncExecution boolean
- Optional. If set to true, provisioning will complete as soon as script starts and will not wait for script to complete.
- errorBlob RunManaged Identity Command Managed Identity 
- User-assigned managed identity that has access to errorBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged
- errorBlob stringUri 
- Specifies the Azure storage blob where script error stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer errorBlobManagedIdentity parameter.
- location string
- The geo-location where the resource lives
- outputBlob RunManaged Identity Command Managed Identity 
- User-assigned managed identity that has access to outputBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged
- outputBlob stringUri 
- Specifies the Azure storage blob where script output stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer outputBlobManagedIdentity parameter.
- parameters
RunCommand Input Parameter[] 
- The parameters used by the script.
- protectedParameters RunCommand Input Parameter[] 
- The parameters used by the script.
- runAs stringPassword 
- Specifies the user account password on the machine when executing the run command.
- runAs stringUser 
- Specifies the user account on the machine when executing the run command.
- runCommand stringName 
- The name of the run command.
- source
MachineRun Command Script Source 
- The source of the run command script.
- {[key: string]: string}
- Resource tags.
- timeoutIn numberSeconds 
- The timeout in seconds to execute the run command.
- machine_name str
- The name of the hybrid machine.
- resource_group_ strname 
- The name of the resource group. The name is case insensitive.
- async_execution bool
- Optional. If set to true, provisioning will complete as soon as script starts and will not wait for script to complete.
- error_blob_ Runmanaged_ identity Command Managed Identity Args 
- User-assigned managed identity that has access to errorBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged
- error_blob_ struri 
- Specifies the Azure storage blob where script error stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer errorBlobManagedIdentity parameter.
- location str
- The geo-location where the resource lives
- output_blob_ Runmanaged_ identity Command Managed Identity Args 
- User-assigned managed identity that has access to outputBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged
- output_blob_ struri 
- Specifies the Azure storage blob where script output stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer outputBlobManagedIdentity parameter.
- parameters
Sequence[RunCommand 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 machine when executing the run command.
- run_as_ struser 
- Specifies the user account on the machine when executing the run command.
- run_command_ strname 
- The name of the run command.
- source
MachineRun 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.
- machineName String
- The name of the hybrid machine.
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- asyncExecution Boolean
- Optional. If set to true, provisioning will complete as soon as script starts and will not wait for script to complete.
- errorBlob Property MapManaged Identity 
- User-assigned managed identity that has access to errorBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged
- errorBlob StringUri 
- Specifies the Azure storage blob where script error stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer errorBlobManagedIdentity parameter.
- location String
- The geo-location where the resource lives
- outputBlob Property MapManaged Identity 
- User-assigned managed identity that has access to outputBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged
- outputBlob StringUri 
- Specifies the Azure storage blob where script output stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer outputBlobManagedIdentity parameter.
- parameters List<Property Map>
- The parameters used by the script.
- protectedParameters List<Property Map>
- The parameters used by the script.
- runAs StringPassword 
- Specifies the user account password on the machine when executing the run command.
- runAs StringUser 
- Specifies the user account on the machine when executing the run command.
- runCommand StringName 
- The name of the run command.
- source Property Map
- The source of the run command script.
- Map<String>
- Resource tags.
- timeoutIn NumberSeconds 
- The timeout in seconds to execute the run command.
Outputs
All input properties are implicitly available as output properties. Additionally, the MachineRunCommand resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- InstanceView Pulumi.Azure Native. Hybrid Compute. Outputs. Machine Run Command Instance View Response 
- The machine run command instance view.
- Name string
- The name of the resource
- ProvisioningState string
- The provisioning state, which only appears in the response.
- SystemData Pulumi.Azure Native. Hybrid Compute. Outputs. System Data Response 
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Id string
- The provider-assigned unique ID for this managed resource.
- InstanceView MachineRun Command Instance View Response 
- The machine run command instance view.
- Name string
- The name of the resource
- ProvisioningState string
- The provisioning state, which only appears in the response.
- SystemData SystemData Response 
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- id String
- The provider-assigned unique ID for this managed resource.
- instanceView MachineRun Command Instance View Response 
- The machine run command instance view.
- name String
- The name of the resource
- provisioningState String
- The provisioning state, which only appears in the response.
- systemData SystemData Response 
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- id string
- The provider-assigned unique ID for this managed resource.
- instanceView MachineRun Command Instance View Response 
- The machine run command instance view.
- name string
- The name of the resource
- provisioningState string
- The provisioning state, which only appears in the response.
- systemData SystemData Response 
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- id str
- The provider-assigned unique ID for this managed resource.
- instance_view MachineRun Command Instance View Response 
- The machine run command instance view.
- name str
- The name of the resource
- provisioning_state str
- The provisioning state, which only appears in the response.
- system_data SystemData Response 
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- id String
- The provider-assigned unique ID for this managed resource.
- instanceView Property Map
- The machine run command instance view.
- name String
- The name of the resource
- provisioningState String
- The provisioning state, which only appears in the response.
- systemData Property Map
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Supporting Types
ExtensionsResourceStatusResponse, ExtensionsResourceStatusResponseArgs        
- 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.
MachineRunCommandInstanceViewResponse, MachineRunCommandInstanceViewResponseArgs            
- 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.Azure Native. Hybrid Compute. Inputs. Extensions Resource Status Response> 
- The 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
[]ExtensionsResource Status Response 
- The 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<ExtensionsResource Status Response> 
- The 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
ExtensionsResource Status Response[] 
- The 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[ExtensionsResource Status Response] 
- The 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 status information.
MachineRunCommandScriptSource, MachineRunCommandScriptSourceArgs          
- CommandId string
- Specifies the commandId of predefined built-in script.
- Script string
- Specifies the script content to be executed on the machine.
- ScriptUri string
- Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI.
- ScriptUri Pulumi.Managed Identity Azure Native. Hybrid Compute. Inputs. Run Command Managed Identity 
- User-assigned managed identity that has access to scriptUri in case of Azure storage blob. Use an empty object in case of system-assigned identity. Make sure the Azure storage blob exists, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged.
- CommandId string
- Specifies the commandId of predefined built-in script.
- Script string
- Specifies the script content to be executed on the machine.
- ScriptUri string
- Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI.
- ScriptUri RunManaged Identity Command Managed Identity 
- User-assigned managed identity that has access to scriptUri in case of Azure storage blob. Use an empty object in case of system-assigned identity. Make sure the Azure storage blob exists, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged.
- commandId String
- Specifies the commandId of predefined built-in script.
- script String
- Specifies the script content to be executed on the machine.
- scriptUri String
- Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI.
- scriptUri RunManaged Identity Command Managed Identity 
- User-assigned managed identity that has access to scriptUri in case of Azure storage blob. Use an empty object in case of system-assigned identity. Make sure the Azure storage blob exists, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged.
- commandId string
- Specifies the commandId of predefined built-in script.
- script string
- Specifies the script content to be executed on the machine.
- scriptUri string
- Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI.
- scriptUri RunManaged Identity Command Managed Identity 
- User-assigned managed identity that has access to scriptUri in case of Azure storage blob. Use an empty object in case of system-assigned identity. Make sure the Azure storage blob exists, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged.
- command_id str
- Specifies the commandId of predefined built-in script.
- script str
- Specifies the script content to be executed on the machine.
- script_uri str
- Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI.
- script_uri_ Runmanaged_ identity Command Managed Identity 
- User-assigned managed identity that has access to scriptUri in case of Azure storage blob. Use an empty object in case of system-assigned identity. Make sure the Azure storage blob exists, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged.
- commandId String
- Specifies the commandId of predefined built-in script.
- script String
- Specifies the script content to be executed on the machine.
- scriptUri String
- Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI.
- scriptUri Property MapManaged Identity 
- User-assigned managed identity that has access to scriptUri in case of Azure storage blob. Use an empty object in case of system-assigned identity. Make sure the Azure storage blob exists, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged.
MachineRunCommandScriptSourceResponse, MachineRunCommandScriptSourceResponseArgs            
- CommandId string
- Specifies the commandId of predefined built-in script.
- Script string
- Specifies the script content to be executed on the machine.
- ScriptUri string
- Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI.
- ScriptUri Pulumi.Managed Identity Azure Native. Hybrid Compute. Inputs. Run Command Managed Identity Response 
- User-assigned managed identity that has access to scriptUri in case of Azure storage blob. Use an empty object in case of system-assigned identity. Make sure the Azure storage blob exists, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged.
- CommandId string
- Specifies the commandId of predefined built-in script.
- Script string
- Specifies the script content to be executed on the machine.
- ScriptUri string
- Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI.
- ScriptUri RunManaged Identity Command Managed Identity Response 
- User-assigned managed identity that has access to scriptUri in case of Azure storage blob. Use an empty object in case of system-assigned identity. Make sure the Azure storage blob exists, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged.
- commandId String
- Specifies the commandId of predefined built-in script.
- script String
- Specifies the script content to be executed on the machine.
- scriptUri String
- Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI.
- scriptUri RunManaged Identity Command Managed Identity Response 
- User-assigned managed identity that has access to scriptUri in case of Azure storage blob. Use an empty object in case of system-assigned identity. Make sure the Azure storage blob exists, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged.
- commandId string
- Specifies the commandId of predefined built-in script.
- script string
- Specifies the script content to be executed on the machine.
- scriptUri string
- Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI.
- scriptUri RunManaged Identity Command Managed Identity Response 
- User-assigned managed identity that has access to scriptUri in case of Azure storage blob. Use an empty object in case of system-assigned identity. Make sure the Azure storage blob exists, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged.
- command_id str
- Specifies the commandId of predefined built-in script.
- script str
- Specifies the script content to be executed on the machine.
- script_uri str
- Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI.
- script_uri_ Runmanaged_ identity Command Managed Identity Response 
- User-assigned managed identity that has access to scriptUri in case of Azure storage blob. Use an empty object in case of system-assigned identity. Make sure the Azure storage blob exists, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged.
- commandId String
- Specifies the commandId of predefined built-in script.
- script String
- Specifies the script content to be executed on the machine.
- scriptUri String
- Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI.
- scriptUri Property MapManaged Identity 
- User-assigned managed identity that has access to scriptUri in case of Azure storage blob. Use an empty object in case of system-assigned identity. Make sure the Azure storage blob exists, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged.
RunCommandInputParameter, RunCommandInputParameterArgs        
RunCommandInputParameterResponse, RunCommandInputParameterResponseArgs          
RunCommandManagedIdentity, RunCommandManagedIdentityArgs        
RunCommandManagedIdentityResponse, RunCommandManagedIdentityResponseArgs          
SystemDataResponse, SystemDataResponseArgs      
- CreatedAt string
- The timestamp of resource creation (UTC).
- CreatedBy string
- The identity that created the resource.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- The type of identity that last modified the resource.
- CreatedAt string
- The timestamp of resource creation (UTC).
- CreatedBy string
- The identity that created the resource.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- The type of identity that last modified the resource.
- createdAt String
- The timestamp of resource creation (UTC).
- createdBy String
- The identity that created the resource.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- The type of identity that last modified the resource.
- createdAt string
- The timestamp of resource creation (UTC).
- createdBy string
- The identity that created the resource.
- createdBy stringType 
- The type of identity that created the resource.
- lastModified stringAt 
- The timestamp of resource last modification (UTC)
- lastModified stringBy 
- The identity that last modified the resource.
- lastModified stringBy Type 
- The type of identity that last modified the resource.
- created_at str
- The timestamp of resource creation (UTC).
- created_by str
- The identity that created the resource.
- created_by_ strtype 
- The type of identity that created the resource.
- last_modified_ strat 
- The timestamp of resource last modification (UTC)
- last_modified_ strby 
- The identity that last modified the resource.
- last_modified_ strby_ type 
- The type of identity that last modified the resource.
- createdAt String
- The timestamp of resource creation (UTC).
- createdBy String
- The identity that created the resource.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- The type of identity that last modified the resource.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:hybridcompute:MachineRunCommand myRunCommand /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/runCommands/{runCommandName} 
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0