GalleryImage Class

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Constructor

GalleryImage(*, location: str, tags: dict[str, str] | None = None, description: str | None = None, eula: str | None = None, privacy_statement_uri: str | None = None, release_note_uri: str | None = None, os_type: str | _models.OperatingSystemTypes | None = None, os_state: str | _models.OperatingSystemStateTypes | None = None, hyper_v_generation: str | _models.HyperVGeneration | None = None, end_of_life_date: datetime | None = None, identifier: _models.GalleryImageIdentifier | None = None, recommended: _models.RecommendedMachineConfiguration | None = None, disallowed: _models.Disallowed | None = None, purchase_plan: _models.ImagePurchasePlan | None = None, features: list['_models.GalleryImageFeature'] | None = None, architecture: str | _models.Architecture | None = None, allow_update_image: bool | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
tags	dict[str, str] Resource tags. Default value: None
location	str The geo-location where the resource lives. Required.
description	str The description of this gallery image definition resource. This property is updatable. Default value: None
eula	str The Eula agreement for the gallery image definition. Default value: None
privacy_statement_uri	str The privacy statement uri. Default value: None
release_note_uri	str The release note uri. Default value: None
os_type	str or OperatingSystemTypes 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.. Known values are: "Windows" and "Linux". Default value: None
os_state	str or OperatingSystemStateTypes This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. Known values are: "Generalized" and "Specialized". Default value: None
hyper_v_generation	str or HyperVGeneration The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Known values are: "V1" and "V2". Default value: None
end_of_life_date	datetime The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable. Default value: None
identifier	GalleryImageIdentifier This is the gallery image definition identifier. Default value: None
recommended	RecommendedMachineConfiguration The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. Default value: None
disallowed	Disallowed Describes the disallowed disk types. Default value: None
purchase_plan	ImagePurchasePlan Describes the gallery image definition purchase plan. This is used by marketplace images. Default value: None
features	list[GalleryImageFeature] A list of gallery image features. Default value: None
architecture	str or Architecture The architecture of the image. Applicable to OS disks only. Known values are: "x64" and "Arm64". Default value: None
allow_update_image	bool Optional. Must be set to true if the gallery image features are being updated. Default value: None

Variables

Name	Description
id	str Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	str The name of the resource.
type	str The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
system_data	SystemData Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	dict[str, str] Resource tags.
location	str The geo-location where the resource lives. Required.
description	str The description of this gallery image definition resource. This property is updatable.
eula	str The Eula agreement for the gallery image definition.
privacy_statement_uri	str The privacy statement uri.
release_note_uri	str The release note uri.
os_type	str or OperatingSystemTypes 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.. Known values are: "Windows" and "Linux".
os_state	str or OperatingSystemStateTypes This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. Known values are: "Generalized" and "Specialized".
hyper_v_generation	str or HyperVGeneration The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Known values are: "V1" and "V2".
end_of_life_date	datetime The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable.
identifier	GalleryImageIdentifier This is the gallery image definition identifier.
recommended	RecommendedMachineConfiguration The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.
disallowed	Disallowed Describes the disallowed disk types.
purchase_plan	ImagePurchasePlan Describes the gallery image definition purchase plan. This is used by marketplace images.
provisioning_state	str or GalleryProvisioningState The provisioning state, which only appears in the response. Known values are: "Creating", "Updating", "Failed", "Succeeded", "Deleting", and "Migrating".
features	list[GalleryImageFeature] A list of gallery image features.
architecture	str or Architecture The architecture of the image. Applicable to OS disks only. Known values are: "x64" and "Arm64".
allow_update_image	bool Optional. Must be set to true if the gallery image features are being updated.

Feedback

Was this page helpful?