GalleryImagePropertiesOutput interface
Describes the properties of a gallery image definition.
Properties
| architecture | The architecture of the image. Applicable to OS disks only. |
| description | The description of this gallery image definition resource. This property is updatable. |
| disallowed | Describes the disallowed disk types. |
| end |
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. |
| hyper |
The hypervisor generation of the Virtual Machine. Applicable to OS disks only. |
| identifier | This is the gallery image definition identifier. |
| os |
This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. |
| os |
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. |
| privacy |
The privacy statement uri. |
| provisioning |
The provisioning state, which only appears in the response. |
| purchase |
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. |
| release |
The release note uri. |
Property Details
architecture
The architecture of the image. Applicable to OS disks only.
architecture?: "x64" | "Arm64"
Property Value
"x64" | "Arm64"
description
The description of this gallery image definition resource. This property is updatable.
description?: string
Property Value
string
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?: string
Property Value
string
eula
The Eula agreement for the gallery image definition.
eula?: string
Property Value
string
features
A list of gallery image features.
features?: GalleryImageFeatureOutput[]
Property Value
hyperVGeneration
The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
hyperVGeneration?: "V1" | "V2"
Property Value
"V1" | "V2"
identifier
This is the gallery image definition identifier.
identifier: GalleryImageIdentifierOutput
Property Value
osState
This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'.
osState: "Generalized" | "Specialized"
Property Value
"Generalized" | "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
osType: "Windows" | "Linux"
Property Value
"Windows" | "Linux"
privacyStatementUri
The privacy statement uri.
privacyStatementUri?: string
Property Value
string
provisioningState
The provisioning state, which only appears in the response.
provisioningState?: "Failed" | "Succeeded" | "Creating" | "Deleting" | "Updating" | "Migrating"
Property Value
"Failed" | "Succeeded" | "Creating" | "Deleting" | "Updating" | "Migrating"
purchasePlan
Describes the gallery image definition purchase plan. This is used by marketplace images.
purchasePlan?: ImagePurchasePlanOutput
Property Value
recommended
The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.
recommended?: RecommendedMachineConfigurationOutput
Property Value
releaseNoteUri
The release note uri.
releaseNoteUri?: string
Property Value
string