Feedback Edit

VirtualMachineRunCommand Class

  • Reference

Describes a Virtual Machine run command.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Inheritance
azure.mgmt.compute.v2020_12_01.models._models_py3.Resource
VirtualMachineRunCommand

Constructor

VirtualMachineRunCommand(*, location: str, tags: Optional[Dict[str, str]] = None, source: Optional[azure.mgmt.compute.v2020_12_01.models._models_py3.VirtualMachineRunCommandScriptSource] = None, parameters: Optional[List[azure.mgmt.compute.v2020_12_01.models._models_py3.RunCommandInputParameter]] = None, protected_parameters: Optional[List[azure.mgmt.compute.v2020_12_01.models._models_py3.RunCommandInputParameter]] = None, async_execution: Optional[bool] = False, run_as_user: Optional[str] = None, run_as_password: Optional[str] = None, timeout_in_seconds: Optional[int] = None, output_blob_uri: Optional[str] = None, error_blob_uri: Optional[str] = None, **kwargs)

Parameters

location
str
Required

Required. Resource location.

tags
dict[str, str]
Required

A set of tags. Resource tags.

source
VirtualMachineRunCommandScriptSource
Required

The source of the run command script.

parameters
list[RunCommandInputParameter]
Required

The parameters used by the script.

protected_parameters
list[RunCommandInputParameter]
Required

The parameters used by the script.

async_execution
bool
Required

Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete.

run_as_user
str
Required

Specifies the user account on the VM when executing the run command.

run_as_password
str
Required

Specifies the user account password on the VM when executing the run command.

timeout_in_seconds
int
Required

The timeout in seconds to execute the run command.

output_blob_uri
str
Required

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

error_blob_uri
str
Required

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

Variables

id
str

Resource Id.

name
str

Resource name.

type
str

Resource type.

provisioning_state
str

The provisioning state, which only appears in the response.

instance_view
VirtualMachineRunCommandInstanceView

The virtual machine run command instance view.