VirtualMachineRunCommandProperties Class

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

async_execution: bool | None

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_managed_identity: _models.RunCommandManagedIdentity | None

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.

error_blob_uri: str | None

The virtual machine run command instance view.

instance_view: _models.VirtualMachineRunCommandInstanceView | None

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_managed_identity: _models.RunCommandManagedIdentity | None

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.

output_blob_uri: str | None

The parameters used by the script.

parameters: list['_models.RunCommandInputParameter'] | None

The parameters used by the script.

protected_parameters: list['_models.RunCommandInputParameter'] | None

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.

provisioning_state: str | None

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

run_as_password: str | None

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

run_as_user: str | None

The source of the run command script.

source: _models.VirtualMachineRunCommandScriptSource | None

The timeout in seconds to execute the run command.

timeout_in_seconds: int | None

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.

treat_failure_as_deployment_failure: bool | None