Share via

ImageTemplateSharedImageDistributor interface

  • Reference
Package:
@azure/arm-imagebuilder

Distribute via Azure Compute Gallery.

Extends
ImageTemplateDistributor

Properties

excludeFromLatest

Flag that indicates whether created image version should be excluded from latest. Omit to use the default (false).
galleryImageId

Resource Id of the Azure Compute Gallery image
replicationRegions

[Deprecated] A list of regions that the image will be replicated to. This list can be specified only if targetRegions is not specified. This field is deprecated - use targetRegions instead.
storageAccountType

[Deprecated] Storage account type to be used to store the shared image. Omit to use the default (Standard_LRS). This field can be specified only if replicationRegions is specified. This field is deprecated - use targetRegions instead.
targetRegions

The target regions where the distributed Image Version is going to be replicated to. This object supersedes replicationRegions and can be specified only if replicationRegions is not specified.
type

Polymorphic discriminator, which specifies the different types this object can be
versioning

Describes how to generate new x.y.z version number for distribution.

Inherited Properties

artifactTags

Tags that will be applied to the artifact once it has been created/updated by the distributor.
runOutputName

The name to be used for the associated RunOutput.

Property Details

excludeFromLatest

Flag that indicates whether created image version should be excluded from latest. Omit to use the default (false).

excludeFromLatest?: boolean

Property Value

boolean

galleryImageId

Resource Id of the Azure Compute Gallery image

galleryImageId: string

Property Value

string

replicationRegions

[Deprecated] A list of regions that the image will be replicated to. This list can be specified only if targetRegions is not specified. This field is deprecated - use targetRegions instead.

replicationRegions?: string[]

Property Value

string[]

storageAccountType

[Deprecated] Storage account type to be used to store the shared image. Omit to use the default (Standard_LRS). This field can be specified only if replicationRegions is specified. This field is deprecated - use targetRegions instead.

storageAccountType?: string

Property Value

string

targetRegions

The target regions where the distributed Image Version is going to be replicated to. This object supersedes replicationRegions and can be specified only if replicationRegions is not specified.

targetRegions?: TargetRegion[]

Property Value

TargetRegion[]

type

Polymorphic discriminator, which specifies the different types this object can be

type: "SharedImage"

Property Value

"SharedImage"

versioning

Describes how to generate new x.y.z version number for distribution.

versioning?: DistributeVersionerUnion

Property Value

DistributeVersionerUnion

Inherited Property Details

artifactTags

Tags that will be applied to the artifact once it has been created/updated by the distributor.

artifactTags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From ImageTemplateDistributor.artifactTags

runOutputName

The name to be used for the associated RunOutput.

runOutputName: string

Property Value

string

Inherited From ImageTemplateDistributor.runOutputName