VirtualMachineRunCommandUpdate interface

Describes a Virtual Machine run command.

Extends

Properties

asyncExecution

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

errorBlobManagedIdentity

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

errorBlobUri

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.

instanceView

The virtual machine run command instance view. NOTE: This property will not be serialized. It can only be populated by the server.

outputBlobManagedIdentity

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

outputBlobUri

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.

parameters

The parameters used by the script.

protectedParameters

The parameters used by the script.

provisioningState

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 NOTE: This property will not be serialized. It can only be populated by the server.

runAsPassword

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

runAsUser

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

source

The source of the run command script.

timeoutInSeconds

The timeout in seconds to execute the run command.

treatFailureAsDeploymentFailure

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

Inherited Properties

tags

Resource tags

Property Details

asyncExecution

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

asyncExecution?: boolean

Property Value

boolean

errorBlobManagedIdentity

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

errorBlobManagedIdentity?: RunCommandManagedIdentity

Property Value

errorBlobUri

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.

errorBlobUri?: string

Property Value

string

instanceView

The virtual machine run command instance view. NOTE: This property will not be serialized. It can only be populated by the server.

instanceView?: VirtualMachineRunCommandInstanceView

Property Value

outputBlobManagedIdentity

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

outputBlobManagedIdentity?: RunCommandManagedIdentity

Property Value

outputBlobUri

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.

outputBlobUri?: string

Property Value

string

parameters

The parameters used by the script.

parameters?: RunCommandInputParameter[]

Property Value

protectedParameters

The parameters used by the script.

protectedParameters?: RunCommandInputParameter[]

Property Value

provisioningState

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 NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

runAsPassword

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

runAsPassword?: string

Property Value

string

runAsUser

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

runAsUser?: string

Property Value

string

source

The source of the run command script.

source?: VirtualMachineRunCommandScriptSource

Property Value

timeoutInSeconds

The timeout in seconds to execute the run command.

timeoutInSeconds?: number

Property Value

number

treatFailureAsDeploymentFailure

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

treatFailureAsDeploymentFailure?: boolean

Property Value

boolean

Inherited Property Details

tags

Resource tags

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From UpdateResource.tags