VirtualMachineRunCommandUpdate Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Describes a Virtual Machine run command.
public class VirtualMachineRunCommandUpdate : Azure.ResourceManager.Compute.Models.ComputeResourcePatch, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Compute.Models.VirtualMachineRunCommandUpdate>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Compute.Models.VirtualMachineRunCommandUpdate>type VirtualMachineRunCommandUpdate = class
inherit ComputeResourcePatch
interface IJsonModel<VirtualMachineRunCommandUpdate>
interface IPersistableModel<VirtualMachineRunCommandUpdate>Public Class VirtualMachineRunCommandUpdate
Inherits ComputeResourcePatch
Implements IJsonModel(Of VirtualMachineRunCommandUpdate), IPersistableModel(Of VirtualMachineRunCommandUpdate)- Inheritance
- Implements
Constructors
| VirtualMachineRunCommandUpdate() |
Initializes a new instance of VirtualMachineRunCommandUpdate. |
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. |
| 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. |
| 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. |
| Tags |
Resource tags. (Inherited from ComputeResourcePatch) |
| 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. |
Methods
| JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) | |
| JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) | (Inherited from ComputeResourcePatch) |
