Share via

GalleryImage Class

  • Reference

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.

Inheritance
azure.mgmt.compute.v2019_03_01.models._models_py3.Resource
GalleryImage

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, 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, **kwargs: Any)

Keyword-Only Parameters

Name Description
location
str

Resource location. Required.
tags
dict[str, str]

Resource tags.
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. <br>``<br> Possible values are: <br>``<br> Windows <br>``<br> 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".
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.

Variables

Name Description
id
str

Resource Id.
name
str

Resource name.
type
str

Resource type.
location
str

Resource location. Required.
tags
dict[str, str]

Resource tags.
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. <br>``<br> Possible values are: <br>``<br> Windows <br>``<br> 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".
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 GalleryImagePropertiesProvisioningState

The provisioning state, which only appears in the response. Known values are: "Creating", "Updating", "Failed", "Succeeded", "Deleting", and "Migrating".