SharedGalleryImageVersion interface

Specifies information about the gallery image version that you want to create or update.

Extends

Properties

artifactTags

The artifact tags of a shared gallery resource.

consumptionEndTime

The timestamp after which a soft-deleted gallery image version is no longer consumable for VM/VMSS creation or VMSS scale out. It is calculated from the soft-deleted time plus the retention period, and is not present for active gallery image versions. In dateTime offset format.

endOfLifeDate

The end of life date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable.

excludeFromLatest

If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version.

imageState

The state of the gallery image version, derived from its soft-delete status.

publishedDate

The published date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable.

storageProfile

Describes the storage profile of the image version.

Inherited Properties

location

Resource location

name

Resource name

uniqueId

The unique id of this shared gallery.

Property Details

artifactTags

The artifact tags of a shared gallery resource.

artifactTags?: Record<string, string>

Property Value

Record<string, string>

consumptionEndTime

The timestamp after which a soft-deleted gallery image version is no longer consumable for VM/VMSS creation or VMSS scale out. It is calculated from the soft-deleted time plus the retention period, and is not present for active gallery image versions. In dateTime offset format.

consumptionEndTime?: Date

Property Value

Date

endOfLifeDate

The end of life date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable.

endOfLifeDate?: Date

Property Value

Date

excludeFromLatest

If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version.

excludeFromLatest?: boolean

Property Value

boolean

imageState

The state of the gallery image version, derived from its soft-delete status.

imageState?: string

Property Value

string

publishedDate

The published date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable.

publishedDate?: Date

Property Value

Date

storageProfile

Describes the storage profile of the image version.

storageProfile?: SharedGalleryImageVersionStorageProfile

Property Value

Inherited Property Details

location

Resource location

location?: string

Property Value

string

Inherited From PirSharedGalleryResource.location

name

Resource name

name?: string

Property Value

string

Inherited From PirSharedGalleryResource.name

uniqueId

The unique id of this shared gallery.

uniqueId?: string

Property Value

string

Inherited From PirSharedGalleryResource.uniqueId