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.v2023_03_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, output_blob_managed_identity: _models.RunCommandManagedIdentity | None = None, error_blob_managed_identity: _models.RunCommandManagedIdentity | None = None, treat_failure_as_deployment_failure: bool = False, **kwargs: Any)

Keyword-Only Parameters

Name	Description
location	str Resource location. Required.
tags	dict[str, str] Resource tags.
source	VirtualMachineRunCommandScriptSource The source of the run command script.
parameters	list[RunCommandInputParameter] The parameters used by the script.
protected_parameters	list[RunCommandInputParameter] The parameters used by the script.
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.
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. 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.
error_blob_uri	str 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.
output_blob_managed_identity	RunCommandManagedIdentity 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.
error_blob_managed_identity	RunCommandManagedIdentity 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.
treat_failure_as_deployment_failure	bool Optional. If set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results.

Variables

Name	Description
id	str Resource Id.
name	str Resource name.
type	str Resource type.
location	str Resource location. Required.
tags	dict[str, str] Resource tags.
source	VirtualMachineRunCommandScriptSource The source of the run command script.
parameters	list[RunCommandInputParameter] The parameters used by the script.
protected_parameters	list[RunCommandInputParameter] The parameters used by the script.
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.
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. 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.
error_blob_uri	str 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.
output_blob_managed_identity	RunCommandManagedIdentity 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.
error_blob_managed_identity	RunCommandManagedIdentity 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.
provisioning_state	str The provisioning state, which only appears in the response. If treatFailureAsDeploymentFailure set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If treatFailureAsDeploymentFailure set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results.
instance_view	VirtualMachineRunCommandInstanceView The virtual machine run command instance view.
treat_failure_as_deployment_failure	bool Optional. If set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results.