class Azure::Compute::Mgmt::V2019_12_01::Models::VirtualMachine
Describes a Virtual Machine.
Attributes
@return [AdditionalCapabilities] Specifies additional capabilities enabled or disabled on the virtual machine.
@return [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](docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).
For more information on Azure
planned maintenance, see [Planned maintenance for virtual machines in Azure](docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)
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.
@return [BillingProfile] Specifies the billing related details of a Azure
Spot virtual machine.
Minimum api-version: 2019-03-01.
@return [DiagnosticsProfile] Specifies the boot diagnostic settings state.
Minimum api-version: 2015-06-15.
@return [VirtualMachineEvictionPolicyTypes] 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'
@return [HardwareProfile] Specifies the hardware settings for the virtual machine.
@return [SubResource] Specifies information about the dedicated host that the virtual machine resides in.
Minimum api-version: 2018-10-01.
@return [VirtualMachineIdentity] The identity of the virtual machine, if configured.
@return [VirtualMachineInstanceView] The virtual machine instance view.
@return [String] Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.
Possible values are:
Windows_Client
Windows_Server
If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.
For more information, see [Azure Hybrid Use Benefit for Windows Server](docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)
Minimum api-version: 2015-06-15
@return [NetworkProfile] Specifies the network interfaces of the virtual machine.
@return [OSProfile] Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned.
@return [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*.
@return [VirtualMachinePriorityTypes] Specifies the priority for the virtual machine.
Minimum api-version: 2019-03-01. Possible values include: 'Regular', 'Low', 'Spot'
@return [String] The provisioning state, which only appears in the response.
@return [SubResource] Specifies information about the proximity placement group that the virtual machine should be assigned to.
Minimum api-version: 2018-04-01.
@return [Array<VirtualMachineExtension>] The virtual machine child extension resources.
@return [StorageProfile] Specifies the storage settings for the virtual machine disks.
@return [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
@return [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.
@return [Array<String>] The virtual machine zones.
Public Class Methods
Mapper for VirtualMachine
class as Ruby Hash. This will be used for serialization/deserialization.
# File lib/2019-12-01/generated/azure_mgmt_compute/models/virtual_machine.rb, line 143 def self.mapper() { client_side_validation: true, required: false, serialized_name: 'VirtualMachine', type: { name: 'Composite', class_name: 'VirtualMachine', model_properties: { id: { client_side_validation: true, required: false, read_only: true, serialized_name: 'id', type: { name: 'String' } }, name: { client_side_validation: true, required: false, read_only: true, serialized_name: 'name', type: { name: 'String' } }, type: { client_side_validation: true, required: false, read_only: true, serialized_name: 'type', type: { name: 'String' } }, location: { client_side_validation: true, required: true, serialized_name: 'location', type: { name: 'String' } }, tags: { client_side_validation: true, required: false, serialized_name: 'tags', type: { name: 'Dictionary', value: { client_side_validation: true, required: false, serialized_name: 'StringElementType', type: { name: 'String' } } } }, plan: { client_side_validation: true, required: false, serialized_name: 'plan', type: { name: 'Composite', class_name: 'Plan' } }, hardware_profile: { client_side_validation: true, required: false, serialized_name: 'properties.hardwareProfile', type: { name: 'Composite', class_name: 'HardwareProfile' } }, storage_profile: { client_side_validation: true, required: false, serialized_name: 'properties.storageProfile', type: { name: 'Composite', class_name: 'StorageProfile' } }, additional_capabilities: { client_side_validation: true, required: false, serialized_name: 'properties.additionalCapabilities', type: { name: 'Composite', class_name: 'AdditionalCapabilities' } }, os_profile: { client_side_validation: true, required: false, serialized_name: 'properties.osProfile', type: { name: 'Composite', class_name: 'OSProfile' } }, network_profile: { client_side_validation: true, required: false, serialized_name: 'properties.networkProfile', type: { name: 'Composite', class_name: 'NetworkProfile' } }, diagnostics_profile: { client_side_validation: true, required: false, serialized_name: 'properties.diagnosticsProfile', type: { name: 'Composite', class_name: 'DiagnosticsProfile' } }, availability_set: { client_side_validation: true, required: false, serialized_name: 'properties.availabilitySet', type: { name: 'Composite', class_name: 'SubResource' } }, virtual_machine_scale_set: { client_side_validation: true, required: false, serialized_name: 'properties.virtualMachineScaleSet', type: { name: 'Composite', class_name: 'SubResource' } }, proximity_placement_group: { client_side_validation: true, required: false, serialized_name: 'properties.proximityPlacementGroup', type: { name: 'Composite', class_name: 'SubResource' } }, priority: { client_side_validation: true, required: false, serialized_name: 'properties.priority', type: { name: 'String' } }, eviction_policy: { client_side_validation: true, required: false, serialized_name: 'properties.evictionPolicy', type: { name: 'String' } }, billing_profile: { client_side_validation: true, required: false, serialized_name: 'properties.billingProfile', type: { name: 'Composite', class_name: 'BillingProfile' } }, host: { client_side_validation: true, required: false, serialized_name: 'properties.host', type: { name: 'Composite', class_name: 'SubResource' } }, provisioning_state: { client_side_validation: true, required: false, read_only: true, serialized_name: 'properties.provisioningState', type: { name: 'String' } }, instance_view: { client_side_validation: true, required: false, read_only: true, serialized_name: 'properties.instanceView', type: { name: 'Composite', class_name: 'VirtualMachineInstanceView' } }, license_type: { client_side_validation: true, required: false, serialized_name: 'properties.licenseType', type: { name: 'String' } }, vm_id: { client_side_validation: true, required: false, read_only: true, serialized_name: 'properties.vmId', type: { name: 'String' } }, resources: { client_side_validation: true, required: false, read_only: true, serialized_name: 'resources', type: { name: 'Sequence', element: { client_side_validation: true, required: false, serialized_name: 'VirtualMachineExtensionElementType', type: { name: 'Composite', class_name: 'VirtualMachineExtension' } } } }, identity: { client_side_validation: true, required: false, serialized_name: 'identity', type: { name: 'Composite', class_name: 'VirtualMachineIdentity' } }, zones: { client_side_validation: true, required: false, serialized_name: 'zones', type: { name: 'Sequence', element: { client_side_validation: true, required: false, serialized_name: 'StringElementType', type: { name: 'String' } } } } } } } end