VirtualMachineRunCommand Class

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 server.

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

Constructor

VirtualMachineRunCommand(*, location: str, tags: Dict[str, str] | None = None, source: _models.VirtualMachineRunCommandScriptSource | None = None, parameters: List[_models.RunCommandInputParameter] | None = None, protected_parameters: List[_models.RunCommandInputParameter] | None = None, async_execution: bool = False, run_as_user: str | None = None, run_as_password: str | None = None, timeout_in_seconds: int | None = None, output_blob_uri: str | None = None, error_blob_uri: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
location
str

Resource location. Required.

tags

Resource tags.

source

The source of the run command script.

parameters

The parameters used by the script.

protected_parameters

The parameters used by the script.

async_execution

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

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

run_as_password
str

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

timeout_in_seconds
int

The timeout in seconds to execute the run command.

output_blob_uri
str

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

error_blob_uri
str

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

Variables

Name Description
id
str

Resource Id.

name
str

Resource name.

type
str

Resource type.

location
str

Resource location. Required.

tags

Resource tags.

source

The source of the run command script.

parameters

The parameters used by the script.

protected_parameters

The parameters used by the script.

async_execution

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

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

run_as_password
str

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

timeout_in_seconds
int

The timeout in seconds to execute the run command.

output_blob_uri
str

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

error_blob_uri
str

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

provisioning_state
str

The provisioning state, which only appears in the response.

instance_view

The virtual machine run command instance view.