azure.mgmt.computefleet.models.ImageReference.yml

### YamlMime:PythonClass
uid: azure.mgmt.computefleet.models.ImageReference
name: ImageReference
fullName: azure.mgmt.computefleet.models.ImageReference
module: azure.mgmt.computefleet.models
summary: "Specifies information about the image to use. You can specify information\
  \ about\nplatform images, marketplace images, or virtual machine images. This element\
  \ is\nrequired when you want to use a platform image, marketplace image, or virtual\n\
  machine image, but is not used in other creation operations. NOTE: Image\nreference\
  \ publisher and offer can only be set when you create the scale set.\n\nReadonly\
  \ variables are only populated by the server, and will be ignored when sending a\
  \ request.\n\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}'\
  \  # pylint: disable=line-too-long\n   in the 'id' field without version input."
constructor:
  syntax: 'ImageReference(*args: Any, **kwargs: Any)'
variables:
- description: Resource Id.
  name: id
  types:
  - <xref:str>
- description: The image publisher.
  name: publisher
  types:
  - <xref:str>
- description: 'Specifies the offer of the platform image or marketplace image used
    to create

    the virtual machine.'
  name: offer
  types:
  - <xref:str>
- description: The image SKU.
  name: sku
  types:
  - <xref:str>
- description: 'Specifies the version of the platform image or marketplace image used
    to create

    the virtual machine. The allowed formats are Major.Minor.Build or ''latest''.

    Major, Minor, and Build are decimal numbers. Specify ''latest'' to use the latest

    version of an image available at deploy time. Even if you use ''latest'', the
    VM

    image will not automatically update after deploy time even if a new version

    becomes available. Please do not use field ''version'' for gallery image

    deployment, gallery image should always use ''id'' field for deployment, to use
    ''latest''

    version of gallery image, just set'
  name: version
- description: 'Specifies in decimal numbers, the version of platform image or marketplace

    image used to create the virtual machine. This readonly field differs from ''version'',

    only if the value specified in ''version'' field is ''latest''.'
  name: exact_version
  types:
  - <xref:str>
- description: 'Specified the shared gallery image unique id for vm deployment.

    This can be

    fetched from shared gallery image GET call.'
  name: shared_gallery_image_id
  types:
  - <xref:str>
- description: 'Specified the community gallery image unique id for vm

    deployment. This can be

    fetched from community gallery image GET call.'
  name: community_gallery_image_id
  types:
  - <xref:str>
attributes:
- uid: azure.mgmt.computefleet.models.ImageReference.community_gallery_image_id
  name: community_gallery_image_id
  summary: 'Specified the community gallery image unique id for vm deployment. This
    can be

    fetched from community gallery image GET call.'
  signature: 'community_gallery_image_id: str | None'
- uid: azure.mgmt.computefleet.models.ImageReference.exact_version
  name: exact_version
  summary: 'Specifies in decimal numbers, the version of platform image or marketplace

    image used to create the virtual machine. This readonly field differs from ''version'',

    only if the value specified in ''version'' field is ''latest''.'
  signature: 'exact_version: str | None'
- uid: azure.mgmt.computefleet.models.ImageReference.id
  name: id
  summary: Resource Id.
  signature: 'id: str | None'
- uid: azure.mgmt.computefleet.models.ImageReference.offer
  name: offer
  summary: 'Specifies the offer of the platform image or marketplace image used to
    create

    the virtual machine.'
  signature: 'offer: str | None'
- uid: azure.mgmt.computefleet.models.ImageReference.publisher
  name: publisher
  summary: The image publisher.
  signature: 'publisher: str | None'
- uid: azure.mgmt.computefleet.models.ImageReference.shared_gallery_image_id
  name: shared_gallery_image_id
  summary: 'Specified the shared gallery image unique id for vm deployment. This can
    be

    fetched from shared gallery image GET call.'
  signature: 'shared_gallery_image_id: str | None'
- uid: azure.mgmt.computefleet.models.ImageReference.sku
  name: sku
  summary: The image SKU.
  signature: 'sku: str | None'
- uid: azure.mgmt.computefleet.models.ImageReference.version
  name: version
  summary: 'Specifies the version of the platform image or marketplace image used
    to create

    the virtual machine. The allowed formats are Major.Minor.Build or ''latest''.

    Major, Minor, and Build are decimal numbers. Specify ''latest'' to use the latest

    version of an image available at deploy time. Even if you use ''latest'', the
    VM

    image will not automatically update after deploy time even if a new version

    becomes available. Please do not use field ''version'' for gallery image

    deployment, gallery image should always use ''id'' field for deployment, to use
    ''latest''

    version of gallery image, just set

    ''/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}''  #
    pylint: disable=line-too-long

    in the ''id'' field without version input.'
  signature: 'version: str | None'