SharedGalleryImage interface
Specifies information about the gallery image definition that you want to create or update.
- Extends
Properties
architecture | CPU architecture supported by an OS disk. |
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. |
Inherited Properties
location | Resource location 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. |
unique |
The unique id of this shared gallery. |
Property Details
architecture
CPU architecture supported by an OS disk.
architecture?: string
Property Value
string
artifactTags
The artifact tags of a shared gallery resource.
artifactTags?: {[propertyName: string]: string}
Property Value
{[propertyName: 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?: Date
Property Value
Date
eula
End-user license agreement for the current community gallery image.
eula?: string
Property 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?: string
Property Value
string
identifier
This is the gallery image definition identifier.
identifier?: GalleryImageIdentifier
Property Value
osState
This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'.
osState?: OperatingSystemStateTypes
Property 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?: OperatingSystemTypes
Property Value
privacyStatementUri
Privacy statement uri for the current community gallery image.
privacyStatementUri?: string
Property Value
string
purchasePlan
Describes the gallery image definition purchase plan. This is used by marketplace images.
purchasePlan?: ImagePurchasePlan
Property Value
recommended
The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.
recommended?: RecommendedMachineConfiguration
Property Value
Inherited Property Details
location
Resource location NOTE: This property will not be serialized. It can only be populated by the server.
location?: string
Property Value
string
Inherited From PirSharedGalleryResource.location
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 PirSharedGalleryResource.name
uniqueId
The unique id of this shared gallery.
uniqueId?: string
Property Value
string
Inherited From PirSharedGalleryResource.uniqueId