GalleryApplicationVersionPublishingProfile Class

public final class GalleryApplicationVersionPublishingProfile
extends GalleryArtifactPublishingProfileBase

The publishing profile of a gallery image version.

Constructor Summary

Constructor Description
GalleryApplicationVersionPublishingProfile()

Creates an instance of GalleryApplicationVersionPublishingProfile class.

Method Summary

Modifier and Type Method and Description
Map<String,String> advancedSettings()

Get the advancedSettings property: Optional.

List<GalleryApplicationCustomAction> customActions()

Get the customActions property: A list of custom actions that can be performed with this Gallery Application Version.

Boolean enableHealthCheck()

Get the enableHealthCheck property: Optional.

UserArtifactManage manageActions()

Get the manageActions property: The manageActions property.

UserArtifactSettings settings()

Get the settings property: 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.

UserArtifactSource source()

Get the source property: The source image from which the Image Version is going to be created.

void validate()

Validates the instance.

GalleryApplicationVersionPublishingProfile withAdvancedSettings(Map<String,String> advancedSettings)

Set the advancedSettings property: Optional.

GalleryApplicationVersionPublishingProfile withCustomActions(List<GalleryApplicationCustomAction> customActions)

Set the customActions property: A list of custom actions that can be performed with this Gallery Application Version.

GalleryApplicationVersionPublishingProfile withEnableHealthCheck(Boolean enableHealthCheck)

Set the enableHealthCheck property: Optional.

GalleryApplicationVersionPublishingProfile withEndOfLifeDate(OffsetDateTime endOfLifeDate)

Set the endOfLifeDate property: The end of life date of the gallery image version.

GalleryApplicationVersionPublishingProfile withExcludeFromLatest(Boolean excludeFromLatest)

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

GalleryApplicationVersionPublishingProfile withManageActions(UserArtifactManage manageActions)

Set the manageActions property: The manageActions property.

GalleryApplicationVersionPublishingProfile withReplicaCount(Integer replicaCount)

Set the replicaCount property: The number of replicas of the Image Version to be created per region.

GalleryApplicationVersionPublishingProfile withReplicationMode(ReplicationMode replicationMode)

Set the replicationMode property: Optional parameter which specifies the mode to be used for replication.

GalleryApplicationVersionPublishingProfile withSettings(UserArtifactSettings settings)

Set the settings property: 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.

GalleryApplicationVersionPublishingProfile withSource(UserArtifactSource source)

Set the source property: The source image from which the Image Version is going to be created.

GalleryApplicationVersionPublishingProfile withStorageAccountType(StorageAccountType storageAccountType)

Set the storageAccountType property: Specifies the storage account type to be used to store the image.

GalleryApplicationVersionPublishingProfile withTargetExtendedLocations(List<GalleryTargetExtendedLocation> targetExtendedLocations)

Set the targetExtendedLocations property: The target extended locations where the Image Version is going to be replicated to.

GalleryApplicationVersionPublishingProfile withTargetRegions(List<TargetRegion> targetRegions)

Set the targetRegions property: The target regions where the Image Version is going to be replicated to.

Methods inherited from GalleryArtifactPublishingProfileBase

Methods inherited from java.lang.Object

Constructor Details

GalleryApplicationVersionPublishingProfile

public GalleryApplicationVersionPublishingProfile()

Creates an instance of GalleryApplicationVersionPublishingProfile class.

Method Details

advancedSettings

public Map advancedSettings()

Get the advancedSettings property: Optional. Additional settings to pass to the vm-application-manager extension. For advanced use only.

Returns:

the advancedSettings value.

customActions

public List customActions()

Get the customActions property: A list of custom actions that can be performed with this Gallery Application Version.

Returns:

the customActions value.

enableHealthCheck

public Boolean enableHealthCheck()

Get the enableHealthCheck property: Optional. Whether or not this application reports health.

Returns:

the enableHealthCheck value.

manageActions

public UserArtifactManage manageActions()

Get the manageActions property: The manageActions property.

Returns:

the manageActions value.

settings

public UserArtifactSettings settings()

Get the settings property: 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.

Returns:

the settings value.

source

public UserArtifactSource source()

Get the source property: The source image from which the Image Version is going to be created.

Returns:

the source value.

validate

public void validate()

Validates the instance.

Overrides:

GalleryApplicationVersionPublishingProfile.validate()

withAdvancedSettings

public GalleryApplicationVersionPublishingProfile withAdvancedSettings(Map advancedSettings)

Set the advancedSettings property: Optional. Additional settings to pass to the vm-application-manager extension. For advanced use only.

Parameters:

advancedSettings - the advancedSettings value to set.

Returns:

the GalleryApplicationVersionPublishingProfile object itself.

withCustomActions

public GalleryApplicationVersionPublishingProfile withCustomActions(List customActions)

Set the customActions property: A list of custom actions that can be performed with this Gallery Application Version.

Parameters:

customActions - the customActions value to set.

Returns:

the GalleryApplicationVersionPublishingProfile object itself.

withEnableHealthCheck

public GalleryApplicationVersionPublishingProfile withEnableHealthCheck(Boolean enableHealthCheck)

Set the enableHealthCheck property: Optional. Whether or not this application reports health.

Parameters:

enableHealthCheck - the enableHealthCheck value to set.

Returns:

the GalleryApplicationVersionPublishingProfile object itself.

withEndOfLifeDate

public GalleryApplicationVersionPublishingProfile withEndOfLifeDate(OffsetDateTime endOfLifeDate)

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

Overrides:

GalleryApplicationVersionPublishingProfile.withEndOfLifeDate(OffsetDateTime endOfLifeDate)

Parameters:

endOfLifeDate

withExcludeFromLatest

public GalleryApplicationVersionPublishingProfile withExcludeFromLatest(Boolean excludeFromLatest)

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

Overrides:

GalleryApplicationVersionPublishingProfile.withExcludeFromLatest(Boolean excludeFromLatest)

Parameters:

excludeFromLatest

withManageActions

public GalleryApplicationVersionPublishingProfile withManageActions(UserArtifactManage manageActions)

Set the manageActions property: The manageActions property.

Parameters:

manageActions - the manageActions value to set.

Returns:

the GalleryApplicationVersionPublishingProfile object itself.

withReplicaCount

public GalleryApplicationVersionPublishingProfile withReplicaCount(Integer replicaCount)

Set the replicaCount property: 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.

Overrides:

GalleryApplicationVersionPublishingProfile.withReplicaCount(Integer replicaCount)

Parameters:

replicaCount

withReplicationMode

public GalleryApplicationVersionPublishingProfile withReplicationMode(ReplicationMode replicationMode)

Set the replicationMode property: Optional parameter which specifies the mode to be used for replication. This property is not updatable.

Overrides:

GalleryApplicationVersionPublishingProfile.withReplicationMode(ReplicationMode replicationMode)

Parameters:

replicationMode

withSettings

public GalleryApplicationVersionPublishingProfile withSettings(UserArtifactSettings settings)

Set the settings property: 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.

Parameters:

settings - the settings value to set.

Returns:

the GalleryApplicationVersionPublishingProfile object itself.

withSource

public GalleryApplicationVersionPublishingProfile withSource(UserArtifactSource source)

Set the source property: The source image from which the Image Version is going to be created.

Parameters:

source - the source value to set.

Returns:

the GalleryApplicationVersionPublishingProfile object itself.

withStorageAccountType

public GalleryApplicationVersionPublishingProfile withStorageAccountType(StorageAccountType storageAccountType)

Set the storageAccountType property: Specifies the storage account type to be used to store the image. This property is not updatable.

Overrides:

GalleryApplicationVersionPublishingProfile.withStorageAccountType(StorageAccountType storageAccountType)

Parameters:

storageAccountType

withTargetExtendedLocations

public GalleryApplicationVersionPublishingProfile withTargetExtendedLocations(List targetExtendedLocations)

Set the targetExtendedLocations property: The target extended locations where the Image Version is going to be replicated to. This property is updatable.

Overrides:

GalleryApplicationVersionPublishingProfile.withTargetExtendedLocations(List<GalleryTargetExtendedLocation> targetExtendedLocations)

Parameters:

targetExtendedLocations

withTargetRegions

public GalleryApplicationVersionPublishingProfile withTargetRegions(List targetRegions)

Set the targetRegions property: The target regions where the Image Version is going to be replicated to. This property is updatable.

Overrides:

GalleryApplicationVersionPublishingProfile.withTargetRegions(List<TargetRegion> targetRegions)

Parameters:

targetRegions

Applies to