Share via

GalleryImageUpdate interface

  • Reference
Package:
@azure/arm-compute

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

Extends
UpdateResourceDefinition

Properties

allowUpdateImage

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

CPU architecture supported by an OS disk.
description

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

Describes the disallowed disk types.
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 Eula agreement for the gallery image definition.
features

A list of gallery image features.
hyperVGeneration

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

This is the 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

The privacy statement uri.
provisioningState

The provisioning state, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.
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.
releaseNoteUri

The release note uri.

Inherited Properties

id

Resource Id 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.
tags

Resource tags
type

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

Property Details

allowUpdateImage

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

allowUpdateImage?: boolean

Property Value

boolean

architecture

CPU architecture supported by an OS disk.

architecture?: string

Property Value

string

description

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

description?: string

Property Value

string

disallowed

Describes the disallowed disk types.

disallowed?: Disallowed

Property Value

Disallowed

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 Eula agreement for the gallery image definition.

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 gallery image definition identifier.

identifier?: GalleryImageIdentifier

Property Value

GalleryImageIdentifier

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

The privacy statement uri.

privacyStatementUri?: string

Property Value

string

provisioningState

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

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

releaseNoteUri

The release note uri.

releaseNoteUri?: string

Property Value

string

Inherited Property Details

id

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

id?: string

Property Value

string

Inherited From UpdateResourceDefinition.id

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 UpdateResourceDefinition.name

tags

Resource tags

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

Property Value

{[propertyName: string]: string}

Inherited From UpdateResourceDefinition.tags

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 UpdateResourceDefinition.type