azure-native.compute.getVirtualMachineScaleSetVMRunCommand

Explore with Pulumi AI

The operation to get the VMSS VM run command. API Version: 2021-03-01.

Using getVirtualMachineScaleSetVMRunCommand

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getVirtualMachineScaleSetVMRunCommand(args: GetVirtualMachineScaleSetVMRunCommandArgs, opts?: InvokeOptions): Promise<GetVirtualMachineScaleSetVMRunCommandResult>
function getVirtualMachineScaleSetVMRunCommandOutput(args: GetVirtualMachineScaleSetVMRunCommandOutputArgs, opts?: InvokeOptions): Output<GetVirtualMachineScaleSetVMRunCommandResult>
def get_virtual_machine_scale_set_vm_run_command(expand: Optional[str] = None,
                                                 instance_id: Optional[str] = None,
                                                 resource_group_name: Optional[str] = None,
                                                 run_command_name: Optional[str] = None,
                                                 vm_scale_set_name: Optional[str] = None,
                                                 opts: Optional[InvokeOptions] = None) -> GetVirtualMachineScaleSetVMRunCommandResult
def get_virtual_machine_scale_set_vm_run_command_output(expand: Optional[pulumi.Input[str]] = None,
                                                 instance_id: Optional[pulumi.Input[str]] = None,
                                                 resource_group_name: Optional[pulumi.Input[str]] = None,
                                                 run_command_name: Optional[pulumi.Input[str]] = None,
                                                 vm_scale_set_name: Optional[pulumi.Input[str]] = None,
                                                 opts: Optional[InvokeOptions] = None) -> Output[GetVirtualMachineScaleSetVMRunCommandResult]
func LookupVirtualMachineScaleSetVMRunCommand(ctx *Context, args *LookupVirtualMachineScaleSetVMRunCommandArgs, opts ...InvokeOption) (*LookupVirtualMachineScaleSetVMRunCommandResult, error)
func LookupVirtualMachineScaleSetVMRunCommandOutput(ctx *Context, args *LookupVirtualMachineScaleSetVMRunCommandOutputArgs, opts ...InvokeOption) LookupVirtualMachineScaleSetVMRunCommandResultOutput

> Note: This function is named LookupVirtualMachineScaleSetVMRunCommand in the Go SDK.

public static class GetVirtualMachineScaleSetVMRunCommand 
{
    public static Task<GetVirtualMachineScaleSetVMRunCommandResult> InvokeAsync(GetVirtualMachineScaleSetVMRunCommandArgs args, InvokeOptions? opts = null)
    public static Output<GetVirtualMachineScaleSetVMRunCommandResult> Invoke(GetVirtualMachineScaleSetVMRunCommandInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetVirtualMachineScaleSetVMRunCommandResult> getVirtualMachineScaleSetVMRunCommand(GetVirtualMachineScaleSetVMRunCommandArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: azure-native:compute:getVirtualMachineScaleSetVMRunCommand
  arguments:
    # arguments dictionary

The following arguments are supported:

InstanceId string

The instance ID of the virtual machine.

ResourceGroupName string

The name of the resource group.

RunCommandName string

The name of the virtual machine run command.

VmScaleSetName string

The name of the VM scale set.

Expand string

The expand expression to apply on the operation.

InstanceId string

The instance ID of the virtual machine.

ResourceGroupName string

The name of the resource group.

RunCommandName string

The name of the virtual machine run command.

VmScaleSetName string

The name of the VM scale set.

Expand string

The expand expression to apply on the operation.

instanceId String

The instance ID of the virtual machine.

resourceGroupName String

The name of the resource group.

runCommandName String

The name of the virtual machine run command.

vmScaleSetName String

The name of the VM scale set.

expand String

The expand expression to apply on the operation.

instanceId string

The instance ID of the virtual machine.

resourceGroupName string

The name of the resource group.

runCommandName string

The name of the virtual machine run command.

vmScaleSetName string

The name of the VM scale set.

expand string

The expand expression to apply on the operation.

instance_id str

The instance ID of the virtual machine.

resource_group_name str

The name of the resource group.

run_command_name str

The name of the virtual machine run command.

vm_scale_set_name str

The name of the VM scale set.

expand str

The expand expression to apply on the operation.

instanceId String

The instance ID of the virtual machine.

resourceGroupName String

The name of the resource group.

runCommandName String

The name of the virtual machine run command.

vmScaleSetName String

The name of the VM scale set.

expand String

The expand expression to apply on the operation.

getVirtualMachineScaleSetVMRunCommand Result

The following output properties are available:

Id string

Resource Id

InstanceView Pulumi.AzureNative.Compute.Outputs.VirtualMachineRunCommandInstanceViewResponse

The virtual machine run command instance view.

Location string

Resource location

Name string

Resource name

ProvisioningState string

The provisioning state, which only appears in the response.

Type string

Resource type

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.

OutputBlobUri string

Specifies the Azure storage blob where script output stream will be uploaded.

Parameters List<Pulumi.AzureNative.Compute.Outputs.RunCommandInputParameterResponse>

The parameters used by the script.

ProtectedParameters List<Pulumi.AzureNative.Compute.Outputs.RunCommandInputParameterResponse>

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.

Source Pulumi.AzureNative.Compute.Outputs.VirtualMachineRunCommandScriptSourceResponse

The source of the run command script.

Tags Dictionary<string, string>

Resource tags

TimeoutInSeconds int

The timeout in seconds to execute the run command.

Id string

Resource Id

InstanceView VirtualMachineRunCommandInstanceViewResponse

The virtual machine run command instance view.

Location string

Resource location

Name string

Resource name

ProvisioningState string

The provisioning state, which only appears in the response.

Type string

Resource type

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.

OutputBlobUri string

Specifies the Azure storage blob where script output stream will be uploaded.

Parameters []RunCommandInputParameterResponse

The parameters used by the script.

ProtectedParameters []RunCommandInputParameterResponse

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.

Source VirtualMachineRunCommandScriptSourceResponse

The source of the run command script.

Tags map[string]string

Resource tags

TimeoutInSeconds int

The timeout in seconds to execute the run command.

id String

Resource Id

instanceView VirtualMachineRunCommandInstanceViewResponse

The virtual machine run command instance view.

location String

Resource location

name String

Resource name

provisioningState String

The provisioning state, which only appears in the response.

type String

Resource type

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.

outputBlobUri String

Specifies the Azure storage blob where script output stream will be uploaded.

parameters List<RunCommandInputParameterResponse>

The parameters used by the script.

protectedParameters List<RunCommandInputParameterResponse>

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.

source VirtualMachineRunCommandScriptSourceResponse

The source of the run command script.

tags Map<String,String>

Resource tags

timeoutInSeconds Integer

The timeout in seconds to execute the run command.

id string

Resource Id

instanceView VirtualMachineRunCommandInstanceViewResponse

The virtual machine run command instance view.

location string

Resource location

name string

Resource name

provisioningState string

The provisioning state, which only appears in the response.

type string

Resource type

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.

outputBlobUri string

Specifies the Azure storage blob where script output stream will be uploaded.

parameters RunCommandInputParameterResponse[]

The parameters used by the script.

protectedParameters RunCommandInputParameterResponse[]

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.

source VirtualMachineRunCommandScriptSourceResponse

The source of the run command script.

tags {[key: string]: string}

Resource tags

timeoutInSeconds number

The timeout in seconds to execute the run command.

id str

Resource Id

instance_view VirtualMachineRunCommandInstanceViewResponse

The virtual machine run command instance view.

location str

Resource location

name str

Resource name

provisioning_state str

The provisioning state, which only appears in the response.

type str

Resource type

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.

output_blob_uri str

Specifies the Azure storage blob where script output stream will be uploaded.

parameters Sequence[RunCommandInputParameterResponse]

The parameters used by the script.

protected_parameters Sequence[RunCommandInputParameterResponse]

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.

source VirtualMachineRunCommandScriptSourceResponse

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.

id String

Resource Id

instanceView Property Map

The virtual machine run command instance view.

location String

Resource location

name String

Resource name

provisioningState String

The provisioning state, which only appears in the response.

type String

Resource type

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.

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.

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.

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.

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.

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.

Package Details

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