azure.mgmt.compute.v2023_07_01.models.VirtualMachine.yml

### YamlMime:PythonClass
uid: azure.mgmt.compute.v2023_07_01.models.VirtualMachine
name: VirtualMachine
fullName: azure.mgmt.compute.v2023_07_01.models.VirtualMachine
module: azure.mgmt.compute.v2023_07_01.models
inheritances:
- azure.mgmt.compute.v2023_07_01.models._models_py3.Resource
summary: 'Describes a Virtual Machine.


  Variables are only populated by the server, and will be ignored when sending a request.


  All required parameters must be populated in order to send to server.'
constructor:
  syntax: 'VirtualMachine(*, location: str, tags: Dict[str, str] | None = None, plan:
    _models.Plan | None = None, identity: _models.VirtualMachineIdentity | None =
    None, zones: List[str] | None = None, extended_location: _models.ExtendedLocation
    | None = None, hardware_profile: _models.HardwareProfile | None = None, storage_profile:
    _models.StorageProfile | None = None, additional_capabilities: _models.AdditionalCapabilities
    | None = None, os_profile: _models.OSProfile | None = None, network_profile: _models.NetworkProfile
    | None = None, security_profile: _models.SecurityProfile | None = None, diagnostics_profile:
    _models.DiagnosticsProfile | None = None, availability_set: _models.SubResource
    | None = None, virtual_machine_scale_set: _models.SubResource | None = None, proximity_placement_group:
    _models.SubResource | None = None, priority: str | _models.VirtualMachinePriorityTypes
    | None = None, eviction_policy: str | _models.VirtualMachineEvictionPolicyTypes
    | None = None, billing_profile: _models.BillingProfile | None = None, host: _models.SubResource
    | None = None, host_group: _models.SubResource | None = None, license_type: str
    | None = None, extensions_time_budget: str | None = None, platform_fault_domain:
    int | None = None, scheduled_events_profile: _models.ScheduledEventsProfile |
    None = None, user_data: str | None = None, capacity_reservation: _models.CapacityReservationProfile
    | None = None, application_profile: _models.ApplicationProfile | None = None,
    **kwargs: Any)'
  keywordOnlyParameters:
  - name: location
    description: Resource location. Required.
    types:
    - <xref:str>
  - name: tags
    description: Resource tags.
    types:
    - <xref:dict>[<xref:str>, <xref:str>]
  - name: plan
    description: '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**.'
    types:
    - <xref:azure.mgmt.compute.v2023_07_01.models.Plan>
  - name: identity
    description: The identity of the virtual machine, if configured.
    types:
    - <xref:azure.mgmt.compute.v2023_07_01.models.VirtualMachineIdentity>
  - name: zones
    description: The virtual machine zones.
    types:
    - <xref:list>[<xref:str>]
  - name: extended_location
    description: The extended location of the Virtual Machine.
    types:
    - <xref:azure.mgmt.compute.v2023_07_01.models.ExtendedLocation>
  - name: hardware_profile
    description: Specifies the hardware settings for the virtual machine.
    types:
    - <xref:azure.mgmt.compute.v2023_07_01.models.HardwareProfile>
  - name: storage_profile
    description: Specifies the storage settings for the virtual machine disks.
    types:
    - <xref:azure.mgmt.compute.v2023_07_01.models.StorageProfile>
  - name: additional_capabilities
    description: 'Specifies additional capabilities enabled or disabled on the

      virtual machine.'
    types:
    - <xref:azure.mgmt.compute.v2023_07_01.models.AdditionalCapabilities>
  - name: os_profile
    description: 'Specifies the operating system settings used while creating the
      virtual

      machine. Some of the settings cannot be changed once VM is provisioned.'
    types:
    - <xref:azure.mgmt.compute.v2023_07_01.models.OSProfile>
  - name: network_profile
    description: Specifies the network interfaces of the virtual machine.
    types:
    - <xref:azure.mgmt.compute.v2023_07_01.models.NetworkProfile>
  - name: security_profile
    description: 'Specifies the Security related profile settings for the virtual

      machine.'
    types:
    - <xref:azure.mgmt.compute.v2023_07_01.models.SecurityProfile>
  - name: diagnostics_profile
    description: 'Specifies the boot diagnostic settings state. Minimum

      api-version: 2015-06-15.'
    types:
    - <xref:azure.mgmt.compute.v2023_07_01.models.DiagnosticsProfile>
  - name: availability_set
    description: '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](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview).
      For more

      information on Azure planned maintenance, see [Maintenance and updates for Virtual
      Machines in

      Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates).
      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.'
    types:
    - <xref:azure.mgmt.compute.v2023_07_01.models.SubResource>
  - name: virtual_machine_scale_set
    description: "Specifies information about the virtual machine scale set\nthat\
      \ the virtual machine should be assigned to. Virtual machines specified in the\
      \ same virtual\nmachine scale set are allocated to different nodes to maximize\
      \ availability. Currently, a VM\ncan only be added to virtual machine scale\
      \ set at creation time. An existing VM cannot be added\nto a virtual machine\
      \ scale set. This property cannot exist along with a non-null\nproperties.availabilitySet\
      \ reference. Minimum api\u2010version: 2019\u201003\u201001."
    types:
    - <xref:azure.mgmt.compute.v2023_07_01.models.SubResource>
  - name: proximity_placement_group
    description: 'Specifies information about the proximity placement group

      that the virtual machine should be assigned to. Minimum api-version: 2018-04-01.'
    types:
    - <xref:azure.mgmt.compute.v2023_07_01.models.SubResource>
  - name: priority
    description: 'Specifies the priority for the virtual machine. Minimum api-version:

      2019-03-01. Known values are: "Regular", "Low", and "Spot".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.compute.v2023_07_01.models.VirtualMachinePriorityTypes>
  - name: eviction_policy
    description: '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.

      Known values are: "Deallocate" and "Delete".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.compute.v2023_07_01.models.VirtualMachineEvictionPolicyTypes>
  - name: billing_profile
    description: 'Specifies the billing related details of a Azure Spot virtual

      machine. Minimum api-version: 2019-03-01.'
    types:
    - <xref:azure.mgmt.compute.v2023_07_01.models.BillingProfile>
  - name: host
    description: 'Specifies information about the dedicated host that the virtual
      machine resides

      in. Minimum api-version: 2018-10-01.'
    types:
    - <xref:azure.mgmt.compute.v2023_07_01.models.SubResource>
  - name: host_group
    description: '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.'
    types:
    - <xref:azure.mgmt.compute.v2023_07_01.models.SubResource>
  - name: license_type
    description: '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](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

      `<br>``<br>` [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

      `<br>``<br>` Minimum api-version: 2015-06-15.'
    types:
    - <xref:str>
  - name: extensions_time_budget
    description: '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.'
    types:
    - <xref:str>
  - name: platform_fault_domain
    description: "Specifies the scale set logical fault domain into which the\nVirtual\
      \ Machine will be created. By default, the Virtual Machine will by automatically\
      \ assigned\nto a fault domain that best maintains balance across available fault\
      \ domains. This is\napplicable only if the 'virtualMachineScaleSet' property\
      \ of this Virtual Machine is set. The\nVirtual Machine Scale Set that is referenced,\
      \ must have 'platformFaultDomainCount' greater than\n1. This property cannot\
      \ be updated once the Virtual Machine is created. Fault domain assignment\n\
      can be viewed in the Virtual Machine Instance View. Minimum api\u2010version:\
      \ 2020\u201012\u201001."
    types:
    - <xref:int>
  - name: scheduled_events_profile
    description: Specifies Scheduled Event related configurations.
    types:
    - <xref:azure.mgmt.compute.v2023_07_01.models.ScheduledEventsProfile>
  - name: user_data
    description: 'UserData for the VM, which must be base-64 encoded. Customer should
      not

      pass any secrets in here. Minimum api-version: 2021-03-01.'
    types:
    - <xref:str>
  - name: capacity_reservation
    description: 'Specifies information about the capacity reservation that is

      used to allocate virtual machine. Minimum api-version: 2021-04-01.'
    types:
    - <xref:azure.mgmt.compute.v2023_07_01.models.CapacityReservationProfile>
  - name: application_profile
    description: 'Specifies the gallery applications that should be made available

      to the VM/VMSS.'
    types:
    - <xref:azure.mgmt.compute.v2023_07_01.models.ApplicationProfile>
variables:
- description: Resource Id.
  name: id
  types:
  - <xref:str>
- description: Resource name.
  name: name
  types:
  - <xref:str>
- description: Resource type.
  name: type
  types:
  - <xref:str>
- description: Resource location. Required.
  name: location
  types:
  - <xref:str>
- description: Resource tags.
  name: tags
  types:
  - <xref:dict>[<xref:str>, <xref:str>]
- description: '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**.'
  name: plan
  types:
  - <xref:azure.mgmt.compute.v2023_07_01.models.Plan>
- description: The virtual machine child extension resources.
  name: resources
  types:
  - <xref:list>[<xref:azure.mgmt.compute.v2023_07_01.models.VirtualMachineExtension>]
- description: The identity of the virtual machine, if configured.
  name: identity
  types:
  - <xref:azure.mgmt.compute.v2023_07_01.models.VirtualMachineIdentity>
- description: The virtual machine zones.
  name: zones
  types:
  - <xref:list>[<xref:str>]
- description: The extended location of the Virtual Machine.
  name: extended_location
  types:
  - <xref:azure.mgmt.compute.v2023_07_01.models.ExtendedLocation>
- description: Specifies the hardware settings for the virtual machine.
  name: hardware_profile
  types:
  - <xref:azure.mgmt.compute.v2023_07_01.models.HardwareProfile>
- description: Specifies the storage settings for the virtual machine disks.
  name: storage_profile
  types:
  - <xref:azure.mgmt.compute.v2023_07_01.models.StorageProfile>
- description: 'Specifies additional capabilities enabled or disabled on the

    virtual machine.'
  name: additional_capabilities
  types:
  - <xref:azure.mgmt.compute.v2023_07_01.models.AdditionalCapabilities>
- description: 'Specifies the operating system settings used while creating the virtual

    machine. Some of the settings cannot be changed once VM is provisioned.'
  name: os_profile
  types:
  - <xref:azure.mgmt.compute.v2023_07_01.models.OSProfile>
- description: Specifies the network interfaces of the virtual machine.
  name: network_profile
  types:
  - <xref:azure.mgmt.compute.v2023_07_01.models.NetworkProfile>
- description: 'Specifies the Security related profile settings for the virtual

    machine.'
  name: security_profile
  types:
  - <xref:azure.mgmt.compute.v2023_07_01.models.SecurityProfile>
- description: 'Specifies the boot diagnostic settings state. Minimum api-version:

    2015-06-15.'
  name: diagnostics_profile
  types:
  - <xref:azure.mgmt.compute.v2023_07_01.models.DiagnosticsProfile>
- description: '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](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview).
    For more

    information on Azure planned maintenance, see [Maintenance and updates for Virtual
    Machines in

    Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates).
    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.'
  name: availability_set
  types:
  - <xref:azure.mgmt.compute.v2023_07_01.models.SubResource>
- description: "Specifies information about the virtual machine scale set that\nthe\
    \ virtual machine should be assigned to. Virtual machines specified in the same\
    \ virtual\nmachine scale set are allocated to different nodes to maximize availability.\
    \ Currently, a VM\ncan only be added to virtual machine scale set at creation\
    \ time. An existing VM cannot be added\nto a virtual machine scale set. This property\
    \ cannot exist along with a non-null\nproperties.availabilitySet reference. Minimum\
    \ api\u2010version: 2019\u201003\u201001."
  name: virtual_machine_scale_set
  types:
  - <xref:azure.mgmt.compute.v2023_07_01.models.SubResource>
- description: 'Specifies information about the proximity placement group that

    the virtual machine should be assigned to. Minimum api-version: 2018-04-01.'
  name: proximity_placement_group
  types:
  - <xref:azure.mgmt.compute.v2023_07_01.models.SubResource>
- description: 'Specifies the priority for the virtual machine. Minimum api-version:

    2019-03-01. Known values are: "Regular", "Low", and "Spot".'
  name: priority
  types:
  - <xref:str>
  - <xref:azure.mgmt.compute.v2023_07_01.models.VirtualMachinePriorityTypes>
- description: '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.

    Known values are: "Deallocate" and "Delete".'
  name: eviction_policy
  types:
  - <xref:str>
  - <xref:azure.mgmt.compute.v2023_07_01.models.VirtualMachineEvictionPolicyTypes>
- description: 'Specifies the billing related details of a Azure Spot virtual machine.

    Minimum api-version: 2019-03-01.'
  name: billing_profile
  types:
  - <xref:azure.mgmt.compute.v2023_07_01.models.BillingProfile>
- description: 'Specifies information about the dedicated host that the virtual machine
    resides in.

    Minimum api-version: 2018-10-01.'
  name: host
  types:
  - <xref:azure.mgmt.compute.v2023_07_01.models.SubResource>
- description: '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.'
  name: host_group
  types:
  - <xref:azure.mgmt.compute.v2023_07_01.models.SubResource>
- description: The provisioning state, which only appears in the response.
  name: provisioning_state
  types:
  - <xref:str>
- description: The virtual machine instance view.
  name: instance_view
  types:
  - <xref:azure.mgmt.compute.v2023_07_01.models.VirtualMachineInstanceView>
- description: '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](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

    `<br>``<br>` [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

    `<br>``<br>` Minimum api-version: 2015-06-15.'
  name: license_type
  types:
  - <xref:str>
- description: '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.'
  name: vm_id
  types:
  - <xref:str>
- description: '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.'
  name: extensions_time_budget
  types:
  - <xref:str>
- description: "Specifies the scale set logical fault domain into which the\nVirtual\
    \ Machine will be created. By default, the Virtual Machine will by automatically\
    \ assigned\nto a fault domain that best maintains balance across available fault\
    \ domains. This is\napplicable only if the 'virtualMachineScaleSet' property of\
    \ this Virtual Machine is set. The\nVirtual Machine Scale Set that is referenced,\
    \ must have 'platformFaultDomainCount' greater than\n1. This property cannot be\
    \ updated once the Virtual Machine is created. Fault domain assignment\ncan be\
    \ viewed in the Virtual Machine Instance View. Minimum api\u2010version: 2020\u2010\
    12\u201001."
  name: platform_fault_domain
  types:
  - <xref:int>
- description: Specifies Scheduled Event related configurations.
  name: scheduled_events_profile
  types:
  - <xref:azure.mgmt.compute.v2023_07_01.models.ScheduledEventsProfile>
- description: 'UserData for the VM, which must be base-64 encoded. Customer should
    not pass

    any secrets in here. Minimum api-version: 2021-03-01.'
  name: user_data
  types:
  - <xref:str>
- description: 'Specifies information about the capacity reservation that is used

    to allocate virtual machine. Minimum api-version: 2021-04-01.'
  name: capacity_reservation
  types:
  - <xref:azure.mgmt.compute.v2023_07_01.models.CapacityReservationProfile>
- description: 'Specifies the gallery applications that should be made available to

    the VM/VMSS.'
  name: application_profile
  types:
  - <xref:azure.mgmt.compute.v2023_07_01.models.ApplicationProfile>
- description: 'Specifies the time at which the Virtual Machine resource was created.

    Minimum api-version: 2021-11-01.'
  name: time_created
  types:
  - <xref:datetime.datetime>