SharedGalleryImageProperties interface
Describes the properties of a gallery image definition.
Properties
| architecture | The architecture of the image. Applicable to OS disks only. |
| artifact |
The artifact tags of a shared gallery resource. |
| 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 | End-user license agreement for the current community gallery image. |
| 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. Possible values are: Windows, Linux. |
| privacy |
Privacy statement uri for the current community gallery image. |
| 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. |
Property Details
architecture
The architecture of the image. Applicable to OS disks only.
architecture?: stringProperty Value
string
artifactTags
The artifact tags of a shared gallery resource.
artifactTags?: Record<string, string>Property Value
Record<string, 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?: DateProperty Value
Date
eula
End-user license agreement for the current community gallery image.
eula?: stringProperty Value
string
features
A list of gallery image features.
features?: GalleryImageFeature[]Property Value
hyperVGeneration
The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
hyperVGeneration?: stringProperty Value
string
identifier
This is the gallery image definition identifier.
identifier: GalleryImageIdentifierProperty Value
osState
This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'.
osState: OperatingSystemStateTypesProperty Value
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: OperatingSystemTypesProperty Value
privacyStatementUri
Privacy statement uri for the current community gallery image.
privacyStatementUri?: stringProperty Value
string
purchasePlan
Describes the gallery image definition purchase plan. This is used by marketplace images.
purchasePlan?: ImagePurchasePlanProperty Value
recommended
The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.
recommended?: RecommendedMachineConfiguration