VirtualMachineRunCommand Constructors
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.
Overloads
| 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, String, VirtualMachineRunCommandInstanceView) |
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()
Initializes a new instance of the VirtualMachineRunCommand class.
public VirtualMachineRunCommand ();Public Sub New ()Applies to
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.
public VirtualMachineRunCommand (string location, string id, string name, string type, System.Collections.Generic.IDictionary<string,string> tags, Microsoft.Azure.Management.Compute.Models.VirtualMachineRunCommandScriptSource source, System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.RunCommandInputParameter> parameters, System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.RunCommandInputParameter> protectedParameters, bool? asyncExecution, string runAsUser, string runAsPassword, int? timeoutInSeconds, string outputBlobUri, string errorBlobUri, string provisioningState, Microsoft.Azure.Management.Compute.Models.VirtualMachineRunCommandInstanceView instanceView);new Microsoft.Azure.Management.Compute.Models.VirtualMachineRunCommand : string * string * string * string * System.Collections.Generic.IDictionary<string, string> * Microsoft.Azure.Management.Compute.Models.VirtualMachineRunCommandScriptSource * System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.RunCommandInputParameter> * System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.RunCommandInputParameter> * Nullable<bool> * string * string * Nullable<int> * string * string * string * Microsoft.Azure.Management.Compute.Models.VirtualMachineRunCommandInstanceView -> Microsoft.Azure.Management.Compute.Models.VirtualMachineRunCommandPublic Sub New (location As String, id As String, name As String, type As String, tags As IDictionary(Of String, String), source As VirtualMachineRunCommandScriptSource, parameters As IList(Of RunCommandInputParameter), protectedParameters As IList(Of RunCommandInputParameter), asyncExecution As Nullable(Of Boolean), runAsUser As String, runAsPassword As String, timeoutInSeconds As Nullable(Of Integer), outputBlobUri As String, errorBlobUri As String, provisioningState As String, instanceView As VirtualMachineRunCommandInstanceView)Parameters
- location
- String
Resource location
- id
- String
Resource Id
- name
- String
Resource name
- type
- String
Resource type
- tags
- IDictionary<String,String>
Resource tags
The source of the run command script.
- parameters
- IList<RunCommandInputParameter>
The parameters used by the script.
- protectedParameters
- IList<RunCommandInputParameter>
The parameters used by the script.
Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete.
- runAsUser
- String
Specifies the user account on the VM when executing the run command.
- runAsPassword
- String
Specifies the user account password on the VM when executing the run command.
- outputBlobUri
- String
Specifies the Azure storage blob where script output stream will be uploaded.
- errorBlobUri
- String
Specifies the Azure storage blob where script error stream will be uploaded.
- provisioningState
- String
The provisioning state, which only appears in the response.
- instanceView
- VirtualMachineRunCommandInstanceView
The virtual machine run command instance view.
Applies to
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.
public VirtualMachineRunCommand (string location, string id = default, string name = default, string type = default, System.Collections.Generic.IDictionary<string,string> tags = default, Microsoft.Azure.Management.Compute.Models.VirtualMachineRunCommandScriptSource source = default, System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.RunCommandInputParameter> parameters = default, System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.RunCommandInputParameter> protectedParameters = default, bool? asyncExecution = default, string runAsUser = default, string runAsPassword = default, int? timeoutInSeconds = default, string outputBlobUri = default, string errorBlobUri = default, Microsoft.Azure.Management.Compute.Models.RunCommandManagedIdentity outputBlobManagedIdentity = default, Microsoft.Azure.Management.Compute.Models.RunCommandManagedIdentity errorBlobManagedIdentity = default, string provisioningState = default, Microsoft.Azure.Management.Compute.Models.VirtualMachineRunCommandInstanceView instanceView = default, bool? treatFailureAsDeploymentFailure = default);new Microsoft.Azure.Management.Compute.Models.VirtualMachineRunCommand : string * string * string * string * System.Collections.Generic.IDictionary<string, string> * Microsoft.Azure.Management.Compute.Models.VirtualMachineRunCommandScriptSource * System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.RunCommandInputParameter> * System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.RunCommandInputParameter> * Nullable<bool> * string * string * Nullable<int> * string * string * Microsoft.Azure.Management.Compute.Models.RunCommandManagedIdentity * Microsoft.Azure.Management.Compute.Models.RunCommandManagedIdentity * string * Microsoft.Azure.Management.Compute.Models.VirtualMachineRunCommandInstanceView * Nullable<bool> -> Microsoft.Azure.Management.Compute.Models.VirtualMachineRunCommandPublic Sub New (location As String, Optional id As String = Nothing, Optional name As String = Nothing, Optional type As String = Nothing, Optional tags As IDictionary(Of String, String) = Nothing, Optional source As VirtualMachineRunCommandScriptSource = Nothing, Optional parameters As IList(Of RunCommandInputParameter) = Nothing, Optional protectedParameters As IList(Of RunCommandInputParameter) = Nothing, Optional asyncExecution As Nullable(Of Boolean) = Nothing, Optional runAsUser As String = Nothing, Optional runAsPassword As String = Nothing, Optional timeoutInSeconds As Nullable(Of Integer) = Nothing, Optional outputBlobUri As String = Nothing, Optional errorBlobUri As String = Nothing, Optional outputBlobManagedIdentity As RunCommandManagedIdentity = Nothing, Optional errorBlobManagedIdentity As RunCommandManagedIdentity = Nothing, Optional provisioningState As String = Nothing, Optional instanceView As VirtualMachineRunCommandInstanceView = Nothing, Optional treatFailureAsDeploymentFailure As Nullable(Of Boolean) = Nothing)Parameters
- location
- String
Resource location
- id
- String
Resource Id
- name
- String
Resource name
- type
- String
Resource type
- tags
- IDictionary<String,String>
Resource tags
The source of the run command script.
- parameters
- IList<RunCommandInputParameter>
The parameters used by the script.
- protectedParameters
- IList<RunCommandInputParameter>
The parameters used by the script.
Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete.
- runAsUser
- String
Specifies the user account on the VM when executing the run command.
- runAsPassword
- String
Specifies the user account password on the VM when executing the run command.
- outputBlobUri
- String
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.
- errorBlobUri
- String
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.
- outputBlobManagedIdentity
- RunCommandManagedIdentity
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
- errorBlobManagedIdentity
- RunCommandManagedIdentity
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
- provisioningState
- String
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
- instanceView
- VirtualMachineRunCommandInstanceView
The virtual machine run command instance view.
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
Applies to
Azure SDK for .NET