CommunityGalleryImageVersion interface
Specifies information about the gallery image version that you want to create or update.
- Extends
Properties
| artifact |
The artifact tags of a community gallery resource. |
| consumption |
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. |
| disclaimer | The disclaimer for a community gallery resource. |
| end |
The end of life date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable. |
| exclude |
If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version. |
| image |
The state of the gallery image version, derived from its soft-delete status. |
| published |
The published date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable. |
| storage |
Describes the storage profile of the image version. |
Inherited Properties
| location | Resource location |
| name | Resource name |
| type | Resource type |
| unique |
The unique id of this community gallery. |
Property Details
artifactTags
The artifact tags of a community 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?: DateProperty Value
Date
disclaimer
The disclaimer for a community gallery resource.
disclaimer?: stringProperty Value
string
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?: DateProperty 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?: booleanProperty Value
boolean
imageState
The state of the gallery image version, derived from its soft-delete status.
imageState?: stringProperty 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?: DateProperty Value
Date
storageProfile
Describes the storage profile of the image version.
storageProfile?: SharedGalleryImageVersionStorageProfileProperty Value
Inherited Property Details
location
Resource location
location?: stringProperty Value
string
Inherited From PirCommunityGalleryResource.location
name
type
uniqueId
The unique id of this community gallery.
uniqueId?: stringProperty Value
string
Inherited From PirCommunityGalleryResource.uniqueId