GalleryImage interface
Specifies information about the gallery image definition that you want to create or update.
- Extends
Properties
| allow |
Optional. Must be set to true if the gallery image features are being updated. |
| 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. Possible values are: Windows, Linux. |
| privacy |
The privacy statement uri. |
| provisioning |
The provisioning state, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server. |
| 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. |
Inherited Properties
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server. |
| location | The geo-location where the resource lives |
| name | The name of the resource NOTE: This property will not be serialized. It can only be populated by the server. |
| system |
Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server. |
| tags | Resource tags. |
| type | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" 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?: booleanProperty Value
boolean
architecture
The architecture of the image. Applicable to OS disks only.
architecture?: stringProperty Value
string
description
The description of this gallery image definition resource. This property is updatable.
description?: stringProperty 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?: DateProperty Value
Date
eula
The Eula agreement for the gallery image definition.
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
The privacy statement uri.
privacyStatementUri?: stringProperty 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?: 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?: RecommendedMachineConfigurationProperty Value
releaseNoteUri
The release note uri.
releaseNoteUri?: stringProperty Value
string
Inherited Property Details
id
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
id?: stringProperty Value
string
Inherited From TrackedResource.id
location
The geo-location where the resource lives
location: stringProperty Value
string
Inherited From TrackedResource.location
name
The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
name?: stringProperty Value
string
Inherited From TrackedResource.name
systemData
Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
systemData?: SystemDataProperty Value
Inherited From TrackedResource.systemData
tags
Resource tags.
tags?: {[propertyName: string]: string}Property Value
{[propertyName: string]: string}
Inherited From TrackedResource.tags
type
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.
type?: stringProperty Value
string
Inherited From TrackedResource.type