GetVirtualMachineRunCommandByVirtualMachineResult

data class GetVirtualMachineRunCommandByVirtualMachineResult(val asyncExecution: Boolean? = null, val errorBlobManagedIdentity: RunCommandManagedIdentityResponse? = null, val errorBlobUri: String? = null, val id: String, val instanceView: VirtualMachineRunCommandInstanceViewResponse, val location: String, val name: String, val outputBlobManagedIdentity: RunCommandManagedIdentityResponse? = null, val outputBlobUri: String? = null, val parameters: List<RunCommandInputParameterResponse>? = null, val protectedParameters: List<RunCommandInputParameterResponse>? = null, val provisioningState: String, val runAsPassword: String? = null, val runAsUser: String? = null, val source: VirtualMachineRunCommandScriptSourceResponse? = null, val tags: Map<String, String>? = null, val timeoutInSeconds: Int? = null, val treatFailureAsDeploymentFailure: Boolean? = null, val type: String)

Describes a Virtual Machine run command.

Constructors

constructor(asyncExecution: Boolean? = null, errorBlobManagedIdentity: RunCommandManagedIdentityResponse? = null, errorBlobUri: String? = null, id: String, instanceView: VirtualMachineRunCommandInstanceViewResponse, location: String, name: String, outputBlobManagedIdentity: RunCommandManagedIdentityResponse? = null, outputBlobUri: String? = null, parameters: List<RunCommandInputParameterResponse>? = null, protectedParameters: List<RunCommandInputParameterResponse>? = null, provisioningState: String, runAsPassword: String? = null, runAsUser: String? = null, source: VirtualMachineRunCommandScriptSourceResponse? = null, tags: Map<String, String>? = null, timeoutInSeconds: Int? = null, treatFailureAsDeploymentFailure: Boolean? = null, type: String)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val asyncExecution: Boolean? = null

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

Link copied to clipboard

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

Link copied to clipboard
val errorBlobUri: String? = null

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.

Link copied to clipboard
val id: String

Resource Id

Link copied to clipboard

The virtual machine run command instance view.

Link copied to clipboard

Resource location

Link copied to clipboard

Resource name

Link copied to clipboard

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

Link copied to clipboard
val outputBlobUri: String? = null

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.

Link copied to clipboard

The parameters used by the script.

Link copied to clipboard

The parameters used by the script.

Link copied to clipboard

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

Link copied to clipboard
val runAsPassword: String? = null

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

Link copied to clipboard
val runAsUser: String? = null

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

Link copied to clipboard

The source of the run command script.

Link copied to clipboard
val tags: Map<String, String>? = null

Resource tags

Link copied to clipboard
val timeoutInSeconds: Int? = null

The timeout in seconds to execute the run command.

Link copied to clipboard

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

Link copied to clipboard

Resource type