Share via

ImageReference interface

Package:
@azure/arm-compute

Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. NOTE: Image reference publisher and offer can only be set when you create the scale set.

Extends
SubResource

Properties

communityGalleryImageId

Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call.
exactVersion

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'. NOTE: This property will not be serialized. It can only be populated by the server.
offer

Specifies the offer of the platform image or marketplace image used to create the virtual machine.
publisher

The image publisher.
sharedGalleryImageId

Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call.
sku

The image SKU.
version

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}' in the 'id' field without version input.

Inherited Properties

id

Resource Id

Property Details

communityGalleryImageId

Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call.

communityGalleryImageId?: string

Property Value

string

exactVersion

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'. NOTE: This property will not be serialized. It can only be populated by the server.

exactVersion?: string

Property Value

string

offer

Specifies the offer of the platform image or marketplace image used to create the virtual machine.

offer?: string

Property Value

string

publisher

The image publisher.

publisher?: string

Property Value

string

sharedGalleryImageId

Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call.

sharedGalleryImageId?: string

Property Value

string

sku

The image SKU.

sku?: string

Property Value

string

version

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}' in the 'id' field without version input.

version?: string

Property Value

string

Inherited Property Details

id

Resource Id

id?: string

Property Value

string

Inherited From SubResource.id