GalleryApplicationVersionPublishingProfile interface
The publishing profile of a gallery image version.
- Extends
Properties
advanced |
Optional. Additional settings to pass to the vm-application-manager extension. For advanced use only. |
custom |
A list of custom actions that can be performed with this Gallery Application Version. |
enable |
Optional. Whether or not this application reports health. |
manage |
|
settings | Additional settings for the VM app that contains the target package and config file name when it is deployed to target VM or VM scale set. |
source | The source image from which the Image Version is going to be created. |
Inherited Properties
end |
The end of life date of the gallery image version. 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. |
published |
The timestamp for when the gallery image version is published. NOTE: This property will not be serialized. It can only be populated by the server. |
replica |
The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable. |
replication |
Optional parameter which specifies the mode to be used for replication. This property is not updatable. |
storage |
Specifies the storage account type to be used to store the image. This property is not updatable. |
target |
The target extended locations where the Image Version is going to be replicated to. This property is updatable. |
target |
The target regions where the Image Version is going to be replicated to. This property is updatable. |
Property Details
advancedSettings
Optional. Additional settings to pass to the vm-application-manager extension. For advanced use only.
advancedSettings?: {[propertyName: string]: string}
Property Value
{[propertyName: string]: string}
customActions
A list of custom actions that can be performed with this Gallery Application Version.
customActions?: GalleryApplicationCustomAction[]
Property Value
enableHealthCheck
Optional. Whether or not this application reports health.
enableHealthCheck?: boolean
Property Value
boolean
manageActions
settings
Additional settings for the VM app that contains the target package and config file name when it is deployed to target VM or VM scale set.
settings?: UserArtifactSettings
Property Value
source
The source image from which the Image Version is going to be created.
source: UserArtifactSource
Property Value
Inherited Property Details
endOfLifeDate
The end of life date of the gallery image version. This property can be used for decommissioning purposes. This property is updatable.
endOfLifeDate?: Date
Property Value
Date
Inherited From GalleryArtifactPublishingProfileBase.endOfLifeDate
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
Inherited From GalleryArtifactPublishingProfileBase.excludeFromLatest
publishedDate
The timestamp for when the gallery image version is published. NOTE: This property will not be serialized. It can only be populated by the server.
publishedDate?: Date
Property Value
Date
Inherited From GalleryArtifactPublishingProfileBase.publishedDate
replicaCount
The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable.
replicaCount?: number
Property Value
number
Inherited From GalleryArtifactPublishingProfileBase.replicaCount
replicationMode
Optional parameter which specifies the mode to be used for replication. This property is not updatable.
replicationMode?: string
Property Value
string
Inherited From GalleryArtifactPublishingProfileBase.replicationMode
storageAccountType
Specifies the storage account type to be used to store the image. This property is not updatable.
storageAccountType?: string
Property Value
string
Inherited From GalleryArtifactPublishingProfileBase.storageAccountType
targetExtendedLocations
The target extended locations where the Image Version is going to be replicated to. This property is updatable.
targetExtendedLocations?: GalleryTargetExtendedLocation[]
Property Value
Inherited From GalleryArtifactPublishingProfileBase.targetExtendedLocations
targetRegions
The target regions where the Image Version is going to be replicated to. This property is updatable.
targetRegions?: TargetRegion[]
Property Value
Inherited From GalleryArtifactPublishingProfileBase.targetRegions