Share via


VirtualMachine Constructors

Definition

Overloads

VirtualMachine()

Initializes a new instance of the VirtualMachine class.

VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String, Nullable<Int32>, ScheduledEventsProfile, String, CapacityReservationProfile, ApplicationProfile, Nullable<DateTime>, IList<VirtualMachineExtension>, VirtualMachineIdentity, IList<String>, ExtendedLocation)

Initializes a new instance of the VirtualMachine class.

VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String, Nullable<Int32>, ScheduledEventsProfile, String, CapacityReservationProfile, ApplicationProfile, IList<VirtualMachineExtension>, VirtualMachineIdentity, IList<String>, ExtendedLocation)

Initializes a new instance of the VirtualMachine class.

VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String, Nullable<Int32>, ScheduledEventsProfile, String, CapacityReservationProfile, IList<VirtualMachineExtension>, VirtualMachineIdentity, IList<String>, ExtendedLocation)

Initializes a new instance of the VirtualMachine class.

VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String, Nullable<Int32>, ScheduledEventsProfile, String, IList<VirtualMachineExtension>, VirtualMachineIdentity, IList<String>, ExtendedLocation)

Initializes a new instance of the VirtualMachine class.

VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String, Nullable<Int32>, ScheduledEventsProfile, String, CapacityReservationProfile, IList<VirtualMachineExtension>, VirtualMachineIdentity, IList<String>)
VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String, Nullable<Int32>, ScheduledEventsProfile, String, IList<VirtualMachineExtension>, VirtualMachineIdentity, IList<String>)
VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String, Nullable<Int32>, ScheduledEventsProfile, String, CapacityReservationProfile, IList<VirtualMachineExtension>, VirtualMachineIdentity)
VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String, Nullable<Int32>, ScheduledEventsProfile, String, IList<VirtualMachineExtension>, VirtualMachineIdentity)
VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String, Nullable<Int32>, ScheduledEventsProfile, String, CapacityReservationProfile, IList<VirtualMachineExtension>)
VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String, Nullable<Int32>, ScheduledEventsProfile, IList<VirtualMachineExtension>, VirtualMachineIdentity, IList<String>, ExtendedLocation)

Initializes a new instance of the VirtualMachine class.

VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String, Nullable<Int32>, ScheduledEventsProfile, IList<VirtualMachineExtension>, VirtualMachineIdentity)

Initializes a new instance of the VirtualMachine class.

VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String, Nullable<Int32>, ScheduledEventsProfile, IList<VirtualMachineExtension>)

Initializes a new instance of the VirtualMachine class.

VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String, IList<VirtualMachineExtension>, VirtualMachineIdentity, IList<String>)

Initializes a new instance of the VirtualMachine class.

VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String, Nullable<Int32>, ScheduledEventsProfile)

Initializes a new instance of the VirtualMachine class.

VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String, IList<VirtualMachineExtension>, VirtualMachineIdentity)
VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String, Nullable<Int32>)
VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String, IList<VirtualMachineExtension>)

Initializes a new instance of the VirtualMachine class.

VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String)
VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String, Nullable<Int32>, ScheduledEventsProfile, IList<VirtualMachineExtension>, VirtualMachineIdentity, IList<String>)

Initializes a new instance of the VirtualMachine class.

VirtualMachine()

Initializes a new instance of the VirtualMachine class.

public VirtualMachine ();
Public Sub New ()

Applies to

VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String, Nullable<Int32>, ScheduledEventsProfile, String, CapacityReservationProfile, ApplicationProfile, Nullable<DateTime>, IList<VirtualMachineExtension>, VirtualMachineIdentity, IList<String>, ExtendedLocation)

Initializes a new instance of the VirtualMachine class.

public VirtualMachine (string location, string id = default, string name = default, string type = default, System.Collections.Generic.IDictionary<string,string> tags = default, Microsoft.Azure.Management.Compute.Models.Plan plan = default, Microsoft.Azure.Management.Compute.Models.HardwareProfile hardwareProfile = default, Microsoft.Azure.Management.Compute.Models.StorageProfile storageProfile = default, Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities additionalCapabilities = default, Microsoft.Azure.Management.Compute.Models.OSProfile osProfile = default, Microsoft.Azure.Management.Compute.Models.NetworkProfile networkProfile = default, Microsoft.Azure.Management.Compute.Models.SecurityProfile securityProfile = default, Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile diagnosticsProfile = default, Microsoft.Azure.Management.Compute.Models.SubResource availabilitySet = default, Microsoft.Azure.Management.Compute.Models.SubResource virtualMachineScaleSet = default, Microsoft.Azure.Management.Compute.Models.SubResource proximityPlacementGroup = default, string priority = default, string evictionPolicy = default, Microsoft.Azure.Management.Compute.Models.BillingProfile billingProfile = default, Microsoft.Azure.Management.Compute.Models.SubResource host = default, Microsoft.Azure.Management.Compute.Models.SubResource hostGroup = default, string provisioningState = default, Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView instanceView = default, string licenseType = default, string vmId = default, string extensionsTimeBudget = default, int? platformFaultDomain = default, Microsoft.Azure.Management.Compute.Models.ScheduledEventsProfile scheduledEventsProfile = default, string userData = default, Microsoft.Azure.Management.Compute.Models.CapacityReservationProfile capacityReservation = default, Microsoft.Azure.Management.Compute.Models.ApplicationProfile applicationProfile = default, DateTime? timeCreated = default, System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension> resources = default, Microsoft.Azure.Management.Compute.Models.VirtualMachineIdentity identity = default, System.Collections.Generic.IList<string> zones = default, Microsoft.Azure.Management.Compute.Models.ExtendedLocation extendedLocation = default);
new Microsoft.Azure.Management.Compute.Models.VirtualMachine : string * string * string * string * System.Collections.Generic.IDictionary<string, string> * Microsoft.Azure.Management.Compute.Models.Plan * Microsoft.Azure.Management.Compute.Models.HardwareProfile * Microsoft.Azure.Management.Compute.Models.StorageProfile * Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities * Microsoft.Azure.Management.Compute.Models.OSProfile * Microsoft.Azure.Management.Compute.Models.NetworkProfile * Microsoft.Azure.Management.Compute.Models.SecurityProfile * Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * string * Microsoft.Azure.Management.Compute.Models.BillingProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView * string * string * string * Nullable<int> * Microsoft.Azure.Management.Compute.Models.ScheduledEventsProfile * string * Microsoft.Azure.Management.Compute.Models.CapacityReservationProfile * Microsoft.Azure.Management.Compute.Models.ApplicationProfile * Nullable<DateTime> * System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension> * Microsoft.Azure.Management.Compute.Models.VirtualMachineIdentity * System.Collections.Generic.IList<string> * Microsoft.Azure.Management.Compute.Models.ExtendedLocation -> Microsoft.Azure.Management.Compute.Models.VirtualMachine
Public 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 plan As Plan = Nothing, Optional hardwareProfile As HardwareProfile = Nothing, Optional storageProfile As StorageProfile = Nothing, Optional additionalCapabilities As AdditionalCapabilities = Nothing, Optional osProfile As OSProfile = Nothing, Optional networkProfile As NetworkProfile = Nothing, Optional securityProfile As SecurityProfile = Nothing, Optional diagnosticsProfile As DiagnosticsProfile = Nothing, Optional availabilitySet As SubResource = Nothing, Optional virtualMachineScaleSet As SubResource = Nothing, Optional proximityPlacementGroup As SubResource = Nothing, Optional priority As String = Nothing, Optional evictionPolicy As String = Nothing, Optional billingProfile As BillingProfile = Nothing, Optional host As SubResource = Nothing, Optional hostGroup As SubResource = Nothing, Optional provisioningState As String = Nothing, Optional instanceView As VirtualMachineInstanceView = Nothing, Optional licenseType As String = Nothing, Optional vmId As String = Nothing, Optional extensionsTimeBudget As String = Nothing, Optional platformFaultDomain As Nullable(Of Integer) = Nothing, Optional scheduledEventsProfile As ScheduledEventsProfile = Nothing, Optional userData As String = Nothing, Optional capacityReservation As CapacityReservationProfile = Nothing, Optional applicationProfile As ApplicationProfile = Nothing, Optional timeCreated As Nullable(Of DateTime) = Nothing, Optional resources As IList(Of VirtualMachineExtension) = Nothing, Optional identity As VirtualMachineIdentity = Nothing, Optional zones As IList(Of String) = Nothing, Optional extendedLocation As ExtendedLocation = Nothing)

Parameters

location
String

Resource location

id
String

Resource Id

name
String

Resource name

type
String

Resource type

tags
IDictionary<String,String>

Resource tags

plan
Plan

Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.

hardwareProfile
HardwareProfile

Specifies the hardware settings for the virtual machine.

storageProfile
StorageProfile

Specifies the storage settings for the virtual machine disks.

additionalCapabilities
AdditionalCapabilities

Specifies additional capabilities enabled or disabled on the virtual machine.

osProfile
OSProfile

Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned.

networkProfile
NetworkProfile

Specifies the network interfaces of the virtual machine.

securityProfile
SecurityProfile

Specifies the Security related profile settings for the virtual machine.

diagnosticsProfile
DiagnosticsProfile

Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.

availabilitySet
SubResource

Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Availability sets overview. For more information on Azure planned maintenance, see Maintenance and updates for Virtual Machines in Azure. Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. This property cannot exist along with a non-null properties.virtualMachineScaleSet reference.

virtualMachineScaleSet
SubResource

Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. This property cannot exist along with a non-null properties.availabilitySet reference. Minimum api‐version: 2019‐03‐01.

proximityPlacementGroup
SubResource

Specifies information about the proximity placement group that the virtual machine should be assigned to. Minimum api-version: 2018-04-01.

priority
String

Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01. Possible values include: 'Regular', 'Low', 'Spot'

evictionPolicy
String

Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. Possible values include: 'Deallocate', 'Delete'

billingProfile
BillingProfile

Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 2019-03-01.

host
SubResource

Specifies information about the dedicated host that the virtual machine resides in. Minimum api-version: 2018-10-01.

hostGroup
SubResource

Specifies information about the dedicated host group that the virtual machine resides in. Note: User cannot specify both host and hostGroup properties. Minimum api-version: 2020-06-01.

provisioningState
String

The provisioning state, which only appears in the response.

instanceView
VirtualMachineInstanceView

The virtual machine instance view.

licenseType
String

Specifies that the image or disk that is being used was licensed on-premises. <br><br> Possible values for Windows Server operating system are: <br><br> Windows_Client <br><br> Windows_Server <br><br> Possible values for Linux Server operating system are: <br><br> RHEL_BYOS (for RHEL) <br><br> SLES_BYOS (for SUSE) <br><br> For more information, see Azure Hybrid Use Benefit for Windows Server <br><br> Azure Hybrid Use Benefit for Linux Server <br><br> Minimum api-version: 2015-06-15

vmId
String

Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands.

extensionsTimeBudget
String

Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01.

platformFaultDomain
Nullable<Int32>

Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains. This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set. The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' greater than 1. This property cannot be updated once the Virtual Machine is created. Fault domain assignment can be viewed in the Virtual Machine Instance View. Minimum api‐version: 2020‐12‐01.

scheduledEventsProfile
ScheduledEventsProfile

Specifies Scheduled Event related configurations.

userData
String

UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01.

capacityReservation
CapacityReservationProfile

Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01.

applicationProfile
ApplicationProfile

Specifies the gallery applications that should be made available to the VM/VMSS.

timeCreated
Nullable<DateTime>

Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01.

resources
IList<VirtualMachineExtension>

The virtual machine child extension resources.

identity
VirtualMachineIdentity

The identity of the virtual machine, if configured.

zones
IList<String>

The virtual machine zones.

extendedLocation
ExtendedLocation

The extended location of the Virtual Machine.

Applies to

VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String, Nullable<Int32>, ScheduledEventsProfile, String, CapacityReservationProfile, ApplicationProfile, IList<VirtualMachineExtension>, VirtualMachineIdentity, IList<String>, ExtendedLocation)

Initializes a new instance of the VirtualMachine class.

public VirtualMachine (string location, string id, string name, string type, System.Collections.Generic.IDictionary<string,string> tags, Microsoft.Azure.Management.Compute.Models.Plan plan, Microsoft.Azure.Management.Compute.Models.HardwareProfile hardwareProfile, Microsoft.Azure.Management.Compute.Models.StorageProfile storageProfile, Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities additionalCapabilities, Microsoft.Azure.Management.Compute.Models.OSProfile osProfile, Microsoft.Azure.Management.Compute.Models.NetworkProfile networkProfile, Microsoft.Azure.Management.Compute.Models.SecurityProfile securityProfile, Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile diagnosticsProfile, Microsoft.Azure.Management.Compute.Models.SubResource availabilitySet, Microsoft.Azure.Management.Compute.Models.SubResource virtualMachineScaleSet, Microsoft.Azure.Management.Compute.Models.SubResource proximityPlacementGroup, string priority, string evictionPolicy, Microsoft.Azure.Management.Compute.Models.BillingProfile billingProfile, Microsoft.Azure.Management.Compute.Models.SubResource host, Microsoft.Azure.Management.Compute.Models.SubResource hostGroup, string provisioningState, Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView instanceView, string licenseType, string vmId, string extensionsTimeBudget, int? platformFaultDomain, Microsoft.Azure.Management.Compute.Models.ScheduledEventsProfile scheduledEventsProfile, string userData, Microsoft.Azure.Management.Compute.Models.CapacityReservationProfile capacityReservation, Microsoft.Azure.Management.Compute.Models.ApplicationProfile applicationProfile, System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension> resources, Microsoft.Azure.Management.Compute.Models.VirtualMachineIdentity identity = default, System.Collections.Generic.IList<string> zones = default, Microsoft.Azure.Management.Compute.Models.ExtendedLocation extendedLocation = default);
new Microsoft.Azure.Management.Compute.Models.VirtualMachine : string * string * string * string * System.Collections.Generic.IDictionary<string, string> * Microsoft.Azure.Management.Compute.Models.Plan * Microsoft.Azure.Management.Compute.Models.HardwareProfile * Microsoft.Azure.Management.Compute.Models.StorageProfile * Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities * Microsoft.Azure.Management.Compute.Models.OSProfile * Microsoft.Azure.Management.Compute.Models.NetworkProfile * Microsoft.Azure.Management.Compute.Models.SecurityProfile * Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * string * Microsoft.Azure.Management.Compute.Models.BillingProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView * string * string * string * Nullable<int> * Microsoft.Azure.Management.Compute.Models.ScheduledEventsProfile * string * Microsoft.Azure.Management.Compute.Models.CapacityReservationProfile * Microsoft.Azure.Management.Compute.Models.ApplicationProfile * System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension> * Microsoft.Azure.Management.Compute.Models.VirtualMachineIdentity * System.Collections.Generic.IList<string> * Microsoft.Azure.Management.Compute.Models.ExtendedLocation -> Microsoft.Azure.Management.Compute.Models.VirtualMachine
Public Sub New (location As String, id As String, name As String, type As String, tags As IDictionary(Of String, String), plan As Plan, hardwareProfile As HardwareProfile, storageProfile As StorageProfile, additionalCapabilities As AdditionalCapabilities, osProfile As OSProfile, networkProfile As NetworkProfile, securityProfile As SecurityProfile, diagnosticsProfile As DiagnosticsProfile, availabilitySet As SubResource, virtualMachineScaleSet As SubResource, proximityPlacementGroup As SubResource, priority As String, evictionPolicy As String, billingProfile As BillingProfile, host As SubResource, hostGroup As SubResource, provisioningState As String, instanceView As VirtualMachineInstanceView, licenseType As String, vmId As String, extensionsTimeBudget As String, platformFaultDomain As Nullable(Of Integer), scheduledEventsProfile As ScheduledEventsProfile, userData As String, capacityReservation As CapacityReservationProfile, applicationProfile As ApplicationProfile, resources As IList(Of VirtualMachineExtension), Optional identity As VirtualMachineIdentity = Nothing, Optional zones As IList(Of String) = Nothing, Optional extendedLocation As ExtendedLocation = Nothing)

Parameters

location
String

Resource location

id
String

Resource Id

name
String

Resource name

type
String

Resource type

tags
IDictionary<String,String>

Resource tags

plan
Plan

Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.

hardwareProfile
HardwareProfile

Specifies the hardware settings for the virtual machine.

storageProfile
StorageProfile

Specifies the storage settings for the virtual machine disks.

additionalCapabilities
AdditionalCapabilities

Specifies additional capabilities enabled or disabled on the virtual machine.

osProfile
OSProfile

Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned.

networkProfile
NetworkProfile

Specifies the network interfaces of the virtual machine.

securityProfile
SecurityProfile

Specifies the Security related profile settings for the virtual machine.

diagnosticsProfile
DiagnosticsProfile

Specifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15.

availabilitySet
SubResource

Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Availability sets overview. <br><br> For more information on Azure planned maintenance, see Maintenance and updates for Virtual Machines in Azure <br><br> Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. <br><br>This property cannot exist along with a non-null properties.virtualMachineScaleSet reference.

virtualMachineScaleSet
SubResource

Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. <br><br>This property cannot exist along with a non-null properties.availabilitySet reference. <br><br>Minimum api‐version: 2019‐03‐01

proximityPlacementGroup
SubResource

Specifies information about the proximity placement group that the virtual machine should be assigned to. <br><br>Minimum api-version: 2018-04-01.

priority
String

Specifies the priority for the virtual machine. <br><br>Minimum api-version: 2019-03-01. Possible values include: 'Regular', 'Low', 'Spot'

evictionPolicy
String

Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. <br><br>For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. <br><br>For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. Possible values include: 'Deallocate', 'Delete'

billingProfile
BillingProfile

Specifies the billing related details of a Azure Spot virtual machine. <br><br>Minimum api-version: 2019-03-01.

host
SubResource

Specifies information about the dedicated host that the virtual machine resides in. <br><br>Minimum api-version: 2018-10-01.

hostGroup
SubResource

Specifies information about the dedicated host group that the virtual machine resides in. <br><br>Minimum api-version: 2020-06-01. <br><br>NOTE: User cannot specify both host and hostGroup properties.

provisioningState
String

The provisioning state, which only appears in the response.

instanceView
VirtualMachineInstanceView

The virtual machine instance view.

licenseType
String

Specifies that the image or disk that is being used was licensed on-premises. <br><br> Possible values for Windows Server operating system are: <br><br> Windows_Client <br><br> Windows_Server <br><br> Possible values for Linux Server operating system are: <br><br> RHEL_BYOS (for RHEL) <br><br> SLES_BYOS (for SUSE) <br><br> For more information, see Azure Hybrid Use Benefit for Windows Server <br><br> Azure Hybrid Use Benefit for Linux Server <br><br> Minimum api-version: 2015-06-15

vmId
String

Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands.

extensionsTimeBudget
String

Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). <br><br> Minimum api-version: 2020-06-01

platformFaultDomain
Nullable<Int32>

Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains.<br><li>This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set.<li>The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' &gt; 1.<li>This property cannot be updated once the Virtual Machine is created.<li>Fault domain assignment can be viewed in the Virtual Machine Instance View.<br><br>Minimum api‐version: 2020‐12‐01

scheduledEventsProfile
ScheduledEventsProfile

Specifies Scheduled Event related configurations.

userData
String

UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. <br><br>Minimum api-version: 2021-03-01

capacityReservation
CapacityReservationProfile

Specifies information about the capacity reservation that is used to allocate virtual machine. <br><br>Minimum api-version: 2021-04-01.

applicationProfile
ApplicationProfile

Specifies the gallery applications that should be made available to the VM/VMSS

resources
IList<VirtualMachineExtension>

The virtual machine child extension resources.

identity
VirtualMachineIdentity

The identity of the virtual machine, if configured.

zones
IList<String>

The virtual machine zones.

extendedLocation
ExtendedLocation

The extended location of the Virtual Machine.

Applies to

VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String, Nullable<Int32>, ScheduledEventsProfile, String, CapacityReservationProfile, IList<VirtualMachineExtension>, VirtualMachineIdentity, IList<String>, ExtendedLocation)

Initializes a new instance of the VirtualMachine class.

public VirtualMachine (string location, string id, string name, string type, System.Collections.Generic.IDictionary<string,string> tags, Microsoft.Azure.Management.Compute.Models.Plan plan, Microsoft.Azure.Management.Compute.Models.HardwareProfile hardwareProfile, Microsoft.Azure.Management.Compute.Models.StorageProfile storageProfile, Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities additionalCapabilities, Microsoft.Azure.Management.Compute.Models.OSProfile osProfile, Microsoft.Azure.Management.Compute.Models.NetworkProfile networkProfile, Microsoft.Azure.Management.Compute.Models.SecurityProfile securityProfile, Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile diagnosticsProfile, Microsoft.Azure.Management.Compute.Models.SubResource availabilitySet, Microsoft.Azure.Management.Compute.Models.SubResource virtualMachineScaleSet, Microsoft.Azure.Management.Compute.Models.SubResource proximityPlacementGroup, string priority, string evictionPolicy, Microsoft.Azure.Management.Compute.Models.BillingProfile billingProfile, Microsoft.Azure.Management.Compute.Models.SubResource host, Microsoft.Azure.Management.Compute.Models.SubResource hostGroup, string provisioningState, Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView instanceView, string licenseType, string vmId, string extensionsTimeBudget, int? platformFaultDomain, Microsoft.Azure.Management.Compute.Models.ScheduledEventsProfile scheduledEventsProfile, string userData, Microsoft.Azure.Management.Compute.Models.CapacityReservationProfile capacityReservation, System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension> resources, Microsoft.Azure.Management.Compute.Models.VirtualMachineIdentity identity, System.Collections.Generic.IList<string> zones, Microsoft.Azure.Management.Compute.Models.ExtendedLocation extendedLocation);
new Microsoft.Azure.Management.Compute.Models.VirtualMachine : string * string * string * string * System.Collections.Generic.IDictionary<string, string> * Microsoft.Azure.Management.Compute.Models.Plan * Microsoft.Azure.Management.Compute.Models.HardwareProfile * Microsoft.Azure.Management.Compute.Models.StorageProfile * Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities * Microsoft.Azure.Management.Compute.Models.OSProfile * Microsoft.Azure.Management.Compute.Models.NetworkProfile * Microsoft.Azure.Management.Compute.Models.SecurityProfile * Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * string * Microsoft.Azure.Management.Compute.Models.BillingProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView * string * string * string * Nullable<int> * Microsoft.Azure.Management.Compute.Models.ScheduledEventsProfile * string * Microsoft.Azure.Management.Compute.Models.CapacityReservationProfile * System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension> * Microsoft.Azure.Management.Compute.Models.VirtualMachineIdentity * System.Collections.Generic.IList<string> * Microsoft.Azure.Management.Compute.Models.ExtendedLocation -> Microsoft.Azure.Management.Compute.Models.VirtualMachine
Public Sub New (location As String, id As String, name As String, type As String, tags As IDictionary(Of String, String), plan As Plan, hardwareProfile As HardwareProfile, storageProfile As StorageProfile, additionalCapabilities As AdditionalCapabilities, osProfile As OSProfile, networkProfile As NetworkProfile, securityProfile As SecurityProfile, diagnosticsProfile As DiagnosticsProfile, availabilitySet As SubResource, virtualMachineScaleSet As SubResource, proximityPlacementGroup As SubResource, priority As String, evictionPolicy As String, billingProfile As BillingProfile, host As SubResource, hostGroup As SubResource, provisioningState As String, instanceView As VirtualMachineInstanceView, licenseType As String, vmId As String, extensionsTimeBudget As String, platformFaultDomain As Nullable(Of Integer), scheduledEventsProfile As ScheduledEventsProfile, userData As String, capacityReservation As CapacityReservationProfile, resources As IList(Of VirtualMachineExtension), identity As VirtualMachineIdentity, zones As IList(Of String), extendedLocation As ExtendedLocation)

Parameters

location
String

Resource location

id
String

Resource Id

name
String

Resource name

type
String

Resource type

tags
IDictionary<String,String>

Resource tags

plan
Plan

Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.

hardwareProfile
HardwareProfile

Specifies the hardware settings for the virtual machine.

storageProfile
StorageProfile

Specifies the storage settings for the virtual machine disks.

additionalCapabilities
AdditionalCapabilities

Specifies additional capabilities enabled or disabled on the virtual machine.

osProfile
OSProfile

Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned.

networkProfile
NetworkProfile

Specifies the network interfaces of the virtual machine.

securityProfile
SecurityProfile

Specifies the Security related profile settings for the virtual machine.

diagnosticsProfile
DiagnosticsProfile

Specifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15.

availabilitySet
SubResource

Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Availability sets overview. <br><br> For more information on Azure planned maintenance, see Maintenance and updates for Virtual Machines in Azure <br><br> Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. <br><br>This property cannot exist along with a non-null properties.virtualMachineScaleSet reference.

virtualMachineScaleSet
SubResource

Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. <br><br>This property cannot exist along with a non-null properties.availabilitySet reference. <br><br>Minimum api‐version: 2019‐03‐01

proximityPlacementGroup
SubResource

Specifies information about the proximity placement group that the virtual machine should be assigned to. <br><br>Minimum api-version: 2018-04-01.

priority
String

Specifies the priority for the virtual machine. <br><br>Minimum api-version: 2019-03-01. Possible values include: 'Regular', 'Low', 'Spot'

evictionPolicy
String

Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. <br><br>For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. <br><br>For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. Possible values include: 'Deallocate', 'Delete'

billingProfile
BillingProfile

Specifies the billing related details of a Azure Spot virtual machine. <br><br>Minimum api-version: 2019-03-01.

host
SubResource

Specifies information about the dedicated host that the virtual machine resides in. <br><br>Minimum api-version: 2018-10-01.

hostGroup
SubResource

Specifies information about the dedicated host group that the virtual machine resides in. <br><br>Minimum api-version: 2020-06-01. <br><br>NOTE: User cannot specify both host and hostGroup properties.

provisioningState
String

The provisioning state, which only appears in the response.

instanceView
VirtualMachineInstanceView

The virtual machine instance view.

licenseType
String

Specifies that the image or disk that is being used was licensed on-premises. <br><br> Possible values for Windows Server operating system are: <br><br> Windows_Client <br><br> Windows_Server <br><br> Possible values for Linux Server operating system are: <br><br> RHEL_BYOS (for RHEL) <br><br> SLES_BYOS (for SUSE) <br><br> For more information, see Azure Hybrid Use Benefit for Windows Server <br><br> Azure Hybrid Use Benefit for Linux Server <br><br> Minimum api-version: 2015-06-15

vmId
String

Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands.

extensionsTimeBudget
String

Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). <br><br> Minimum api-version: 2020-06-01

platformFaultDomain
Nullable<Int32>

Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains.<br><li>This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set.<li>The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' &gt; 1.<li>This property cannot be updated once the Virtual Machine is created.<li>Fault domain assignment can be viewed in the Virtual Machine Instance View.<br><br>Minimum api‐version: 2020‐12‐01

scheduledEventsProfile
ScheduledEventsProfile

Specifies Scheduled Event related configurations.

userData
String

UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. <br><br>Minimum api-version: 2021-03-01

capacityReservation
CapacityReservationProfile

Specifies information about the capacity reservation that is used to allocate virtual machine. <br><br>Minimum api-version: 2021-04-01.

resources
IList<VirtualMachineExtension>

The virtual machine child extension resources.

identity
VirtualMachineIdentity

The identity of the virtual machine, if configured.

zones
IList<String>

The virtual machine zones.

extendedLocation
ExtendedLocation

The extended location of the Virtual Machine.

Applies to

VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String, Nullable<Int32>, ScheduledEventsProfile, String, IList<VirtualMachineExtension>, VirtualMachineIdentity, IList<String>, ExtendedLocation)

Initializes a new instance of the VirtualMachine class.

public VirtualMachine (string location, string id, string name, string type, System.Collections.Generic.IDictionary<string,string> tags, Microsoft.Azure.Management.Compute.Models.Plan plan, Microsoft.Azure.Management.Compute.Models.HardwareProfile hardwareProfile, Microsoft.Azure.Management.Compute.Models.StorageProfile storageProfile, Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities additionalCapabilities, Microsoft.Azure.Management.Compute.Models.OSProfile osProfile, Microsoft.Azure.Management.Compute.Models.NetworkProfile networkProfile, Microsoft.Azure.Management.Compute.Models.SecurityProfile securityProfile, Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile diagnosticsProfile, Microsoft.Azure.Management.Compute.Models.SubResource availabilitySet, Microsoft.Azure.Management.Compute.Models.SubResource virtualMachineScaleSet, Microsoft.Azure.Management.Compute.Models.SubResource proximityPlacementGroup, string priority, string evictionPolicy, Microsoft.Azure.Management.Compute.Models.BillingProfile billingProfile, Microsoft.Azure.Management.Compute.Models.SubResource host, Microsoft.Azure.Management.Compute.Models.SubResource hostGroup, string provisioningState, Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView instanceView, string licenseType, string vmId, string extensionsTimeBudget, int? platformFaultDomain, Microsoft.Azure.Management.Compute.Models.ScheduledEventsProfile scheduledEventsProfile, string userData, System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension> resources, Microsoft.Azure.Management.Compute.Models.VirtualMachineIdentity identity, System.Collections.Generic.IList<string> zones, Microsoft.Azure.Management.Compute.Models.ExtendedLocation extendedLocation);
new Microsoft.Azure.Management.Compute.Models.VirtualMachine : string * string * string * string * System.Collections.Generic.IDictionary<string, string> * Microsoft.Azure.Management.Compute.Models.Plan * Microsoft.Azure.Management.Compute.Models.HardwareProfile * Microsoft.Azure.Management.Compute.Models.StorageProfile * Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities * Microsoft.Azure.Management.Compute.Models.OSProfile * Microsoft.Azure.Management.Compute.Models.NetworkProfile * Microsoft.Azure.Management.Compute.Models.SecurityProfile * Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * string * Microsoft.Azure.Management.Compute.Models.BillingProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView * string * string * string * Nullable<int> * Microsoft.Azure.Management.Compute.Models.ScheduledEventsProfile * string * System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension> * Microsoft.Azure.Management.Compute.Models.VirtualMachineIdentity * System.Collections.Generic.IList<string> * Microsoft.Azure.Management.Compute.Models.ExtendedLocation -> Microsoft.Azure.Management.Compute.Models.VirtualMachine
Public Sub New (location As String, id As String, name As String, type As String, tags As IDictionary(Of String, String), plan As Plan, hardwareProfile As HardwareProfile, storageProfile As StorageProfile, additionalCapabilities As AdditionalCapabilities, osProfile As OSProfile, networkProfile As NetworkProfile, securityProfile As SecurityProfile, diagnosticsProfile As DiagnosticsProfile, availabilitySet As SubResource, virtualMachineScaleSet As SubResource, proximityPlacementGroup As SubResource, priority As String, evictionPolicy As String, billingProfile As BillingProfile, host As SubResource, hostGroup As SubResource, provisioningState As String, instanceView As VirtualMachineInstanceView, licenseType As String, vmId As String, extensionsTimeBudget As String, platformFaultDomain As Nullable(Of Integer), scheduledEventsProfile As ScheduledEventsProfile, userData As String, resources As IList(Of VirtualMachineExtension), identity As VirtualMachineIdentity, zones As IList(Of String), extendedLocation As ExtendedLocation)

Parameters

location
String

Resource location

id
String

Resource Id

name
String

Resource name

type
String

Resource type

tags
IDictionary<String,String>

Resource tags

plan
Plan

Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.

hardwareProfile
HardwareProfile

Specifies the hardware settings for the virtual machine.

storageProfile
StorageProfile

Specifies the storage settings for the virtual machine disks.

additionalCapabilities
AdditionalCapabilities

Specifies additional capabilities enabled or disabled on the virtual machine.

osProfile
OSProfile

Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned.

networkProfile
NetworkProfile

Specifies the network interfaces of the virtual machine.

securityProfile
SecurityProfile

Specifies the Security related profile settings for the virtual machine.

diagnosticsProfile
DiagnosticsProfile

Specifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15.

availabilitySet
SubResource

Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Availability sets overview. <br><br> For more information on Azure planned maintenance, see Maintenance and updates for Virtual Machines in Azure <br><br> Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. <br><br>This property cannot exist along with a non-null properties.virtualMachineScaleSet reference.

virtualMachineScaleSet
SubResource

Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. <br><br>This property cannot exist along with a non-null properties.availabilitySet reference. <br><br>Minimum api‐version: 2019‐03‐01

proximityPlacementGroup
SubResource

Specifies information about the proximity placement group that the virtual machine should be assigned to. <br><br>Minimum api-version: 2018-04-01.

priority
String

Specifies the priority for the virtual machine. <br><br>Minimum api-version: 2019-03-01. Possible values include: 'Regular', 'Low', 'Spot'

evictionPolicy
String

Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. <br><br>For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. <br><br>For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. Possible values include: 'Deallocate', 'Delete'

billingProfile
BillingProfile

Specifies the billing related details of a Azure Spot virtual machine. <br><br>Minimum api-version: 2019-03-01.

host
SubResource

Specifies information about the dedicated host that the virtual machine resides in. <br><br>Minimum api-version: 2018-10-01.

hostGroup
SubResource

Specifies information about the dedicated host group that the virtual machine resides in. <br><br>Minimum api-version: 2020-06-01. <br><br>NOTE: User cannot specify both host and hostGroup properties.

provisioningState
String

The provisioning state, which only appears in the response.

instanceView
VirtualMachineInstanceView

The virtual machine instance view.

licenseType
String

Specifies that the image or disk that is being used was licensed on-premises. <br><br> Possible values for Windows Server operating system are: <br><br> Windows_Client <br><br> Windows_Server <br><br> Possible values for Linux Server operating system are: <br><br> RHEL_BYOS (for RHEL) <br><br> SLES_BYOS (for SUSE) <br><br> For more information, see Azure Hybrid Use Benefit for Windows Server <br><br> Azure Hybrid Use Benefit for Linux Server <br><br> Minimum api-version: 2015-06-15

vmId
String

Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands.

extensionsTimeBudget
String

Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). <br><br> Minimum api-version: 2020-06-01

platformFaultDomain
Nullable<Int32>

Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains.<br><li>This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set.<li>The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' &gt; 1.<li>This property cannot be updated once the Virtual Machine is created.<li>Fault domain assignment can be viewed in the Virtual Machine Instance View.<br><br>Minimum api‐version: 2020‐12‐01

scheduledEventsProfile
ScheduledEventsProfile

Specifies Scheduled Event related configurations.

userData
String

UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. <br><br>Minimum api-version: 2021-03-01

resources
IList<VirtualMachineExtension>

The virtual machine child extension resources.

identity
VirtualMachineIdentity

The identity of the virtual machine, if configured.

zones
IList<String>

The virtual machine zones.

extendedLocation
ExtendedLocation

The extended location of the Virtual Machine.

Applies to

VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String, Nullable<Int32>, ScheduledEventsProfile, String, CapacityReservationProfile, IList<VirtualMachineExtension>, VirtualMachineIdentity, IList<String>)

public VirtualMachine (string location, string id, string name, string type, System.Collections.Generic.IDictionary<string,string> tags, Microsoft.Azure.Management.Compute.Models.Plan plan, Microsoft.Azure.Management.Compute.Models.HardwareProfile hardwareProfile, Microsoft.Azure.Management.Compute.Models.StorageProfile storageProfile, Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities additionalCapabilities, Microsoft.Azure.Management.Compute.Models.OSProfile osProfile, Microsoft.Azure.Management.Compute.Models.NetworkProfile networkProfile, Microsoft.Azure.Management.Compute.Models.SecurityProfile securityProfile, Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile diagnosticsProfile, Microsoft.Azure.Management.Compute.Models.SubResource availabilitySet, Microsoft.Azure.Management.Compute.Models.SubResource virtualMachineScaleSet, Microsoft.Azure.Management.Compute.Models.SubResource proximityPlacementGroup, string priority, string evictionPolicy, Microsoft.Azure.Management.Compute.Models.BillingProfile billingProfile, Microsoft.Azure.Management.Compute.Models.SubResource host, Microsoft.Azure.Management.Compute.Models.SubResource hostGroup, string provisioningState, Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView instanceView, string licenseType, string vmId, string extensionsTimeBudget, int? platformFaultDomain, Microsoft.Azure.Management.Compute.Models.ScheduledEventsProfile scheduledEventsProfile, string userData, Microsoft.Azure.Management.Compute.Models.CapacityReservationProfile capacityReservation, System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension> resources, Microsoft.Azure.Management.Compute.Models.VirtualMachineIdentity identity, System.Collections.Generic.IList<string> zones);
new Microsoft.Azure.Management.Compute.Models.VirtualMachine : string * string * string * string * System.Collections.Generic.IDictionary<string, string> * Microsoft.Azure.Management.Compute.Models.Plan * Microsoft.Azure.Management.Compute.Models.HardwareProfile * Microsoft.Azure.Management.Compute.Models.StorageProfile * Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities * Microsoft.Azure.Management.Compute.Models.OSProfile * Microsoft.Azure.Management.Compute.Models.NetworkProfile * Microsoft.Azure.Management.Compute.Models.SecurityProfile * Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * string * Microsoft.Azure.Management.Compute.Models.BillingProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView * string * string * string * Nullable<int> * Microsoft.Azure.Management.Compute.Models.ScheduledEventsProfile * string * Microsoft.Azure.Management.Compute.Models.CapacityReservationProfile * System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension> * Microsoft.Azure.Management.Compute.Models.VirtualMachineIdentity * System.Collections.Generic.IList<string> -> Microsoft.Azure.Management.Compute.Models.VirtualMachine
Public Sub New (location As String, id As String, name As String, type As String, tags As IDictionary(Of String, String), plan As Plan, hardwareProfile As HardwareProfile, storageProfile As StorageProfile, additionalCapabilities As AdditionalCapabilities, osProfile As OSProfile, networkProfile As NetworkProfile, securityProfile As SecurityProfile, diagnosticsProfile As DiagnosticsProfile, availabilitySet As SubResource, virtualMachineScaleSet As SubResource, proximityPlacementGroup As SubResource, priority As String, evictionPolicy As String, billingProfile As BillingProfile, host As SubResource, hostGroup As SubResource, provisioningState As String, instanceView As VirtualMachineInstanceView, licenseType As String, vmId As String, extensionsTimeBudget As String, platformFaultDomain As Nullable(Of Integer), scheduledEventsProfile As ScheduledEventsProfile, userData As String, capacityReservation As CapacityReservationProfile, resources As IList(Of VirtualMachineExtension), identity As VirtualMachineIdentity, zones As IList(Of String))

Parameters

location
String
id
String
name
String
type
String
plan
Plan
hardwareProfile
HardwareProfile
storageProfile
StorageProfile
additionalCapabilities
AdditionalCapabilities
osProfile
OSProfile
networkProfile
NetworkProfile
securityProfile
SecurityProfile
diagnosticsProfile
DiagnosticsProfile
availabilitySet
SubResource
virtualMachineScaleSet
SubResource
proximityPlacementGroup
SubResource
priority
String
evictionPolicy
String
billingProfile
BillingProfile
hostGroup
SubResource
provisioningState
String
licenseType
String
vmId
String
extensionsTimeBudget
String
platformFaultDomain
Nullable<Int32>
scheduledEventsProfile
ScheduledEventsProfile
userData
String
capacityReservation
CapacityReservationProfile
zones
IList<String>

Applies to

VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String, Nullable<Int32>, ScheduledEventsProfile, String, IList<VirtualMachineExtension>, VirtualMachineIdentity, IList<String>)

public VirtualMachine (string location, string id, string name, string type, System.Collections.Generic.IDictionary<string,string> tags, Microsoft.Azure.Management.Compute.Models.Plan plan, Microsoft.Azure.Management.Compute.Models.HardwareProfile hardwareProfile, Microsoft.Azure.Management.Compute.Models.StorageProfile storageProfile, Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities additionalCapabilities, Microsoft.Azure.Management.Compute.Models.OSProfile osProfile, Microsoft.Azure.Management.Compute.Models.NetworkProfile networkProfile, Microsoft.Azure.Management.Compute.Models.SecurityProfile securityProfile, Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile diagnosticsProfile, Microsoft.Azure.Management.Compute.Models.SubResource availabilitySet, Microsoft.Azure.Management.Compute.Models.SubResource virtualMachineScaleSet, Microsoft.Azure.Management.Compute.Models.SubResource proximityPlacementGroup, string priority, string evictionPolicy, Microsoft.Azure.Management.Compute.Models.BillingProfile billingProfile, Microsoft.Azure.Management.Compute.Models.SubResource host, Microsoft.Azure.Management.Compute.Models.SubResource hostGroup, string provisioningState, Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView instanceView, string licenseType, string vmId, string extensionsTimeBudget, int? platformFaultDomain, Microsoft.Azure.Management.Compute.Models.ScheduledEventsProfile scheduledEventsProfile, string userData, System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension> resources, Microsoft.Azure.Management.Compute.Models.VirtualMachineIdentity identity, System.Collections.Generic.IList<string> zones);
new Microsoft.Azure.Management.Compute.Models.VirtualMachine : string * string * string * string * System.Collections.Generic.IDictionary<string, string> * Microsoft.Azure.Management.Compute.Models.Plan * Microsoft.Azure.Management.Compute.Models.HardwareProfile * Microsoft.Azure.Management.Compute.Models.StorageProfile * Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities * Microsoft.Azure.Management.Compute.Models.OSProfile * Microsoft.Azure.Management.Compute.Models.NetworkProfile * Microsoft.Azure.Management.Compute.Models.SecurityProfile * Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * string * Microsoft.Azure.Management.Compute.Models.BillingProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView * string * string * string * Nullable<int> * Microsoft.Azure.Management.Compute.Models.ScheduledEventsProfile * string * System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension> * Microsoft.Azure.Management.Compute.Models.VirtualMachineIdentity * System.Collections.Generic.IList<string> -> Microsoft.Azure.Management.Compute.Models.VirtualMachine
Public Sub New (location As String, id As String, name As String, type As String, tags As IDictionary(Of String, String), plan As Plan, hardwareProfile As HardwareProfile, storageProfile As StorageProfile, additionalCapabilities As AdditionalCapabilities, osProfile As OSProfile, networkProfile As NetworkProfile, securityProfile As SecurityProfile, diagnosticsProfile As DiagnosticsProfile, availabilitySet As SubResource, virtualMachineScaleSet As SubResource, proximityPlacementGroup As SubResource, priority As String, evictionPolicy As String, billingProfile As BillingProfile, host As SubResource, hostGroup As SubResource, provisioningState As String, instanceView As VirtualMachineInstanceView, licenseType As String, vmId As String, extensionsTimeBudget As String, platformFaultDomain As Nullable(Of Integer), scheduledEventsProfile As ScheduledEventsProfile, userData As String, resources As IList(Of VirtualMachineExtension), identity As VirtualMachineIdentity, zones As IList(Of String))

Parameters

location
String
id
String
name
String
type
String
plan
Plan
hardwareProfile
HardwareProfile
storageProfile
StorageProfile
additionalCapabilities
AdditionalCapabilities
osProfile
OSProfile
networkProfile
NetworkProfile
securityProfile
SecurityProfile
diagnosticsProfile
DiagnosticsProfile
availabilitySet
SubResource
virtualMachineScaleSet
SubResource
proximityPlacementGroup
SubResource
priority
String
evictionPolicy
String
billingProfile
BillingProfile
hostGroup
SubResource
provisioningState
String
licenseType
String
vmId
String
extensionsTimeBudget
String
platformFaultDomain
Nullable<Int32>
scheduledEventsProfile
ScheduledEventsProfile
userData
String
zones
IList<String>

Applies to

VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String, Nullable<Int32>, ScheduledEventsProfile, String, CapacityReservationProfile, IList<VirtualMachineExtension>, VirtualMachineIdentity)

public VirtualMachine (string location, string id, string name, string type, System.Collections.Generic.IDictionary<string,string> tags, Microsoft.Azure.Management.Compute.Models.Plan plan, Microsoft.Azure.Management.Compute.Models.HardwareProfile hardwareProfile, Microsoft.Azure.Management.Compute.Models.StorageProfile storageProfile, Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities additionalCapabilities, Microsoft.Azure.Management.Compute.Models.OSProfile osProfile, Microsoft.Azure.Management.Compute.Models.NetworkProfile networkProfile, Microsoft.Azure.Management.Compute.Models.SecurityProfile securityProfile, Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile diagnosticsProfile, Microsoft.Azure.Management.Compute.Models.SubResource availabilitySet, Microsoft.Azure.Management.Compute.Models.SubResource virtualMachineScaleSet, Microsoft.Azure.Management.Compute.Models.SubResource proximityPlacementGroup, string priority, string evictionPolicy, Microsoft.Azure.Management.Compute.Models.BillingProfile billingProfile, Microsoft.Azure.Management.Compute.Models.SubResource host, Microsoft.Azure.Management.Compute.Models.SubResource hostGroup, string provisioningState, Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView instanceView, string licenseType, string vmId, string extensionsTimeBudget, int? platformFaultDomain, Microsoft.Azure.Management.Compute.Models.ScheduledEventsProfile scheduledEventsProfile, string userData, Microsoft.Azure.Management.Compute.Models.CapacityReservationProfile capacityReservation, System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension> resources, Microsoft.Azure.Management.Compute.Models.VirtualMachineIdentity identity);
new Microsoft.Azure.Management.Compute.Models.VirtualMachine : string * string * string * string * System.Collections.Generic.IDictionary<string, string> * Microsoft.Azure.Management.Compute.Models.Plan * Microsoft.Azure.Management.Compute.Models.HardwareProfile * Microsoft.Azure.Management.Compute.Models.StorageProfile * Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities * Microsoft.Azure.Management.Compute.Models.OSProfile * Microsoft.Azure.Management.Compute.Models.NetworkProfile * Microsoft.Azure.Management.Compute.Models.SecurityProfile * Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * string * Microsoft.Azure.Management.Compute.Models.BillingProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView * string * string * string * Nullable<int> * Microsoft.Azure.Management.Compute.Models.ScheduledEventsProfile * string * Microsoft.Azure.Management.Compute.Models.CapacityReservationProfile * System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension> * Microsoft.Azure.Management.Compute.Models.VirtualMachineIdentity -> Microsoft.Azure.Management.Compute.Models.VirtualMachine
Public Sub New (location As String, id As String, name As String, type As String, tags As IDictionary(Of String, String), plan As Plan, hardwareProfile As HardwareProfile, storageProfile As StorageProfile, additionalCapabilities As AdditionalCapabilities, osProfile As OSProfile, networkProfile As NetworkProfile, securityProfile As SecurityProfile, diagnosticsProfile As DiagnosticsProfile, availabilitySet As SubResource, virtualMachineScaleSet As SubResource, proximityPlacementGroup As SubResource, priority As String, evictionPolicy As String, billingProfile As BillingProfile, host As SubResource, hostGroup As SubResource, provisioningState As String, instanceView As VirtualMachineInstanceView, licenseType As String, vmId As String, extensionsTimeBudget As String, platformFaultDomain As Nullable(Of Integer), scheduledEventsProfile As ScheduledEventsProfile, userData As String, capacityReservation As CapacityReservationProfile, resources As IList(Of VirtualMachineExtension), identity As VirtualMachineIdentity)

Parameters

location
String
id
String
name
String
type
String
plan
Plan
hardwareProfile
HardwareProfile
storageProfile
StorageProfile
additionalCapabilities
AdditionalCapabilities
osProfile
OSProfile
networkProfile
NetworkProfile
securityProfile
SecurityProfile
diagnosticsProfile
DiagnosticsProfile
availabilitySet
SubResource
virtualMachineScaleSet
SubResource
proximityPlacementGroup
SubResource
priority
String
evictionPolicy
String
billingProfile
BillingProfile
hostGroup
SubResource
provisioningState
String
licenseType
String
vmId
String
extensionsTimeBudget
String
platformFaultDomain
Nullable<Int32>
scheduledEventsProfile
ScheduledEventsProfile
userData
String
capacityReservation
CapacityReservationProfile

Applies to

VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String, Nullable<Int32>, ScheduledEventsProfile, String, IList<VirtualMachineExtension>, VirtualMachineIdentity)

public VirtualMachine (string location, string id, string name, string type, System.Collections.Generic.IDictionary<string,string> tags, Microsoft.Azure.Management.Compute.Models.Plan plan, Microsoft.Azure.Management.Compute.Models.HardwareProfile hardwareProfile, Microsoft.Azure.Management.Compute.Models.StorageProfile storageProfile, Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities additionalCapabilities, Microsoft.Azure.Management.Compute.Models.OSProfile osProfile, Microsoft.Azure.Management.Compute.Models.NetworkProfile networkProfile, Microsoft.Azure.Management.Compute.Models.SecurityProfile securityProfile, Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile diagnosticsProfile, Microsoft.Azure.Management.Compute.Models.SubResource availabilitySet, Microsoft.Azure.Management.Compute.Models.SubResource virtualMachineScaleSet, Microsoft.Azure.Management.Compute.Models.SubResource proximityPlacementGroup, string priority, string evictionPolicy, Microsoft.Azure.Management.Compute.Models.BillingProfile billingProfile, Microsoft.Azure.Management.Compute.Models.SubResource host, Microsoft.Azure.Management.Compute.Models.SubResource hostGroup, string provisioningState, Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView instanceView, string licenseType, string vmId, string extensionsTimeBudget, int? platformFaultDomain, Microsoft.Azure.Management.Compute.Models.ScheduledEventsProfile scheduledEventsProfile, string userData, System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension> resources, Microsoft.Azure.Management.Compute.Models.VirtualMachineIdentity identity);
new Microsoft.Azure.Management.Compute.Models.VirtualMachine : string * string * string * string * System.Collections.Generic.IDictionary<string, string> * Microsoft.Azure.Management.Compute.Models.Plan * Microsoft.Azure.Management.Compute.Models.HardwareProfile * Microsoft.Azure.Management.Compute.Models.StorageProfile * Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities * Microsoft.Azure.Management.Compute.Models.OSProfile * Microsoft.Azure.Management.Compute.Models.NetworkProfile * Microsoft.Azure.Management.Compute.Models.SecurityProfile * Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * string * Microsoft.Azure.Management.Compute.Models.BillingProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView * string * string * string * Nullable<int> * Microsoft.Azure.Management.Compute.Models.ScheduledEventsProfile * string * System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension> * Microsoft.Azure.Management.Compute.Models.VirtualMachineIdentity -> Microsoft.Azure.Management.Compute.Models.VirtualMachine
Public Sub New (location As String, id As String, name As String, type As String, tags As IDictionary(Of String, String), plan As Plan, hardwareProfile As HardwareProfile, storageProfile As StorageProfile, additionalCapabilities As AdditionalCapabilities, osProfile As OSProfile, networkProfile As NetworkProfile, securityProfile As SecurityProfile, diagnosticsProfile As DiagnosticsProfile, availabilitySet As SubResource, virtualMachineScaleSet As SubResource, proximityPlacementGroup As SubResource, priority As String, evictionPolicy As String, billingProfile As BillingProfile, host As SubResource, hostGroup As SubResource, provisioningState As String, instanceView As VirtualMachineInstanceView, licenseType As String, vmId As String, extensionsTimeBudget As String, platformFaultDomain As Nullable(Of Integer), scheduledEventsProfile As ScheduledEventsProfile, userData As String, resources As IList(Of VirtualMachineExtension), identity As VirtualMachineIdentity)

Parameters

location
String
id
String
name
String
type
String
plan
Plan
hardwareProfile
HardwareProfile
storageProfile
StorageProfile
additionalCapabilities
AdditionalCapabilities
osProfile
OSProfile
networkProfile
NetworkProfile
securityProfile
SecurityProfile
diagnosticsProfile
DiagnosticsProfile
availabilitySet
SubResource
virtualMachineScaleSet
SubResource
proximityPlacementGroup
SubResource
priority
String
evictionPolicy
String
billingProfile
BillingProfile
hostGroup
SubResource
provisioningState
String
licenseType
String
vmId
String
extensionsTimeBudget
String
platformFaultDomain
Nullable<Int32>
scheduledEventsProfile
ScheduledEventsProfile
userData
String

Applies to

VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String, Nullable<Int32>, ScheduledEventsProfile, String, CapacityReservationProfile, IList<VirtualMachineExtension>)

public VirtualMachine (string location, string id, string name, string type, System.Collections.Generic.IDictionary<string,string> tags, Microsoft.Azure.Management.Compute.Models.Plan plan, Microsoft.Azure.Management.Compute.Models.HardwareProfile hardwareProfile, Microsoft.Azure.Management.Compute.Models.StorageProfile storageProfile, Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities additionalCapabilities, Microsoft.Azure.Management.Compute.Models.OSProfile osProfile, Microsoft.Azure.Management.Compute.Models.NetworkProfile networkProfile, Microsoft.Azure.Management.Compute.Models.SecurityProfile securityProfile, Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile diagnosticsProfile, Microsoft.Azure.Management.Compute.Models.SubResource availabilitySet, Microsoft.Azure.Management.Compute.Models.SubResource virtualMachineScaleSet, Microsoft.Azure.Management.Compute.Models.SubResource proximityPlacementGroup, string priority, string evictionPolicy, Microsoft.Azure.Management.Compute.Models.BillingProfile billingProfile, Microsoft.Azure.Management.Compute.Models.SubResource host, Microsoft.Azure.Management.Compute.Models.SubResource hostGroup, string provisioningState, Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView instanceView, string licenseType, string vmId, string extensionsTimeBudget, int? platformFaultDomain, Microsoft.Azure.Management.Compute.Models.ScheduledEventsProfile scheduledEventsProfile, string userData, Microsoft.Azure.Management.Compute.Models.CapacityReservationProfile capacityReservation, System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension> resources);
new Microsoft.Azure.Management.Compute.Models.VirtualMachine : string * string * string * string * System.Collections.Generic.IDictionary<string, string> * Microsoft.Azure.Management.Compute.Models.Plan * Microsoft.Azure.Management.Compute.Models.HardwareProfile * Microsoft.Azure.Management.Compute.Models.StorageProfile * Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities * Microsoft.Azure.Management.Compute.Models.OSProfile * Microsoft.Azure.Management.Compute.Models.NetworkProfile * Microsoft.Azure.Management.Compute.Models.SecurityProfile * Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * string * Microsoft.Azure.Management.Compute.Models.BillingProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView * string * string * string * Nullable<int> * Microsoft.Azure.Management.Compute.Models.ScheduledEventsProfile * string * Microsoft.Azure.Management.Compute.Models.CapacityReservationProfile * System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension> -> Microsoft.Azure.Management.Compute.Models.VirtualMachine
Public Sub New (location As String, id As String, name As String, type As String, tags As IDictionary(Of String, String), plan As Plan, hardwareProfile As HardwareProfile, storageProfile As StorageProfile, additionalCapabilities As AdditionalCapabilities, osProfile As OSProfile, networkProfile As NetworkProfile, securityProfile As SecurityProfile, diagnosticsProfile As DiagnosticsProfile, availabilitySet As SubResource, virtualMachineScaleSet As SubResource, proximityPlacementGroup As SubResource, priority As String, evictionPolicy As String, billingProfile As BillingProfile, host As SubResource, hostGroup As SubResource, provisioningState As String, instanceView As VirtualMachineInstanceView, licenseType As String, vmId As String, extensionsTimeBudget As String, platformFaultDomain As Nullable(Of Integer), scheduledEventsProfile As ScheduledEventsProfile, userData As String, capacityReservation As CapacityReservationProfile, resources As IList(Of VirtualMachineExtension))

Parameters

location
String
id
String
name
String
type
String
plan
Plan
hardwareProfile
HardwareProfile
storageProfile
StorageProfile
additionalCapabilities
AdditionalCapabilities
osProfile
OSProfile
networkProfile
NetworkProfile
securityProfile
SecurityProfile
diagnosticsProfile
DiagnosticsProfile
availabilitySet
SubResource
virtualMachineScaleSet
SubResource
proximityPlacementGroup
SubResource
priority
String
evictionPolicy
String
billingProfile
BillingProfile
hostGroup
SubResource
provisioningState
String
licenseType
String
vmId
String
extensionsTimeBudget
String
platformFaultDomain
Nullable<Int32>
scheduledEventsProfile
ScheduledEventsProfile
userData
String
capacityReservation
CapacityReservationProfile

Applies to

VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String, Nullable<Int32>, ScheduledEventsProfile, IList<VirtualMachineExtension>, VirtualMachineIdentity, IList<String>, ExtendedLocation)

Initializes a new instance of the VirtualMachine class.

public VirtualMachine (string location, string id, string name, string type, System.Collections.Generic.IDictionary<string,string> tags, Microsoft.Azure.Management.Compute.Models.Plan plan, Microsoft.Azure.Management.Compute.Models.HardwareProfile hardwareProfile, Microsoft.Azure.Management.Compute.Models.StorageProfile storageProfile, Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities additionalCapabilities, Microsoft.Azure.Management.Compute.Models.OSProfile osProfile, Microsoft.Azure.Management.Compute.Models.NetworkProfile networkProfile, Microsoft.Azure.Management.Compute.Models.SecurityProfile securityProfile, Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile diagnosticsProfile, Microsoft.Azure.Management.Compute.Models.SubResource availabilitySet, Microsoft.Azure.Management.Compute.Models.SubResource virtualMachineScaleSet, Microsoft.Azure.Management.Compute.Models.SubResource proximityPlacementGroup, string priority, string evictionPolicy, Microsoft.Azure.Management.Compute.Models.BillingProfile billingProfile, Microsoft.Azure.Management.Compute.Models.SubResource host, Microsoft.Azure.Management.Compute.Models.SubResource hostGroup, string provisioningState, Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView instanceView, string licenseType, string vmId, string extensionsTimeBudget, int? platformFaultDomain, Microsoft.Azure.Management.Compute.Models.ScheduledEventsProfile scheduledEventsProfile, System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension> resources, Microsoft.Azure.Management.Compute.Models.VirtualMachineIdentity identity, System.Collections.Generic.IList<string> zones, Microsoft.Azure.Management.Compute.Models.ExtendedLocation extendedLocation);
new Microsoft.Azure.Management.Compute.Models.VirtualMachine : string * string * string * string * System.Collections.Generic.IDictionary<string, string> * Microsoft.Azure.Management.Compute.Models.Plan * Microsoft.Azure.Management.Compute.Models.HardwareProfile * Microsoft.Azure.Management.Compute.Models.StorageProfile * Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities * Microsoft.Azure.Management.Compute.Models.OSProfile * Microsoft.Azure.Management.Compute.Models.NetworkProfile * Microsoft.Azure.Management.Compute.Models.SecurityProfile * Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * string * Microsoft.Azure.Management.Compute.Models.BillingProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView * string * string * string * Nullable<int> * Microsoft.Azure.Management.Compute.Models.ScheduledEventsProfile * System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension> * Microsoft.Azure.Management.Compute.Models.VirtualMachineIdentity * System.Collections.Generic.IList<string> * Microsoft.Azure.Management.Compute.Models.ExtendedLocation -> Microsoft.Azure.Management.Compute.Models.VirtualMachine
Public Sub New (location As String, id As String, name As String, type As String, tags As IDictionary(Of String, String), plan As Plan, hardwareProfile As HardwareProfile, storageProfile As StorageProfile, additionalCapabilities As AdditionalCapabilities, osProfile As OSProfile, networkProfile As NetworkProfile, securityProfile As SecurityProfile, diagnosticsProfile As DiagnosticsProfile, availabilitySet As SubResource, virtualMachineScaleSet As SubResource, proximityPlacementGroup As SubResource, priority As String, evictionPolicy As String, billingProfile As BillingProfile, host As SubResource, hostGroup As SubResource, provisioningState As String, instanceView As VirtualMachineInstanceView, licenseType As String, vmId As String, extensionsTimeBudget As String, platformFaultDomain As Nullable(Of Integer), scheduledEventsProfile As ScheduledEventsProfile, resources As IList(Of VirtualMachineExtension), identity As VirtualMachineIdentity, zones As IList(Of String), extendedLocation As ExtendedLocation)

Parameters

location
String

Resource location

id
String

Resource Id

name
String

Resource name

type
String

Resource type

tags
IDictionary<String,String>

Resource tags

plan
Plan

Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.

hardwareProfile
HardwareProfile

Specifies the hardware settings for the virtual machine.

storageProfile
StorageProfile

Specifies the storage settings for the virtual machine disks.

additionalCapabilities
AdditionalCapabilities

Specifies additional capabilities enabled or disabled on the virtual machine.

osProfile
OSProfile

Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned.

networkProfile
NetworkProfile

Specifies the network interfaces of the virtual machine.

securityProfile
SecurityProfile

Specifies the Security related profile settings for the virtual machine.

diagnosticsProfile
DiagnosticsProfile

Specifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15.

availabilitySet
SubResource

Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Availability sets overview. <br><br> For more information on Azure planned maintenance, see Maintenance and updates for Virtual Machines in Azure <br><br> Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. <br><br>This property cannot exist along with a non-null properties.virtualMachineScaleSet reference.

virtualMachineScaleSet
SubResource

Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. <br><br>This property cannot exist along with a non-null properties.availabilitySet reference. <br><br>Minimum api‐version: 2019‐03‐01

proximityPlacementGroup
SubResource

Specifies information about the proximity placement group that the virtual machine should be assigned to. <br><br>Minimum api-version: 2018-04-01.

priority
String

Specifies the priority for the virtual machine. <br><br>Minimum api-version: 2019-03-01. Possible values include: 'Regular', 'Low', 'Spot'

evictionPolicy
String

Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. <br><br>For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. <br><br>For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. Possible values include: 'Deallocate', 'Delete'

billingProfile
BillingProfile

Specifies the billing related details of a Azure Spot virtual machine. <br><br>Minimum api-version: 2019-03-01.

host
SubResource

Specifies information about the dedicated host that the virtual machine resides in. <br><br>Minimum api-version: 2018-10-01.

hostGroup
SubResource

Specifies information about the dedicated host group that the virtual machine resides in. <br><br>Minimum api-version: 2020-06-01. <br><br>NOTE: User cannot specify both host and hostGroup properties.

provisioningState
String

The provisioning state, which only appears in the response.

instanceView
VirtualMachineInstanceView

The virtual machine instance view.

licenseType
String

Specifies that the image or disk that is being used was licensed on-premises. <br><br> Possible values for Windows Server operating system are: <br><br> Windows_Client <br><br> Windows_Server <br><br> Possible values for Linux Server operating system are: <br><br> RHEL_BYOS (for RHEL) <br><br> SLES_BYOS (for SUSE) <br><br> For more information, see Azure Hybrid Use Benefit for Windows Server <br><br> Azure Hybrid Use Benefit for Linux Server <br><br> Minimum api-version: 2015-06-15

vmId
String

Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands.

extensionsTimeBudget
String

Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). <br><br> Minimum api-version: 2020-06-01

platformFaultDomain
Nullable<Int32>

Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains.<br><li>This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set.<li>The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' &gt; 1.<li>This property cannot be updated once the Virtual Machine is created.<li>Fault domain assignment can be viewed in the Virtual Machine Instance View.<br><br>Minimum api‐version: 2020‐12‐01

scheduledEventsProfile
ScheduledEventsProfile

Specifies Scheduled Event related configurations.

resources
IList<VirtualMachineExtension>

The virtual machine child extension resources.

identity
VirtualMachineIdentity

The identity of the virtual machine, if configured.

zones
IList<String>

The virtual machine zones.

extendedLocation
ExtendedLocation

The extended location of the Virtual Machine.

Applies to

VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String, Nullable<Int32>, ScheduledEventsProfile, IList<VirtualMachineExtension>, VirtualMachineIdentity)

Initializes a new instance of the VirtualMachine class.

public VirtualMachine (string location, string id, string name, string type, System.Collections.Generic.IDictionary<string,string> tags, Microsoft.Azure.Management.Compute.Models.Plan plan, Microsoft.Azure.Management.Compute.Models.HardwareProfile hardwareProfile, Microsoft.Azure.Management.Compute.Models.StorageProfile storageProfile, Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities additionalCapabilities, Microsoft.Azure.Management.Compute.Models.OSProfile osProfile, Microsoft.Azure.Management.Compute.Models.NetworkProfile networkProfile, Microsoft.Azure.Management.Compute.Models.SecurityProfile securityProfile, Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile diagnosticsProfile, Microsoft.Azure.Management.Compute.Models.SubResource availabilitySet, Microsoft.Azure.Management.Compute.Models.SubResource virtualMachineScaleSet, Microsoft.Azure.Management.Compute.Models.SubResource proximityPlacementGroup, string priority, string evictionPolicy, Microsoft.Azure.Management.Compute.Models.BillingProfile billingProfile, Microsoft.Azure.Management.Compute.Models.SubResource host, Microsoft.Azure.Management.Compute.Models.SubResource hostGroup, string provisioningState, Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView instanceView, string licenseType, string vmId, string extensionsTimeBudget, int? platformFaultDomain, Microsoft.Azure.Management.Compute.Models.ScheduledEventsProfile scheduledEventsProfile, System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension> resources, Microsoft.Azure.Management.Compute.Models.VirtualMachineIdentity identity);
new Microsoft.Azure.Management.Compute.Models.VirtualMachine : string * string * string * string * System.Collections.Generic.IDictionary<string, string> * Microsoft.Azure.Management.Compute.Models.Plan * Microsoft.Azure.Management.Compute.Models.HardwareProfile * Microsoft.Azure.Management.Compute.Models.StorageProfile * Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities * Microsoft.Azure.Management.Compute.Models.OSProfile * Microsoft.Azure.Management.Compute.Models.NetworkProfile * Microsoft.Azure.Management.Compute.Models.SecurityProfile * Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * string * Microsoft.Azure.Management.Compute.Models.BillingProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView * string * string * string * Nullable<int> * Microsoft.Azure.Management.Compute.Models.ScheduledEventsProfile * System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension> * Microsoft.Azure.Management.Compute.Models.VirtualMachineIdentity -> Microsoft.Azure.Management.Compute.Models.VirtualMachine
Public Sub New (location As String, id As String, name As String, type As String, tags As IDictionary(Of String, String), plan As Plan, hardwareProfile As HardwareProfile, storageProfile As StorageProfile, additionalCapabilities As AdditionalCapabilities, osProfile As OSProfile, networkProfile As NetworkProfile, securityProfile As SecurityProfile, diagnosticsProfile As DiagnosticsProfile, availabilitySet As SubResource, virtualMachineScaleSet As SubResource, proximityPlacementGroup As SubResource, priority As String, evictionPolicy As String, billingProfile As BillingProfile, host As SubResource, hostGroup As SubResource, provisioningState As String, instanceView As VirtualMachineInstanceView, licenseType As String, vmId As String, extensionsTimeBudget As String, platformFaultDomain As Nullable(Of Integer), scheduledEventsProfile As ScheduledEventsProfile, resources As IList(Of VirtualMachineExtension), identity As VirtualMachineIdentity)

Parameters

location
String

Resource location

id
String

Resource Id

name
String

Resource name

type
String

Resource type

tags
IDictionary<String,String>

Resource tags

plan
Plan

Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.

hardwareProfile
HardwareProfile

Specifies the hardware settings for the virtual machine.

storageProfile
StorageProfile

Specifies the storage settings for the virtual machine disks.

additionalCapabilities
AdditionalCapabilities

Specifies additional capabilities enabled or disabled on the virtual machine.

osProfile
OSProfile

Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned.

networkProfile
NetworkProfile

Specifies the network interfaces of the virtual machine.

securityProfile
SecurityProfile

Specifies the Security related profile settings for the virtual machine.

diagnosticsProfile
DiagnosticsProfile

Specifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15.

availabilitySet
SubResource

Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Availability sets overview. <br><br> For more information on Azure planned maintenance, see Maintenance and updates for Virtual Machines in Azure <br><br> Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. <br><br>This property cannot exist along with a non-null properties.virtualMachineScaleSet reference.

virtualMachineScaleSet
SubResource

Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. <br><br>This property cannot exist along with a non-null properties.availabilitySet reference. <br><br>Minimum api‐version: 2019‐03‐01

proximityPlacementGroup
SubResource

Specifies information about the proximity placement group that the virtual machine should be assigned to. <br><br>Minimum api-version: 2018-04-01.

priority
String

Specifies the priority for the virtual machine. <br><br>Minimum api-version: 2019-03-01. Possible values include: 'Regular', 'Low', 'Spot'

evictionPolicy
String

Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. <br><br>For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. <br><br>For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. Possible values include: 'Deallocate', 'Delete'

billingProfile
BillingProfile

Specifies the billing related details of a Azure Spot virtual machine. <br><br>Minimum api-version: 2019-03-01.

host
SubResource

Specifies information about the dedicated host that the virtual machine resides in. <br><br>Minimum api-version: 2018-10-01.

hostGroup
SubResource

Specifies information about the dedicated host group that the virtual machine resides in. <br><br>Minimum api-version: 2020-06-01. <br><br>NOTE: User cannot specify both host and hostGroup properties.

provisioningState
String

The provisioning state, which only appears in the response.

instanceView
VirtualMachineInstanceView

The virtual machine instance view.

licenseType
String

Specifies that the image or disk that is being used was licensed on-premises. <br><br> Possible values for Windows Server operating system are: <br><br> Windows_Client <br><br> Windows_Server <br><br> Possible values for Linux Server operating system are: <br><br> RHEL_BYOS (for RHEL) <br><br> SLES_BYOS (for SUSE) <br><br> For more information, see Azure Hybrid Use Benefit for Windows Server <br><br> Azure Hybrid Use Benefit for Linux Server <br><br> Minimum api-version: 2015-06-15

vmId
String

Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands.

extensionsTimeBudget
String

Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). <br><br> Minimum api-version: 2020-06-01

platformFaultDomain
Nullable<Int32>

Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains.<br><li>This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set.<li>The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' &gt; 1.<li>This property cannot be updated once the Virtual Machine is created.<li>Fault domain assignment can be viewed in the Virtual Machine Instance View.<br><br>Minimum api‐version: 2020‐12‐01

scheduledEventsProfile
ScheduledEventsProfile

Specifies Scheduled Event related configurations.

resources
IList<VirtualMachineExtension>

The virtual machine child extension resources.

identity
VirtualMachineIdentity

The identity of the virtual machine, if configured.

Applies to

VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String, Nullable<Int32>, ScheduledEventsProfile, IList<VirtualMachineExtension>)

Initializes a new instance of the VirtualMachine class.

public VirtualMachine (string location, string id, string name, string type, System.Collections.Generic.IDictionary<string,string> tags, Microsoft.Azure.Management.Compute.Models.Plan plan, Microsoft.Azure.Management.Compute.Models.HardwareProfile hardwareProfile, Microsoft.Azure.Management.Compute.Models.StorageProfile storageProfile, Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities additionalCapabilities, Microsoft.Azure.Management.Compute.Models.OSProfile osProfile, Microsoft.Azure.Management.Compute.Models.NetworkProfile networkProfile, Microsoft.Azure.Management.Compute.Models.SecurityProfile securityProfile, Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile diagnosticsProfile, Microsoft.Azure.Management.Compute.Models.SubResource availabilitySet, Microsoft.Azure.Management.Compute.Models.SubResource virtualMachineScaleSet, Microsoft.Azure.Management.Compute.Models.SubResource proximityPlacementGroup, string priority, string evictionPolicy, Microsoft.Azure.Management.Compute.Models.BillingProfile billingProfile, Microsoft.Azure.Management.Compute.Models.SubResource host, Microsoft.Azure.Management.Compute.Models.SubResource hostGroup, string provisioningState, Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView instanceView, string licenseType, string vmId, string extensionsTimeBudget, int? platformFaultDomain, Microsoft.Azure.Management.Compute.Models.ScheduledEventsProfile scheduledEventsProfile, System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension> resources);
new Microsoft.Azure.Management.Compute.Models.VirtualMachine : string * string * string * string * System.Collections.Generic.IDictionary<string, string> * Microsoft.Azure.Management.Compute.Models.Plan * Microsoft.Azure.Management.Compute.Models.HardwareProfile * Microsoft.Azure.Management.Compute.Models.StorageProfile * Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities * Microsoft.Azure.Management.Compute.Models.OSProfile * Microsoft.Azure.Management.Compute.Models.NetworkProfile * Microsoft.Azure.Management.Compute.Models.SecurityProfile * Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * string * Microsoft.Azure.Management.Compute.Models.BillingProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView * string * string * string * Nullable<int> * Microsoft.Azure.Management.Compute.Models.ScheduledEventsProfile * System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension> -> Microsoft.Azure.Management.Compute.Models.VirtualMachine
Public Sub New (location As String, id As String, name As String, type As String, tags As IDictionary(Of String, String), plan As Plan, hardwareProfile As HardwareProfile, storageProfile As StorageProfile, additionalCapabilities As AdditionalCapabilities, osProfile As OSProfile, networkProfile As NetworkProfile, securityProfile As SecurityProfile, diagnosticsProfile As DiagnosticsProfile, availabilitySet As SubResource, virtualMachineScaleSet As SubResource, proximityPlacementGroup As SubResource, priority As String, evictionPolicy As String, billingProfile As BillingProfile, host As SubResource, hostGroup As SubResource, provisioningState As String, instanceView As VirtualMachineInstanceView, licenseType As String, vmId As String, extensionsTimeBudget As String, platformFaultDomain As Nullable(Of Integer), scheduledEventsProfile As ScheduledEventsProfile, resources As IList(Of VirtualMachineExtension))

Parameters

location
String

Resource location

id
String

Resource Id

name
String

Resource name

type
String

Resource type

tags
IDictionary<String,String>

Resource tags

plan
Plan

Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.

hardwareProfile
HardwareProfile

Specifies the hardware settings for the virtual machine.

storageProfile
StorageProfile

Specifies the storage settings for the virtual machine disks.

additionalCapabilities
AdditionalCapabilities

Specifies additional capabilities enabled or disabled on the virtual machine.

osProfile
OSProfile

Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned.

networkProfile
NetworkProfile

Specifies the network interfaces of the virtual machine.

securityProfile
SecurityProfile

Specifies the Security related profile settings for the virtual machine.

diagnosticsProfile
DiagnosticsProfile

Specifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15.

availabilitySet
SubResource

Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Availability sets overview. <br><br> For more information on Azure planned maintenance, see Maintenance and updates for Virtual Machines in Azure <br><br> Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. <br><br>This property cannot exist along with a non-null properties.virtualMachineScaleSet reference.

virtualMachineScaleSet
SubResource

Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. <br><br>This property cannot exist along with a non-null properties.availabilitySet reference. <br><br>Minimum api‐version: 2019‐03‐01

proximityPlacementGroup
SubResource

Specifies information about the proximity placement group that the virtual machine should be assigned to. <br><br>Minimum api-version: 2018-04-01.

priority
String

Specifies the priority for the virtual machine. <br><br>Minimum api-version: 2019-03-01. Possible values include: 'Regular', 'Low', 'Spot'

evictionPolicy
String

Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. <br><br>For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. <br><br>For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. Possible values include: 'Deallocate', 'Delete'

billingProfile
BillingProfile

Specifies the billing related details of a Azure Spot virtual machine. <br><br>Minimum api-version: 2019-03-01.

host
SubResource

Specifies information about the dedicated host that the virtual machine resides in. <br><br>Minimum api-version: 2018-10-01.

hostGroup
SubResource

Specifies information about the dedicated host group that the virtual machine resides in. <br><br>Minimum api-version: 2020-06-01. <br><br>NOTE: User cannot specify both host and hostGroup properties.

provisioningState
String

The provisioning state, which only appears in the response.

instanceView
VirtualMachineInstanceView

The virtual machine instance view.

licenseType
String

Specifies that the image or disk that is being used was licensed on-premises. <br><br> Possible values for Windows Server operating system are: <br><br> Windows_Client <br><br> Windows_Server <br><br> Possible values for Linux Server operating system are: <br><br> RHEL_BYOS (for RHEL) <br><br> SLES_BYOS (for SUSE) <br><br> For more information, see Azure Hybrid Use Benefit for Windows Server <br><br> Azure Hybrid Use Benefit for Linux Server <br><br> Minimum api-version: 2015-06-15

vmId
String

Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands.

extensionsTimeBudget
String

Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). <br><br> Minimum api-version: 2020-06-01

platformFaultDomain
Nullable<Int32>

Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains.<br><li>This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set.<li>The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' &gt; 1.<li>This property cannot be updated once the Virtual Machine is created.<li>Fault domain assignment can be viewed in the Virtual Machine Instance View.<br><br>Minimum api‐version: 2020‐12‐01

scheduledEventsProfile
ScheduledEventsProfile

Specifies Scheduled Event related configurations.

resources
IList<VirtualMachineExtension>

The virtual machine child extension resources.

Applies to

VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String, IList<VirtualMachineExtension>, VirtualMachineIdentity, IList<String>)

Initializes a new instance of the VirtualMachine class.

public VirtualMachine (string location, string id, string name, string type, System.Collections.Generic.IDictionary<string,string> tags, Microsoft.Azure.Management.Compute.Models.Plan plan, Microsoft.Azure.Management.Compute.Models.HardwareProfile hardwareProfile, Microsoft.Azure.Management.Compute.Models.StorageProfile storageProfile, Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities additionalCapabilities, Microsoft.Azure.Management.Compute.Models.OSProfile osProfile, Microsoft.Azure.Management.Compute.Models.NetworkProfile networkProfile, Microsoft.Azure.Management.Compute.Models.SecurityProfile securityProfile, Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile diagnosticsProfile, Microsoft.Azure.Management.Compute.Models.SubResource availabilitySet, Microsoft.Azure.Management.Compute.Models.SubResource virtualMachineScaleSet, Microsoft.Azure.Management.Compute.Models.SubResource proximityPlacementGroup, string priority, string evictionPolicy, Microsoft.Azure.Management.Compute.Models.BillingProfile billingProfile, Microsoft.Azure.Management.Compute.Models.SubResource host, Microsoft.Azure.Management.Compute.Models.SubResource hostGroup, string provisioningState, Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView instanceView, string licenseType, string vmId, string extensionsTimeBudget, System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension> resources, Microsoft.Azure.Management.Compute.Models.VirtualMachineIdentity identity, System.Collections.Generic.IList<string> zones);
new Microsoft.Azure.Management.Compute.Models.VirtualMachine : string * string * string * string * System.Collections.Generic.IDictionary<string, string> * Microsoft.Azure.Management.Compute.Models.Plan * Microsoft.Azure.Management.Compute.Models.HardwareProfile * Microsoft.Azure.Management.Compute.Models.StorageProfile * Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities * Microsoft.Azure.Management.Compute.Models.OSProfile * Microsoft.Azure.Management.Compute.Models.NetworkProfile * Microsoft.Azure.Management.Compute.Models.SecurityProfile * Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * string * Microsoft.Azure.Management.Compute.Models.BillingProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView * string * string * string * System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension> * Microsoft.Azure.Management.Compute.Models.VirtualMachineIdentity * System.Collections.Generic.IList<string> -> Microsoft.Azure.Management.Compute.Models.VirtualMachine
Public Sub New (location As String, id As String, name As String, type As String, tags As IDictionary(Of String, String), plan As Plan, hardwareProfile As HardwareProfile, storageProfile As StorageProfile, additionalCapabilities As AdditionalCapabilities, osProfile As OSProfile, networkProfile As NetworkProfile, securityProfile As SecurityProfile, diagnosticsProfile As DiagnosticsProfile, availabilitySet As SubResource, virtualMachineScaleSet As SubResource, proximityPlacementGroup As SubResource, priority As String, evictionPolicy As String, billingProfile As BillingProfile, host As SubResource, hostGroup As SubResource, provisioningState As String, instanceView As VirtualMachineInstanceView, licenseType As String, vmId As String, extensionsTimeBudget As String, resources As IList(Of VirtualMachineExtension), identity As VirtualMachineIdentity, zones As IList(Of String))

Parameters

location
String

Resource location

id
String

Resource Id

name
String

Resource name

type
String

Resource type

tags
IDictionary<String,String>

Resource tags

plan
Plan

Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.

hardwareProfile
HardwareProfile

Specifies the hardware settings for the virtual machine.

storageProfile
StorageProfile

Specifies the storage settings for the virtual machine disks.

additionalCapabilities
AdditionalCapabilities

Specifies additional capabilities enabled or disabled on the virtual machine.

osProfile
OSProfile

Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned.

networkProfile
NetworkProfile

Specifies the network interfaces of the virtual machine.

securityProfile
SecurityProfile

Specifies the Security related profile settings for the virtual machine.

diagnosticsProfile
DiagnosticsProfile

Specifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15.

availabilitySet
SubResource

Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Manage the availability of virtual machines. <br><br> For more information on Azure planned maintenance, see Planned maintenance for virtual machines in Azure <br><br> Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. <br><br>This property cannot exist along with a non-null properties.virtualMachineScaleSet reference.

virtualMachineScaleSet
SubResource

Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. <br><br>This property cannot exist along with a non-null properties.availabilitySet reference. <br><br>Minimum api‐version: 2019‐03‐01

proximityPlacementGroup
SubResource

Specifies information about the proximity placement group that the virtual machine should be assigned to. <br><br>Minimum api-version: 2018-04-01.

priority
String

Specifies the priority for the virtual machine. <br><br>Minimum api-version: 2019-03-01. Possible values include: 'Regular', 'Low', 'Spot'

evictionPolicy
String

Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. <br><br>For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. <br><br>For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. Possible values include: 'Deallocate', 'Delete'

billingProfile
BillingProfile

Specifies the billing related details of a Azure Spot virtual machine. <br><br>Minimum api-version: 2019-03-01.

host
SubResource

Specifies information about the dedicated host that the virtual machine resides in. <br><br>Minimum api-version: 2018-10-01.

hostGroup
SubResource

Specifies information about the dedicated host group that the virtual machine resides in. <br><br>Minimum api-version: 2020-06-01. <br><br>NOTE: User cannot specify both host and hostGroup properties.

provisioningState
String

The provisioning state, which only appears in the response.

instanceView
VirtualMachineInstanceView

The virtual machine instance view.

licenseType
String

Specifies that the image or disk that is being used was licensed on-premises. <br><br> Possible values for Windows Server operating system are: <br><br> Windows_Client <br><br> Windows_Server <br><br> Possible values for Linux Server operating system are: <br><br> RHEL_BYOS (for RHEL) <br><br> SLES_BYOS (for SUSE) <br><br> For more information, see Azure Hybrid Use Benefit for Windows Server <br><br> Azure Hybrid Use Benefit for Linux Server <br><br> Minimum api-version: 2015-06-15

vmId
String

Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands.

extensionsTimeBudget
String

Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). <br><br> Minimum api-version: 2020-06-01

resources
IList<VirtualMachineExtension>

The virtual machine child extension resources.

identity
VirtualMachineIdentity

The identity of the virtual machine, if configured.

zones
IList<String>

The virtual machine zones.

Applies to

VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String, Nullable<Int32>, ScheduledEventsProfile)

Initializes a new instance of the VirtualMachine class.

public VirtualMachine (string location, string id, string name, string type, System.Collections.Generic.IDictionary<string,string> tags, Microsoft.Azure.Management.Compute.Models.Plan plan, Microsoft.Azure.Management.Compute.Models.HardwareProfile hardwareProfile, Microsoft.Azure.Management.Compute.Models.StorageProfile storageProfile, Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities additionalCapabilities, Microsoft.Azure.Management.Compute.Models.OSProfile osProfile, Microsoft.Azure.Management.Compute.Models.NetworkProfile networkProfile, Microsoft.Azure.Management.Compute.Models.SecurityProfile securityProfile, Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile diagnosticsProfile, Microsoft.Azure.Management.Compute.Models.SubResource availabilitySet, Microsoft.Azure.Management.Compute.Models.SubResource virtualMachineScaleSet, Microsoft.Azure.Management.Compute.Models.SubResource proximityPlacementGroup, string priority, string evictionPolicy, Microsoft.Azure.Management.Compute.Models.BillingProfile billingProfile, Microsoft.Azure.Management.Compute.Models.SubResource host, Microsoft.Azure.Management.Compute.Models.SubResource hostGroup, string provisioningState, Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView instanceView, string licenseType, string vmId, string extensionsTimeBudget, int? platformFaultDomain, Microsoft.Azure.Management.Compute.Models.ScheduledEventsProfile scheduledEventsProfile);
new Microsoft.Azure.Management.Compute.Models.VirtualMachine : string * string * string * string * System.Collections.Generic.IDictionary<string, string> * Microsoft.Azure.Management.Compute.Models.Plan * Microsoft.Azure.Management.Compute.Models.HardwareProfile * Microsoft.Azure.Management.Compute.Models.StorageProfile * Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities * Microsoft.Azure.Management.Compute.Models.OSProfile * Microsoft.Azure.Management.Compute.Models.NetworkProfile * Microsoft.Azure.Management.Compute.Models.SecurityProfile * Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * string * Microsoft.Azure.Management.Compute.Models.BillingProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView * string * string * string * Nullable<int> * Microsoft.Azure.Management.Compute.Models.ScheduledEventsProfile -> Microsoft.Azure.Management.Compute.Models.VirtualMachine
Public Sub New (location As String, id As String, name As String, type As String, tags As IDictionary(Of String, String), plan As Plan, hardwareProfile As HardwareProfile, storageProfile As StorageProfile, additionalCapabilities As AdditionalCapabilities, osProfile As OSProfile, networkProfile As NetworkProfile, securityProfile As SecurityProfile, diagnosticsProfile As DiagnosticsProfile, availabilitySet As SubResource, virtualMachineScaleSet As SubResource, proximityPlacementGroup As SubResource, priority As String, evictionPolicy As String, billingProfile As BillingProfile, host As SubResource, hostGroup As SubResource, provisioningState As String, instanceView As VirtualMachineInstanceView, licenseType As String, vmId As String, extensionsTimeBudget As String, platformFaultDomain As Nullable(Of Integer), scheduledEventsProfile As ScheduledEventsProfile)

Parameters

location
String

Resource location

id
String

Resource Id

name
String

Resource name

type
String

Resource type

tags
IDictionary<String,String>

Resource tags

plan
Plan

Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.

hardwareProfile
HardwareProfile

Specifies the hardware settings for the virtual machine.

storageProfile
StorageProfile

Specifies the storage settings for the virtual machine disks.

additionalCapabilities
AdditionalCapabilities

Specifies additional capabilities enabled or disabled on the virtual machine.

osProfile
OSProfile

Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned.

networkProfile
NetworkProfile

Specifies the network interfaces of the virtual machine.

securityProfile
SecurityProfile

Specifies the Security related profile settings for the virtual machine.

diagnosticsProfile
DiagnosticsProfile

Specifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15.

availabilitySet
SubResource

Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Availability sets overview. <br><br> For more information on Azure planned maintenance, see Maintenance and updates for Virtual Machines in Azure <br><br> Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. <br><br>This property cannot exist along with a non-null properties.virtualMachineScaleSet reference.

virtualMachineScaleSet
SubResource

Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. <br><br>This property cannot exist along with a non-null properties.availabilitySet reference. <br><br>Minimum api‐version: 2019‐03‐01

proximityPlacementGroup
SubResource

Specifies information about the proximity placement group that the virtual machine should be assigned to. <br><br>Minimum api-version: 2018-04-01.

priority
String

Specifies the priority for the virtual machine. <br><br>Minimum api-version: 2019-03-01. Possible values include: 'Regular', 'Low', 'Spot'

evictionPolicy
String

Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. <br><br>For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. <br><br>For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. Possible values include: 'Deallocate', 'Delete'

billingProfile
BillingProfile

Specifies the billing related details of a Azure Spot virtual machine. <br><br>Minimum api-version: 2019-03-01.

host
SubResource

Specifies information about the dedicated host that the virtual machine resides in. <br><br>Minimum api-version: 2018-10-01.

hostGroup
SubResource

Specifies information about the dedicated host group that the virtual machine resides in. <br><br>Minimum api-version: 2020-06-01. <br><br>NOTE: User cannot specify both host and hostGroup properties.

provisioningState
String

The provisioning state, which only appears in the response.

instanceView
VirtualMachineInstanceView

The virtual machine instance view.

licenseType
String

Specifies that the image or disk that is being used was licensed on-premises. <br><br> Possible values for Windows Server operating system are: <br><br> Windows_Client <br><br> Windows_Server <br><br> Possible values for Linux Server operating system are: <br><br> RHEL_BYOS (for RHEL) <br><br> SLES_BYOS (for SUSE) <br><br> For more information, see Azure Hybrid Use Benefit for Windows Server <br><br> Azure Hybrid Use Benefit for Linux Server <br><br> Minimum api-version: 2015-06-15

vmId
String

Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands.

extensionsTimeBudget
String

Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). <br><br> Minimum api-version: 2020-06-01

platformFaultDomain
Nullable<Int32>

Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains.<br><li>This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set.<li>The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' &gt; 1.<li>This property cannot be updated once the Virtual Machine is created.<li>Fault domain assignment can be viewed in the Virtual Machine Instance View.<br><br>Minimum api‐version: 2020‐12‐01

scheduledEventsProfile
ScheduledEventsProfile

Specifies Scheduled Event related configurations.

Applies to

VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String, IList<VirtualMachineExtension>, VirtualMachineIdentity)

public VirtualMachine (string location, string id, string name, string type, System.Collections.Generic.IDictionary<string,string> tags, Microsoft.Azure.Management.Compute.Models.Plan plan, Microsoft.Azure.Management.Compute.Models.HardwareProfile hardwareProfile, Microsoft.Azure.Management.Compute.Models.StorageProfile storageProfile, Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities additionalCapabilities, Microsoft.Azure.Management.Compute.Models.OSProfile osProfile, Microsoft.Azure.Management.Compute.Models.NetworkProfile networkProfile, Microsoft.Azure.Management.Compute.Models.SecurityProfile securityProfile, Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile diagnosticsProfile, Microsoft.Azure.Management.Compute.Models.SubResource availabilitySet, Microsoft.Azure.Management.Compute.Models.SubResource virtualMachineScaleSet, Microsoft.Azure.Management.Compute.Models.SubResource proximityPlacementGroup, string priority, string evictionPolicy, Microsoft.Azure.Management.Compute.Models.BillingProfile billingProfile, Microsoft.Azure.Management.Compute.Models.SubResource host, Microsoft.Azure.Management.Compute.Models.SubResource hostGroup, string provisioningState, Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView instanceView, string licenseType, string vmId, string extensionsTimeBudget, System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension> resources, Microsoft.Azure.Management.Compute.Models.VirtualMachineIdentity identity);
new Microsoft.Azure.Management.Compute.Models.VirtualMachine : string * string * string * string * System.Collections.Generic.IDictionary<string, string> * Microsoft.Azure.Management.Compute.Models.Plan * Microsoft.Azure.Management.Compute.Models.HardwareProfile * Microsoft.Azure.Management.Compute.Models.StorageProfile * Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities * Microsoft.Azure.Management.Compute.Models.OSProfile * Microsoft.Azure.Management.Compute.Models.NetworkProfile * Microsoft.Azure.Management.Compute.Models.SecurityProfile * Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * string * Microsoft.Azure.Management.Compute.Models.BillingProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView * string * string * string * System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension> * Microsoft.Azure.Management.Compute.Models.VirtualMachineIdentity -> Microsoft.Azure.Management.Compute.Models.VirtualMachine
Public Sub New (location As String, id As String, name As String, type As String, tags As IDictionary(Of String, String), plan As Plan, hardwareProfile As HardwareProfile, storageProfile As StorageProfile, additionalCapabilities As AdditionalCapabilities, osProfile As OSProfile, networkProfile As NetworkProfile, securityProfile As SecurityProfile, diagnosticsProfile As DiagnosticsProfile, availabilitySet As SubResource, virtualMachineScaleSet As SubResource, proximityPlacementGroup As SubResource, priority As String, evictionPolicy As String, billingProfile As BillingProfile, host As SubResource, hostGroup As SubResource, provisioningState As String, instanceView As VirtualMachineInstanceView, licenseType As String, vmId As String, extensionsTimeBudget As String, resources As IList(Of VirtualMachineExtension), identity As VirtualMachineIdentity)

Parameters

location
String
id
String
name
String
type
String
plan
Plan
hardwareProfile
HardwareProfile
storageProfile
StorageProfile
additionalCapabilities
AdditionalCapabilities
osProfile
OSProfile
networkProfile
NetworkProfile
securityProfile
SecurityProfile
diagnosticsProfile
DiagnosticsProfile
availabilitySet
SubResource
virtualMachineScaleSet
SubResource
proximityPlacementGroup
SubResource
priority
String
evictionPolicy
String
billingProfile
BillingProfile
hostGroup
SubResource
provisioningState
String
licenseType
String
vmId
String
extensionsTimeBudget
String

Applies to

VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String, Nullable<Int32>)

public VirtualMachine (string location, string id, string name, string type, System.Collections.Generic.IDictionary<string,string> tags, Microsoft.Azure.Management.Compute.Models.Plan plan, Microsoft.Azure.Management.Compute.Models.HardwareProfile hardwareProfile, Microsoft.Azure.Management.Compute.Models.StorageProfile storageProfile, Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities additionalCapabilities, Microsoft.Azure.Management.Compute.Models.OSProfile osProfile, Microsoft.Azure.Management.Compute.Models.NetworkProfile networkProfile, Microsoft.Azure.Management.Compute.Models.SecurityProfile securityProfile, Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile diagnosticsProfile, Microsoft.Azure.Management.Compute.Models.SubResource availabilitySet, Microsoft.Azure.Management.Compute.Models.SubResource virtualMachineScaleSet, Microsoft.Azure.Management.Compute.Models.SubResource proximityPlacementGroup, string priority, string evictionPolicy, Microsoft.Azure.Management.Compute.Models.BillingProfile billingProfile, Microsoft.Azure.Management.Compute.Models.SubResource host, Microsoft.Azure.Management.Compute.Models.SubResource hostGroup, string provisioningState, Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView instanceView, string licenseType, string vmId, string extensionsTimeBudget, int? platformFaultDomain);
new Microsoft.Azure.Management.Compute.Models.VirtualMachine : string * string * string * string * System.Collections.Generic.IDictionary<string, string> * Microsoft.Azure.Management.Compute.Models.Plan * Microsoft.Azure.Management.Compute.Models.HardwareProfile * Microsoft.Azure.Management.Compute.Models.StorageProfile * Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities * Microsoft.Azure.Management.Compute.Models.OSProfile * Microsoft.Azure.Management.Compute.Models.NetworkProfile * Microsoft.Azure.Management.Compute.Models.SecurityProfile * Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * string * Microsoft.Azure.Management.Compute.Models.BillingProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView * string * string * string * Nullable<int> -> Microsoft.Azure.Management.Compute.Models.VirtualMachine
Public Sub New (location As String, id As String, name As String, type As String, tags As IDictionary(Of String, String), plan As Plan, hardwareProfile As HardwareProfile, storageProfile As StorageProfile, additionalCapabilities As AdditionalCapabilities, osProfile As OSProfile, networkProfile As NetworkProfile, securityProfile As SecurityProfile, diagnosticsProfile As DiagnosticsProfile, availabilitySet As SubResource, virtualMachineScaleSet As SubResource, proximityPlacementGroup As SubResource, priority As String, evictionPolicy As String, billingProfile As BillingProfile, host As SubResource, hostGroup As SubResource, provisioningState As String, instanceView As VirtualMachineInstanceView, licenseType As String, vmId As String, extensionsTimeBudget As String, platformFaultDomain As Nullable(Of Integer))

Parameters

location
String
id
String
name
String
type
String
plan
Plan
hardwareProfile
HardwareProfile
storageProfile
StorageProfile
additionalCapabilities
AdditionalCapabilities
osProfile
OSProfile
networkProfile
NetworkProfile
securityProfile
SecurityProfile
diagnosticsProfile
DiagnosticsProfile
availabilitySet
SubResource
virtualMachineScaleSet
SubResource
proximityPlacementGroup
SubResource
priority
String
evictionPolicy
String
billingProfile
BillingProfile
hostGroup
SubResource
provisioningState
String
licenseType
String
vmId
String
extensionsTimeBudget
String
platformFaultDomain
Nullable<Int32>

Applies to

VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String, IList<VirtualMachineExtension>)

Initializes a new instance of the VirtualMachine class.

public VirtualMachine (string location, string id, string name, string type, System.Collections.Generic.IDictionary<string,string> tags, Microsoft.Azure.Management.Compute.Models.Plan plan, Microsoft.Azure.Management.Compute.Models.HardwareProfile hardwareProfile, Microsoft.Azure.Management.Compute.Models.StorageProfile storageProfile, Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities additionalCapabilities, Microsoft.Azure.Management.Compute.Models.OSProfile osProfile, Microsoft.Azure.Management.Compute.Models.NetworkProfile networkProfile, Microsoft.Azure.Management.Compute.Models.SecurityProfile securityProfile, Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile diagnosticsProfile, Microsoft.Azure.Management.Compute.Models.SubResource availabilitySet, Microsoft.Azure.Management.Compute.Models.SubResource virtualMachineScaleSet, Microsoft.Azure.Management.Compute.Models.SubResource proximityPlacementGroup, string priority, string evictionPolicy, Microsoft.Azure.Management.Compute.Models.BillingProfile billingProfile, Microsoft.Azure.Management.Compute.Models.SubResource host, Microsoft.Azure.Management.Compute.Models.SubResource hostGroup, string provisioningState, Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView instanceView, string licenseType, string vmId, string extensionsTimeBudget, System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension> resources);
new Microsoft.Azure.Management.Compute.Models.VirtualMachine : string * string * string * string * System.Collections.Generic.IDictionary<string, string> * Microsoft.Azure.Management.Compute.Models.Plan * Microsoft.Azure.Management.Compute.Models.HardwareProfile * Microsoft.Azure.Management.Compute.Models.StorageProfile * Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities * Microsoft.Azure.Management.Compute.Models.OSProfile * Microsoft.Azure.Management.Compute.Models.NetworkProfile * Microsoft.Azure.Management.Compute.Models.SecurityProfile * Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * string * Microsoft.Azure.Management.Compute.Models.BillingProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView * string * string * string * System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension> -> Microsoft.Azure.Management.Compute.Models.VirtualMachine
Public Sub New (location As String, id As String, name As String, type As String, tags As IDictionary(Of String, String), plan As Plan, hardwareProfile As HardwareProfile, storageProfile As StorageProfile, additionalCapabilities As AdditionalCapabilities, osProfile As OSProfile, networkProfile As NetworkProfile, securityProfile As SecurityProfile, diagnosticsProfile As DiagnosticsProfile, availabilitySet As SubResource, virtualMachineScaleSet As SubResource, proximityPlacementGroup As SubResource, priority As String, evictionPolicy As String, billingProfile As BillingProfile, host As SubResource, hostGroup As SubResource, provisioningState As String, instanceView As VirtualMachineInstanceView, licenseType As String, vmId As String, extensionsTimeBudget As String, resources As IList(Of VirtualMachineExtension))

Parameters

location
String

Resource location

id
String

Resource Id

name
String

Resource name

type
String

Resource type

tags
IDictionary<String,String>

Resource tags

plan
Plan

Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.

hardwareProfile
HardwareProfile

Specifies the hardware settings for the virtual machine.

storageProfile
StorageProfile

Specifies the storage settings for the virtual machine disks.

additionalCapabilities
AdditionalCapabilities

Specifies additional capabilities enabled or disabled on the virtual machine.

osProfile
OSProfile

Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned.

networkProfile
NetworkProfile

Specifies the network interfaces of the virtual machine.

securityProfile
SecurityProfile

Specifies the Security related profile settings for the virtual machine.

diagnosticsProfile
DiagnosticsProfile

Specifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15.

availabilitySet
SubResource

Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Manage the availability of virtual machines. <br><br> For more information on Azure planned maintenance, see Planned maintenance for virtual machines in Azure <br><br> Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. <br><br>This property cannot exist along with a non-null properties.virtualMachineScaleSet reference.

virtualMachineScaleSet
SubResource

Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. <br><br>This property cannot exist along with a non-null properties.availabilitySet reference. <br><br>Minimum api‐version: 2019‐03‐01

proximityPlacementGroup
SubResource

Specifies information about the proximity placement group that the virtual machine should be assigned to. <br><br>Minimum api-version: 2018-04-01.

priority
String

Specifies the priority for the virtual machine. <br><br>Minimum api-version: 2019-03-01. Possible values include: 'Regular', 'Low', 'Spot'

evictionPolicy
String

Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. <br><br>For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. <br><br>For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. Possible values include: 'Deallocate', 'Delete'

billingProfile
BillingProfile

Specifies the billing related details of a Azure Spot virtual machine. <br><br>Minimum api-version: 2019-03-01.

host
SubResource

Specifies information about the dedicated host that the virtual machine resides in. <br><br>Minimum api-version: 2018-10-01.

hostGroup
SubResource

Specifies information about the dedicated host group that the virtual machine resides in. <br><br>Minimum api-version: 2020-06-01. <br><br>NOTE: User cannot specify both host and hostGroup properties.

provisioningState
String

The provisioning state, which only appears in the response.

instanceView
VirtualMachineInstanceView

The virtual machine instance view.

licenseType
String

Specifies that the image or disk that is being used was licensed on-premises. <br><br> Possible values for Windows Server operating system are: <br><br> Windows_Client <br><br> Windows_Server <br><br> Possible values for Linux Server operating system are: <br><br> RHEL_BYOS (for RHEL) <br><br> SLES_BYOS (for SUSE) <br><br> For more information, see Azure Hybrid Use Benefit for Windows Server <br><br> Azure Hybrid Use Benefit for Linux Server <br><br> Minimum api-version: 2015-06-15

vmId
String

Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands.

extensionsTimeBudget
String

Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). <br><br> Minimum api-version: 2020-06-01

resources
IList<VirtualMachineExtension>

The virtual machine child extension resources.

Applies to

VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String)

public VirtualMachine (string location, string id, string name, string type, System.Collections.Generic.IDictionary<string,string> tags, Microsoft.Azure.Management.Compute.Models.Plan plan, Microsoft.Azure.Management.Compute.Models.HardwareProfile hardwareProfile, Microsoft.Azure.Management.Compute.Models.StorageProfile storageProfile, Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities additionalCapabilities, Microsoft.Azure.Management.Compute.Models.OSProfile osProfile, Microsoft.Azure.Management.Compute.Models.NetworkProfile networkProfile, Microsoft.Azure.Management.Compute.Models.SecurityProfile securityProfile, Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile diagnosticsProfile, Microsoft.Azure.Management.Compute.Models.SubResource availabilitySet, Microsoft.Azure.Management.Compute.Models.SubResource virtualMachineScaleSet, Microsoft.Azure.Management.Compute.Models.SubResource proximityPlacementGroup, string priority, string evictionPolicy, Microsoft.Azure.Management.Compute.Models.BillingProfile billingProfile, Microsoft.Azure.Management.Compute.Models.SubResource host, Microsoft.Azure.Management.Compute.Models.SubResource hostGroup, string provisioningState, Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView instanceView, string licenseType, string vmId, string extensionsTimeBudget);
new Microsoft.Azure.Management.Compute.Models.VirtualMachine : string * string * string * string * System.Collections.Generic.IDictionary<string, string> * Microsoft.Azure.Management.Compute.Models.Plan * Microsoft.Azure.Management.Compute.Models.HardwareProfile * Microsoft.Azure.Management.Compute.Models.StorageProfile * Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities * Microsoft.Azure.Management.Compute.Models.OSProfile * Microsoft.Azure.Management.Compute.Models.NetworkProfile * Microsoft.Azure.Management.Compute.Models.SecurityProfile * Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * string * Microsoft.Azure.Management.Compute.Models.BillingProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView * string * string * string -> Microsoft.Azure.Management.Compute.Models.VirtualMachine
Public Sub New (location As String, id As String, name As String, type As String, tags As IDictionary(Of String, String), plan As Plan, hardwareProfile As HardwareProfile, storageProfile As StorageProfile, additionalCapabilities As AdditionalCapabilities, osProfile As OSProfile, networkProfile As NetworkProfile, securityProfile As SecurityProfile, diagnosticsProfile As DiagnosticsProfile, availabilitySet As SubResource, virtualMachineScaleSet As SubResource, proximityPlacementGroup As SubResource, priority As String, evictionPolicy As String, billingProfile As BillingProfile, host As SubResource, hostGroup As SubResource, provisioningState As String, instanceView As VirtualMachineInstanceView, licenseType As String, vmId As String, extensionsTimeBudget As String)

Parameters

location
String
id
String
name
String
type
String
plan
Plan
hardwareProfile
HardwareProfile
storageProfile
StorageProfile
additionalCapabilities
AdditionalCapabilities
osProfile
OSProfile
networkProfile
NetworkProfile
securityProfile
SecurityProfile
diagnosticsProfile
DiagnosticsProfile
availabilitySet
SubResource
virtualMachineScaleSet
SubResource
proximityPlacementGroup
SubResource
priority
String
evictionPolicy
String
billingProfile
BillingProfile
hostGroup
SubResource
provisioningState
String
licenseType
String
vmId
String
extensionsTimeBudget
String

Applies to

VirtualMachine(String, String, String, String, IDictionary<String, String>, Plan, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, SecurityProfile, DiagnosticsProfile, SubResource, SubResource, SubResource, String, String, BillingProfile, SubResource, SubResource, String, VirtualMachineInstanceView, String, String, String, Nullable<Int32>, ScheduledEventsProfile, IList<VirtualMachineExtension>, VirtualMachineIdentity, IList<String>)

Initializes a new instance of the VirtualMachine class.

public VirtualMachine (string location, string id, string name, string type, System.Collections.Generic.IDictionary<string,string> tags, Microsoft.Azure.Management.Compute.Models.Plan plan, Microsoft.Azure.Management.Compute.Models.HardwareProfile hardwareProfile, Microsoft.Azure.Management.Compute.Models.StorageProfile storageProfile, Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities additionalCapabilities, Microsoft.Azure.Management.Compute.Models.OSProfile osProfile, Microsoft.Azure.Management.Compute.Models.NetworkProfile networkProfile, Microsoft.Azure.Management.Compute.Models.SecurityProfile securityProfile, Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile diagnosticsProfile, Microsoft.Azure.Management.Compute.Models.SubResource availabilitySet, Microsoft.Azure.Management.Compute.Models.SubResource virtualMachineScaleSet, Microsoft.Azure.Management.Compute.Models.SubResource proximityPlacementGroup, string priority, string evictionPolicy, Microsoft.Azure.Management.Compute.Models.BillingProfile billingProfile, Microsoft.Azure.Management.Compute.Models.SubResource host, Microsoft.Azure.Management.Compute.Models.SubResource hostGroup, string provisioningState, Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView instanceView, string licenseType, string vmId, string extensionsTimeBudget, int? platformFaultDomain, Microsoft.Azure.Management.Compute.Models.ScheduledEventsProfile scheduledEventsProfile, System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension> resources, Microsoft.Azure.Management.Compute.Models.VirtualMachineIdentity identity, System.Collections.Generic.IList<string> zones);
new Microsoft.Azure.Management.Compute.Models.VirtualMachine : string * string * string * string * System.Collections.Generic.IDictionary<string, string> * Microsoft.Azure.Management.Compute.Models.Plan * Microsoft.Azure.Management.Compute.Models.HardwareProfile * Microsoft.Azure.Management.Compute.Models.StorageProfile * Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities * Microsoft.Azure.Management.Compute.Models.OSProfile * Microsoft.Azure.Management.Compute.Models.NetworkProfile * Microsoft.Azure.Management.Compute.Models.SecurityProfile * Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * string * Microsoft.Azure.Management.Compute.Models.BillingProfile * Microsoft.Azure.Management.Compute.Models.SubResource * Microsoft.Azure.Management.Compute.Models.SubResource * string * Microsoft.Azure.Management.Compute.Models.VirtualMachineInstanceView * string * string * string * Nullable<int> * Microsoft.Azure.Management.Compute.Models.ScheduledEventsProfile * System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension> * Microsoft.Azure.Management.Compute.Models.VirtualMachineIdentity * System.Collections.Generic.IList<string> -> Microsoft.Azure.Management.Compute.Models.VirtualMachine
Public Sub New (location As String, id As String, name As String, type As String, tags As IDictionary(Of String, String), plan As Plan, hardwareProfile As HardwareProfile, storageProfile As StorageProfile, additionalCapabilities As AdditionalCapabilities, osProfile As OSProfile, networkProfile As NetworkProfile, securityProfile As SecurityProfile, diagnosticsProfile As DiagnosticsProfile, availabilitySet As SubResource, virtualMachineScaleSet As SubResource, proximityPlacementGroup As SubResource, priority As String, evictionPolicy As String, billingProfile As BillingProfile, host As SubResource, hostGroup As SubResource, provisioningState As String, instanceView As VirtualMachineInstanceView, licenseType As String, vmId As String, extensionsTimeBudget As String, platformFaultDomain As Nullable(Of Integer), scheduledEventsProfile As ScheduledEventsProfile, resources As IList(Of VirtualMachineExtension), identity As VirtualMachineIdentity, zones As IList(Of String))

Parameters

location
String

Resource location

id
String

Resource Id

name
String

Resource name

type
String

Resource type

tags
IDictionary<String,String>

Resource tags

plan
Plan

Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.

hardwareProfile
HardwareProfile

Specifies the hardware settings for the virtual machine.

storageProfile
StorageProfile

Specifies the storage settings for the virtual machine disks.

additionalCapabilities
AdditionalCapabilities

Specifies additional capabilities enabled or disabled on the virtual machine.

osProfile
OSProfile

Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned.

networkProfile
NetworkProfile

Specifies the network interfaces of the virtual machine.

securityProfile
SecurityProfile

Specifies the Security related profile settings for the virtual machine.

diagnosticsProfile
DiagnosticsProfile

Specifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15.

availabilitySet
SubResource

Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Availability sets overview. <br><br> For more information on Azure planned maintenance, see Maintenance and updates for Virtual Machines in Azure <br><br> Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. <br><br>This property cannot exist along with a non-null properties.virtualMachineScaleSet reference.

virtualMachineScaleSet
SubResource

Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. <br><br>This property cannot exist along with a non-null properties.availabilitySet reference. <br><br>Minimum api‐version: 2019‐03‐01

proximityPlacementGroup
SubResource

Specifies information about the proximity placement group that the virtual machine should be assigned to. <br><br>Minimum api-version: 2018-04-01.

priority
String

Specifies the priority for the virtual machine. <br><br>Minimum api-version: 2019-03-01. Possible values include: 'Regular', 'Low', 'Spot'

evictionPolicy
String

Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. <br><br>For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. <br><br>For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. Possible values include: 'Deallocate', 'Delete'

billingProfile
BillingProfile

Specifies the billing related details of a Azure Spot virtual machine. <br><br>Minimum api-version: 2019-03-01.

host
SubResource

Specifies information about the dedicated host that the virtual machine resides in. <br><br>Minimum api-version: 2018-10-01.

hostGroup
SubResource

Specifies information about the dedicated host group that the virtual machine resides in. <br><br>Minimum api-version: 2020-06-01. <br><br>NOTE: User cannot specify both host and hostGroup properties.

provisioningState
String

The provisioning state, which only appears in the response.

instanceView
VirtualMachineInstanceView

The virtual machine instance view.

licenseType
String

Specifies that the image or disk that is being used was licensed on-premises. <br><br> Possible values for Windows Server operating system are: <br><br> Windows_Client <br><br> Windows_Server <br><br> Possible values for Linux Server operating system are: <br><br> RHEL_BYOS (for RHEL) <br><br> SLES_BYOS (for SUSE) <br><br> For more information, see Azure Hybrid Use Benefit for Windows Server <br><br> Azure Hybrid Use Benefit for Linux Server <br><br> Minimum api-version: 2015-06-15

vmId
String

Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands.

extensionsTimeBudget
String

Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). <br><br> Minimum api-version: 2020-06-01

platformFaultDomain
Nullable<Int32>

Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains.<br><li>This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set.<li>The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' &gt; 1.<li>This property cannot be updated once the Virtual Machine is created.<li>Fault domain assignment can be viewed in the Virtual Machine Instance View.<br><br>Minimum api‐version: 2020‐12‐01

scheduledEventsProfile
ScheduledEventsProfile

Specifies Scheduled Event related configurations.

resources
IList<VirtualMachineExtension>

The virtual machine child extension resources.

identity
VirtualMachineIdentity

The identity of the virtual machine, if configured.

zones
IList<String>

The virtual machine zones.

Applies to