azure.mgmt.compute.v2023_09_01.models.VirtualMachineImage.yml

### YamlMime:PythonClass
uid: azure.mgmt.compute.v2023_09_01.models.VirtualMachineImage
name: VirtualMachineImage
fullName: azure.mgmt.compute.v2023_09_01.models.VirtualMachineImage
module: azure.mgmt.compute.v2023_09_01.models
inheritances:
- azure.mgmt.compute.v2023_09_01.models._models_py3.VirtualMachineImageResource
summary: 'Describes a Virtual Machine Image.


  All required parameters must be populated in order to send to server.'
constructor:
  syntax: 'VirtualMachineImage(*, name: str, location: str, id: str | None = None,
    tags: Dict[str, str] | None = None, extended_location: _models.ExtendedLocation
    | None = None, plan: _models.PurchasePlan | None = None, os_disk_image: _models.OSDiskImage
    | None = None, data_disk_images: List[_models.DataDiskImage] | None = None, automatic_os_upgrade_properties:
    _models.AutomaticOSUpgradeProperties | None = None, hyper_v_generation: str |
    _models.HyperVGenerationTypes | None = None, disallowed: _models.DisallowedConfiguration
    | None = None, features: List[_models.VirtualMachineImageFeature] | None = None,
    architecture: str | _models.ArchitectureTypes | None = None, image_deprecation_status:
    _models.ImageDeprecationStatus | None = None, **kwargs: Any)'
  keywordOnlyParameters:
  - name: id
    description: Resource Id.
    types:
    - <xref:str>
  - name: name
    description: The name of the resource. Required.
    types:
    - <xref:str>
  - name: location
    description: The supported Azure location of the resource. Required.
    types:
    - <xref:str>
  - name: tags
    description: 'Specifies the tags that are assigned to the virtual machine. For
      more

      information about using tags, see [Using tags to organize your Azure resources](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md).'
    types:
    - <xref:dict>[<xref:str>, <xref:str>]
  - name: extended_location
    description: The extended location of the Virtual Machine.
    types:
    - <xref:azure.mgmt.compute.v2023_09_01.models.ExtendedLocation>
  - name: plan
    description: 'Used for establishing the purchase context of any 3rd Party artifact
      through

      MarketPlace.'
    types:
    - <xref:azure.mgmt.compute.v2023_09_01.models.PurchasePlan>
  - name: os_disk_image
    description: Contains the os disk image information.
    types:
    - <xref:azure.mgmt.compute.v2023_09_01.models.OSDiskImage>
  - name: data_disk_images
    types:
    - <xref:list>[<xref:azure.mgmt.compute.v2023_09_01.models.DataDiskImage>]
  - name: automatic_os_upgrade_properties
    description: 'Describes automatic OS upgrade properties on the

      image.'
    types:
    - <xref:azure.mgmt.compute.v2023_09_01.models.AutomaticOSUpgradeProperties>
  - name: hyper_v_generation
    description: 'Specifies the HyperVGeneration Type. Known values are: "V1" and

      "V2".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.compute.v2023_09_01.models.HyperVGenerationTypes>
  - name: disallowed
    description: 'Specifies disallowed configuration for the VirtualMachine created
      from the

      image.'
    types:
    - <xref:azure.mgmt.compute.v2023_09_01.models.DisallowedConfiguration>
  - name: features
    types:
    - <xref:list>[<xref:azure.mgmt.compute.v2023_09_01.models.VirtualMachineImageFeature>]
  - name: architecture
    description: 'Specifies the Architecture Type. Known values are: "x64" and "Arm64".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.compute.v2023_09_01.models.ArchitectureTypes>
  - name: image_deprecation_status
    description: Describes image deprecation status properties on the image.
    types:
    - <xref:azure.mgmt.compute.v2023_09_01.models.ImageDeprecationStatus>
variables:
- description: Resource Id.
  name: id
  types:
  - <xref:str>
- description: The name of the resource. Required.
  name: name
  types:
  - <xref:str>
- description: The supported Azure location of the resource. Required.
  name: location
  types:
  - <xref:str>
- description: 'Specifies the tags that are assigned to the virtual machine. For more
    information

    about using tags, see [Using tags to organize your Azure resources](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md).'
  name: tags
  types:
  - <xref:dict>[<xref:str>, <xref:str>]
- description: The extended location of the Virtual Machine.
  name: extended_location
  types:
  - <xref:azure.mgmt.compute.v2023_09_01.models.ExtendedLocation>
- description: 'Used for establishing the purchase context of any 3rd Party artifact
    through

    MarketPlace.'
  name: plan
  types:
  - <xref:azure.mgmt.compute.v2023_09_01.models.PurchasePlan>
- description: Contains the os disk image information.
  name: os_disk_image
  types:
  - <xref:azure.mgmt.compute.v2023_09_01.models.OSDiskImage>
- name: data_disk_images
  types:
  - <xref:list>[<xref:azure.mgmt.compute.v2023_09_01.models.DataDiskImage>]
- description: Describes automatic OS upgrade properties on the image.
  name: automatic_os_upgrade_properties
  types:
  - <xref:azure.mgmt.compute.v2023_09_01.models.AutomaticOSUpgradeProperties>
- description: 'Specifies the HyperVGeneration Type. Known values are: "V1" and "V2".'
  name: hyper_v_generation
  types:
  - <xref:str>
  - <xref:azure.mgmt.compute.v2023_09_01.models.HyperVGenerationTypes>
- description: 'Specifies disallowed configuration for the VirtualMachine created
    from the

    image.'
  name: disallowed
  types:
  - <xref:azure.mgmt.compute.v2023_09_01.models.DisallowedConfiguration>
- name: features
  types:
  - <xref:list>[<xref:azure.mgmt.compute.v2023_09_01.models.VirtualMachineImageFeature>]
- description: 'Specifies the Architecture Type. Known values are: "x64" and "Arm64".'
  name: architecture
  types:
  - <xref:str>
  - <xref:azure.mgmt.compute.v2023_09_01.models.ArchitectureTypes>
- description: Describes image deprecation status properties on the image.
  name: image_deprecation_status
  types:
  - <xref:azure.mgmt.compute.v2023_09_01.models.ImageDeprecationStatus>