Package version:

Interface CommunityGalleryImage

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

interface CommunityGalleryImage {
    architecture?: string;
    artifactTags?: {
        [propertyName: string]: string;
    };
    disallowed?: Disallowed;
    disclaimer?: string;
    endOfLifeDate?: any;
    eula?: string;
    features?: GalleryImageFeature[];
    hyperVGeneration?: string;
    identifier?: CommunityGalleryImageIdentifier;
    location?: string;
    name?: string;
    osState?: OperatingSystemStateTypes;
    osType?: OperatingSystemTypes;
    privacyStatementUri?: string;
    purchasePlan?: ImagePurchasePlan;
    recommended?: RecommendedMachineConfiguration;
    type?: string;
    uniqueId?: string;
}

Hierarchy (view full)

Properties

architecture?: string

CPU architecture supported by an OS disk.

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

The artifact tags of a community gallery resource.

disallowed?: Disallowed

Describes the disallowed disk types.

disclaimer?: string

The disclaimer for a community gallery resource.

endOfLifeDate?: any

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

eula?: string

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

features?: GalleryImageFeature[]

A list of gallery image features.

hyperVGeneration?: string

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

This is the community gallery image definition identifier.

location?: string

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

name?: string

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

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

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?: string

Privacy statement URI for the current community gallery image.

purchasePlan?: ImagePurchasePlan

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

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

type?: string

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

uniqueId?: string

The unique id of this community gallery.