Share via

CommunityGalleryImage interface

  • Reference
Package:
@azure/arm-compute

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

Extends
PirCommunityGalleryResource

Properties

architecture

CPU architecture supported by an OS disk.
artifactTags

The artifact tags of a community gallery resource.
disallowed

Describes the disallowed disk types.
disclaimer

The disclaimer for a community gallery resource.
endOfLifeDate

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

The end-user license agreement for the current community gallery image.
features

A list of gallery image features.
hyperVGeneration

The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
identifier

This is the community gallery image definition identifier.
osState

This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'.
osType

This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: Windows, Linux.
privacyStatementUri

Privacy statement URI for the current community gallery image.
purchasePlan

Describes the gallery image definition purchase plan. This is used by marketplace images.
recommended

The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.

Inherited Properties

location

Resource location NOTE: This property will not be serialized. It can only be populated by the server.
name

Resource name NOTE: This property will not be serialized. It can only be populated by the server.
type

Resource type NOTE: This property will not be serialized. It can only be populated by the server.
uniqueId

The unique id of this community gallery.

Property Details

architecture

CPU architecture supported by an OS disk.

architecture?: string

Property Value

string

artifactTags

The artifact tags of a community gallery resource.

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

Property Value

{[propertyName: string]: string}

disallowed

Describes the disallowed disk types.

disallowed?: Disallowed

Property Value

Disallowed

disclaimer

The disclaimer for a community gallery resource.

disclaimer?: string

Property Value

string

endOfLifeDate

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

endOfLifeDate?: Date

Property Value

Date

eula

The end-user license agreement for the current community gallery image.

eula?: string

Property Value

string

features

A list of gallery image features.

features?: GalleryImageFeature[]

Property Value

GalleryImageFeature[]

hyperVGeneration

The hypervisor generation of the Virtual Machine. Applicable to OS disks only.

hyperVGeneration?: string

Property Value

string

identifier

This is the community gallery image definition identifier.

identifier?: CommunityGalleryImageIdentifier

Property Value

CommunityGalleryImageIdentifier

osState

This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'.

osState?: OperatingSystemStateTypes

Property Value

OperatingSystemStateTypes

osType

This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: Windows, Linux.

osType?: OperatingSystemTypes

Property Value

OperatingSystemTypes

privacyStatementUri

Privacy statement URI for the current community gallery image.

privacyStatementUri?: string

Property Value

string

purchasePlan

Describes the gallery image definition purchase plan. This is used by marketplace images.

purchasePlan?: ImagePurchasePlan

Property Value

ImagePurchasePlan

The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.

recommended?: RecommendedMachineConfiguration

Property Value

RecommendedMachineConfiguration

Inherited Property Details

location

Resource location NOTE: This property will not be serialized. It can only be populated by the server.

location?: string

Property Value

string

Inherited From PirCommunityGalleryResource.location

name

Resource name NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From PirCommunityGalleryResource.name

type

Resource type NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From PirCommunityGalleryResource.type

uniqueId

The unique id of this community gallery.

uniqueId?: string

Property Value

string

Inherited From PirCommunityGalleryResource.uniqueId