Share via


VirtualMachineRunCommand Class

Definition

Describes a Virtual Machine run command.

[Microsoft.Rest.Serialization.JsonTransformation]
public class VirtualMachineRunCommand : Microsoft.Azure.Management.Compute.Models.Resource
[<Microsoft.Rest.Serialization.JsonTransformation>]
type VirtualMachineRunCommand = class
    inherit Resource
Public Class VirtualMachineRunCommand
Inherits Resource
Inheritance
VirtualMachineRunCommand
Attributes

Constructors

VirtualMachineRunCommand()

Initializes a new instance of the VirtualMachineRunCommand class.

VirtualMachineRunCommand(String, String, String, String, IDictionary<String, String>, VirtualMachineRunCommandScriptSource, IList<RunCommandInputParameter>, IList<RunCommandInputParameter>, Nullable<Boolean>, String, String, Nullable<Int32>, String, String, RunCommandManagedIdentity, RunCommandManagedIdentity, String, VirtualMachineRunCommandInstanceView, Nullable<Boolean>)

Initializes a new instance of the VirtualMachineRunCommand class.

VirtualMachineRunCommand(String, String, String, String, IDictionary<String, String>, VirtualMachineRunCommandScriptSource, IList<RunCommandInputParameter>, IList<RunCommandInputParameter>, Nullable<Boolean>, String, String, Nullable<Int32>, String, String, String, VirtualMachineRunCommandInstanceView)

Initializes a new instance of the VirtualMachineRunCommand class.

Properties

AsyncExecution

Gets or sets optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete.

ErrorBlobManagedIdentity

Gets or sets 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

Gets or sets 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.

Id

Gets resource Id

(Inherited from Resource)
InstanceView

Gets the virtual machine run command instance view.

Location

Gets or sets resource location

(Inherited from Resource)
Name

Gets resource name

(Inherited from Resource)
OutputBlobManagedIdentity

Gets or sets 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

Gets or sets 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

Gets or sets the parameters used by the script.

ProtectedParameters

Gets or sets the parameters used by the script.

ProvisioningState

Gets 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

Gets or sets specifies the user account password on the VM when executing the run command.

RunAsUser

Gets or sets specifies the user account on the VM when executing the run command.

Source

Gets or sets the source of the run command script.

Tags

Gets or sets resource tags

(Inherited from Resource)
TimeoutInSeconds

Gets or sets the timeout in seconds to execute the run command.

TreatFailureAsDeploymentFailure

Gets or sets 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

Type

Gets resource type

(Inherited from Resource)

Methods

Validate()

Validate the object.

Applies to