Package version:

Interface GalleryImage

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

interface GalleryImage {
    allowUpdateImage?: boolean;
    architecture?: string;
    description?: string;
    disallowed?: Disallowed;
    endOfLifeDate?: any;
    eula?: string;
    features?: GalleryImageFeature[];
    hyperVGeneration?: string;
    id?: string;
    identifier?: GalleryImageIdentifier;
    location: string;
    name?: string;
    osState?: OperatingSystemStateTypes;
    osType?: OperatingSystemTypes;
    privacyStatementUri?: string;
    provisioningState?: string;
    purchasePlan?: ImagePurchasePlan;
    recommended?: RecommendedMachineConfiguration;
    releaseNoteUri?: string;
    tags?: {
        [propertyName: string]: string;
    };
    type?: string;
}

Hierarchy (view full)

Properties

allowUpdateImage? architecture? description? disallowed? endOfLifeDate? eula? features? hyperVGeneration? id? identifier? location name? osState? osType? privacyStatementUri? provisioningState? purchasePlan? recommended? releaseNoteUri? tags? type?

Properties

OptionalallowUpdateImage

allowUpdateImage?: boolean

Optional. Must be set to true if the gallery image features are being updated.

Optionalarchitecture

architecture?: string

CPU architecture supported by an OS disk.

Optionaldescription

description?: string

The description of this gallery image definition resource. This property is updatable.

Optionaldisallowed

disallowed?: Disallowed

Describes the disallowed disk types.

OptionalendOfLifeDate

endOfLifeDate?: any

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

Optionaleula

eula?: string

The Eula agreement for the gallery image definition.

Optionalfeatures

features?: GalleryImageFeature[]

A list of gallery image features.

OptionalhyperVGeneration

hyperVGeneration?: string

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

Optional Readonlyid

id?: string

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

Optionalidentifier

identifier?: GalleryImageIdentifier

This is the gallery image definition identifier.

location

location: string

Resource location

Optional Readonlyname

name?: string

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

OptionalosState

osState?: OperatingSystemStateTypes

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

OptionalosType

osType?: OperatingSystemTypes

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.

OptionalprivacyStatementUri

privacyStatementUri?: string

The privacy statement uri.

Optional ReadonlyprovisioningState

provisioningState?: string

The provisioning state, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.

OptionalpurchasePlan

purchasePlan?: ImagePurchasePlan

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

Optionalrecommended

recommended?: RecommendedMachineConfiguration

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

OptionalreleaseNoteUri

releaseNoteUri?: string

The release note uri.

Optionaltags

tags?: {
    [propertyName: string]: string;
}

Resource tags

Optional Readonlytype

type?: string

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

Settings

Member Visibility