azure.mgmt.compute.v2022_01_03.models module¶

class azure.mgmt.compute.v2022_01_03.models.AggregatedReplicationState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

This is the aggregated replication status based on all the regional replication status flags.

COMPLETED = 'Completed'¶

FAILED = 'Failed'¶

IN_PROGRESS = 'InProgress'¶

UNKNOWN = 'Unknown'¶

class azure.mgmt.compute.v2022_01_03.models.ApiError(*, details: List[_models.ApiErrorBase] | None = None, innererror: _models.InnerError | None = None, code: str | None = None, target: str | None = None, message: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Api error.

Variables:

details (list[ApiErrorBase]) – The Api error details.
innererror (InnerError) – The Api inner error.
code (str) – The error code.
target (str) – The target of the particular error.
message (str) – The error message.

Keyword Arguments:

details (list[ApiErrorBase]) – The Api error details.
innererror (InnerError) – The Api inner error.
code (str) – The error code.
target (str) – The target of the particular error.
message (str) – The error message.

class azure.mgmt.compute.v2022_01_03.models.ApiErrorBase(*, code: str | None = None, target: str | None = None, message: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Api error base.

Variables:

code (str) – The error code.
target (str) – The target of the particular error.
message (str) – The error message.

Keyword Arguments:

code (str) – The error code.
target (str) – The target of the particular error.
message (str) – The error message.

class azure.mgmt.compute.v2022_01_03.models.Architecture(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The architecture of the image. Applicable to OS disks only.

ARM64 = 'Arm64'¶

X64 = 'x64'¶

class azure.mgmt.compute.v2022_01_03.models.CommunityGallery(*, unique_id: str | None = None, **kwargs: Any)[source]¶

Bases: PirCommunityGalleryResource

Specifies information about the Community Gallery that you want to create or update.

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

Variables:

name (str) – Resource name.
location (str) – Resource location.
type (str) – Resource type.
unique_id (str) – The unique id of this community gallery.

Keyword Arguments:

unique_id (str) – The unique id of this community gallery.

class azure.mgmt.compute.v2022_01_03.models.CommunityGalleryImage(*, unique_id: 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, hyper_v_generation: str | _models.HyperVGeneration | None = None, features: List[_models.GalleryImageFeature] | None = None, purchase_plan: _models.ImagePurchasePlan | None = None, architecture: str | _models.Architecture | None = None, privacy_statement_uri: str | None = None, eula: str | None = None, **kwargs: Any)[source]¶

Bases: PirCommunityGalleryResource

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.

Variables:

name (str) – Resource name.
location (str) – Resource location.
type (str) – Resource type.
unique_id (str) – The unique id of this community gallery.
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”.
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.
hyper_v_generation (str or HyperVGeneration) – The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Known values are: “V1” and “V2”.
features (list[GalleryImageFeature]) – A list of gallery image features.
purchase_plan (ImagePurchasePlan) – Describes the gallery image definition purchase plan. This is used by marketplace images.
architecture (str or Architecture) – The architecture of the image. Applicable to OS disks only. Known values are: “x64” and “Arm64”.
privacy_statement_uri (str) – Privacy statement uri for the current community gallery image.
eula (str) – End-user license agreement for the current community gallery image.

Keyword Arguments:

unique_id (str) – The unique id of this community gallery.
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”.
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.
hyper_v_generation (str or HyperVGeneration) – The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Known values are: “V1” and “V2”.
features (list[GalleryImageFeature]) – A list of gallery image features.
purchase_plan (ImagePurchasePlan) – Describes the gallery image definition purchase plan. This is used by marketplace images.
architecture (str or Architecture) – The architecture of the image. Applicable to OS disks only. Known values are: “x64” and “Arm64”.
privacy_statement_uri (str) – Privacy statement uri for the current community gallery image.
eula (str) – End-user license agreement for the current community gallery image.

class azure.mgmt.compute.v2022_01_03.models.CommunityGalleryImageList(*, value: List[_models.CommunityGalleryImage], next_link: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The List Community Gallery Images operation response.

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

Variables:

value (list[CommunityGalleryImage]) – A list of community gallery images. Required.
next_link (str) – The uri to fetch the next page of community gallery images. Call ListNext() with this to fetch the next page of community gallery images.

Keyword Arguments:

value (list[CommunityGalleryImage]) – A list of community gallery images. Required.
next_link (str) – The uri to fetch the next page of community gallery images. Call ListNext() with this to fetch the next page of community gallery images.

class azure.mgmt.compute.v2022_01_03.models.CommunityGalleryImageVersion(*, unique_id: str | None = None, published_date: datetime | None = None, end_of_life_date: datetime | None = None, exclude_from_latest: bool | None = None, storage_profile: _models.SharedGalleryImageVersionStorageProfile | None = None, **kwargs: Any)[source]¶

Bases: PirCommunityGalleryResource

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

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

Variables:

name (str) – Resource name.
location (str) – Resource location.
type (str) – Resource type.
unique_id (str) – The unique id of this community gallery.
published_date (datetime) – The published date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable.
end_of_life_date (datetime) – The end of life date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable.
exclude_from_latest (bool) – If set to true, Virtual Machines deployed from the latest version of the Image Definition won’t use this Image Version.
storage_profile (SharedGalleryImageVersionStorageProfile) – Describes the storage profile of the image version.

Keyword Arguments:

unique_id (str) – The unique id of this community gallery.
published_date (datetime) – The published date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable.
end_of_life_date (datetime) – The end of life date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable.
exclude_from_latest (bool) – If set to true, Virtual Machines deployed from the latest version of the Image Definition won’t use this Image Version.
storage_profile (SharedGalleryImageVersionStorageProfile) – Describes the storage profile of the image version.

class azure.mgmt.compute.v2022_01_03.models.CommunityGalleryImageVersionList(*, value: List[_models.CommunityGalleryImageVersion], next_link: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The List Community Gallery Image versions operation response.

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

Variables:

value (list[CommunityGalleryImageVersion]) – A list of community gallery image versions. Required.
next_link (str) – The uri to fetch the next page of community gallery image versions. Call ListNext() with this to fetch the next page of community gallery image versions.

Keyword Arguments:

value (list[CommunityGalleryImageVersion]) – A list of community gallery image versions. Required.
next_link (str) – The uri to fetch the next page of community gallery image versions. Call ListNext() with this to fetch the next page of community gallery image versions.

class azure.mgmt.compute.v2022_01_03.models.CommunityGalleryInfo(*, publisher_uri: str | None = None, publisher_contact: str | None = None, eula: str | None = None, public_name_prefix: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Information of community gallery if current gallery is shared to community.

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

Variables:

publisher_uri (str) – The link to the publisher website. Visible to all users.
publisher_contact (str) – Community gallery publisher support email. The email address of the publisher. Visible to all users.
eula (str) – End-user license agreement for community gallery image.
public_name_prefix (str) – The prefix of the gallery name that will be displayed publicly. Visible to all users.
community_gallery_enabled (bool) – Contains info about whether community gallery sharing is enabled.
public_names (list[str]) – Community gallery public name list.

Keyword Arguments:

publisher_uri (str) – The link to the publisher website. Visible to all users.
publisher_contact (str) – Community gallery publisher support email. The email address of the publisher. Visible to all users.
eula (str) – End-user license agreement for community gallery image.
public_name_prefix (str) – The prefix of the gallery name that will be displayed publicly. Visible to all users.

class azure.mgmt.compute.v2022_01_03.models.ConfidentialVMEncryptionType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

confidential VM encryption types.

ENCRYPTED_VM_GUEST_STATE_ONLY_WITH_PMK = 'EncryptedVMGuestStateOnlyWithPmk'¶

ENCRYPTED_WITH_CMK = 'EncryptedWithCmk'¶

ENCRYPTED_WITH_PMK = 'EncryptedWithPmk'¶

class azure.mgmt.compute.v2022_01_03.models.DataDiskImageEncryption(*, lun: int, disk_encryption_set_id: str | None = None, **kwargs: Any)[source]¶

Bases: DiskImageEncryption

Contains encryption settings for a data disk image.

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

Variables:

disk_encryption_set_id (str) – A relative URI containing the resource ID of the disk encryption set.
lun (int) – This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. Required.

Keyword Arguments:

disk_encryption_set_id (str) – A relative URI containing the resource ID of the disk encryption set.
lun (int) – This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. Required.

class azure.mgmt.compute.v2022_01_03.models.Disallowed(*, disk_types: List[str] | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes the disallowed disk types.

Variables:: disk_types (list[str]) – A list of disk types.
Keyword Arguments:: disk_types (list[str]) – A list of disk types.

class azure.mgmt.compute.v2022_01_03.models.DiskImageEncryption(*, disk_encryption_set_id: str | None = None, **kwargs: Any)[source]¶

Bases: Model

This is the disk image encryption base class.

Variables:: disk_encryption_set_id (str) – A relative URI containing the resource ID of the disk encryption set.
Keyword Arguments:: disk_encryption_set_id (str) – A relative URI containing the resource ID of the disk encryption set.

class azure.mgmt.compute.v2022_01_03.models.EncryptionImages(*, os_disk_image: _models.OSDiskImageEncryption | None = None, data_disk_images: List[_models.DataDiskImageEncryption] | None = None, **kwargs: Any)[source]¶

Bases: Model

Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact.

Variables:

os_disk_image (OSDiskImageEncryption) – Contains encryption settings for an OS disk image.
data_disk_images (list[DataDiskImageEncryption]) – A list of encryption specifications for data disk images.

Keyword Arguments:

os_disk_image (OSDiskImageEncryption) – Contains encryption settings for an OS disk image.
data_disk_images (list[DataDiskImageEncryption]) – A list of encryption specifications for data disk images.

class azure.mgmt.compute.v2022_01_03.models.ExtendedLocation(*, name: str | None = None, type: str | _models.ExtendedLocationTypes | None = None, **kwargs: Any)[source]¶

Bases: Model

The complex type of the extended location.

Variables:

name (str) – The name of the extended location.
type (str or ExtendedLocationTypes) – The type of the extended location. “EdgeZone”

Keyword Arguments:

name (str) – The name of the extended location.
type (str or ExtendedLocationTypes) – The type of the extended location. “EdgeZone”

class azure.mgmt.compute.v2022_01_03.models.ExtendedLocationTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The type of extendedLocation.

EDGE_ZONE = 'EdgeZone'¶

class azure.mgmt.compute.v2022_01_03.models.Gallery(*, location: str, tags: Dict[str, str] | None = None, description: str | None = None, identifier: _models.GalleryIdentifier | None = None, sharing_profile: _models.SharingProfile | None = None, soft_delete_policy: _models.SoftDeletePolicy | None = None, **kwargs: Any)[source]¶

Bases: Resource

Specifies information about the Shared Image Gallery 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.

Variables:

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 Shared Image Gallery resource. This property is updatable.
identifier (GalleryIdentifier) – Describes the gallery unique name.
provisioning_state (str or GalleryProvisioningState) – The provisioning state, which only appears in the response. Known values are: “Creating”, “Updating”, “Failed”, “Succeeded”, “Deleting”, and “Migrating”.
sharing_profile (SharingProfile) – Profile for gallery sharing to subscription or tenant.
soft_delete_policy (SoftDeletePolicy) – Contains information about the soft deletion policy of the gallery.
sharing_status (SharingStatus) – Sharing status of current gallery.

Keyword Arguments:

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
description (str) – The description of this Shared Image Gallery resource. This property is updatable.
identifier (GalleryIdentifier) – Describes the gallery unique name.
sharing_profile (SharingProfile) – Profile for gallery sharing to subscription or tenant.
soft_delete_policy (SoftDeletePolicy) – Contains information about the soft deletion policy of the gallery.

class azure.mgmt.compute.v2022_01_03.models.GalleryApplication(*, 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, end_of_life_date: datetime | None = None, supported_os_type: str | _models.OperatingSystemTypes | None = None, **kwargs: Any)[source]¶

Bases: Resource

Specifies information about the gallery Application 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.

Variables:

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 Application Definition resource. This property is updatable.
eula (str) – The Eula agreement for the gallery Application Definition.
privacy_statement_uri (str) – The privacy statement uri.
release_note_uri (str) – The release note uri.
end_of_life_date (datetime) – The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable.
supported_os_type (str or OperatingSystemTypes) – This property allows you to specify the supported type of the OS that application is built for.   Possible values are:   Windows   Linux. Known values are: “Windows” and “Linux”.

Keyword Arguments:

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
description (str) – The description of this gallery Application Definition resource. This property is updatable.
eula (str) – The Eula agreement for the gallery Application Definition.
privacy_statement_uri (str) – The privacy statement uri.
release_note_uri (str) – The release note uri.
end_of_life_date (datetime) – The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable.
supported_os_type (str or OperatingSystemTypes) – This property allows you to specify the supported type of the OS that application is built for.   Possible values are:   Windows   Linux. Known values are: “Windows” and “Linux”.

class azure.mgmt.compute.v2022_01_03.models.GalleryApplicationList(*, value: List[_models.GalleryApplication], next_link: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The List Gallery Applications operation response.

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

Variables:

value (list[GalleryApplication]) – A list of Gallery Applications. Required.
next_link (str) – The uri to fetch the next page of Application Definitions in the Application Gallery. Call ListNext() with this to fetch the next page of gallery Application Definitions.

Keyword Arguments:

value (list[GalleryApplication]) – A list of Gallery Applications. Required.
next_link (str) – The uri to fetch the next page of Application Definitions in the Application Gallery. Call ListNext() with this to fetch the next page of gallery Application Definitions.

class azure.mgmt.compute.v2022_01_03.models.GalleryApplicationUpdate(*, 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, end_of_life_date: datetime | None = None, supported_os_type: str | _models.OperatingSystemTypes | None = None, **kwargs: Any)[source]¶

Bases: UpdateResourceDefinition

Specifies information about the gallery Application Definition that you want to update.

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

Variables:

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
tags (dict[str, str]) – Resource tags.
description (str) – The description of this gallery Application Definition resource. This property is updatable.
eula (str) – The Eula agreement for the gallery Application Definition.
privacy_statement_uri (str) – The privacy statement uri.
release_note_uri (str) – The release note uri.
end_of_life_date (datetime) – The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable.
supported_os_type (str or OperatingSystemTypes) – This property allows you to specify the supported type of the OS that application is built for.   Possible values are:   Windows   Linux. Known values are: “Windows” and “Linux”.

Keyword Arguments:

tags (dict[str, str]) – Resource tags.
description (str) – The description of this gallery Application Definition resource. This property is updatable.
eula (str) – The Eula agreement for the gallery Application Definition.
privacy_statement_uri (str) – The privacy statement uri.
release_note_uri (str) – The release note uri.
end_of_life_date (datetime) – The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable.
supported_os_type (str or OperatingSystemTypes) – This property allows you to specify the supported type of the OS that application is built for.   Possible values are:   Windows   Linux. Known values are: “Windows” and “Linux”.

class azure.mgmt.compute.v2022_01_03.models.GalleryApplicationVersion(*, location: str, tags: Dict[str, str] | None = None, publishing_profile: _models.GalleryApplicationVersionPublishingProfile | None = None, **kwargs: Any)[source]¶

Bases: Resource

Specifies information about the gallery Application Version 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.

Variables:

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
publishing_profile (GalleryApplicationVersionPublishingProfile) – The publishing profile of a gallery image version.
provisioning_state (str or GalleryProvisioningState) – The provisioning state, which only appears in the response. Known values are: “Creating”, “Updating”, “Failed”, “Succeeded”, “Deleting”, and “Migrating”.
replication_status (ReplicationStatus) – This is the replication status of the gallery image version.

Keyword Arguments:

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
publishing_profile (GalleryApplicationVersionPublishingProfile) – The publishing profile of a gallery image version.

class azure.mgmt.compute.v2022_01_03.models.GalleryApplicationVersionList(*, value: List[_models.GalleryApplicationVersion], next_link: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The List Gallery Application version operation response.

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

Variables:

value (list[GalleryApplicationVersion]) – A list of gallery Application Versions. Required.
next_link (str) – The uri to fetch the next page of gallery Application Versions. Call ListNext() with this to fetch the next page of gallery Application Versions.

Keyword Arguments:

value (list[GalleryApplicationVersion]) – A list of gallery Application Versions. Required.
next_link (str) – The uri to fetch the next page of gallery Application Versions. Call ListNext() with this to fetch the next page of gallery Application Versions.

class azure.mgmt.compute.v2022_01_03.models.GalleryApplicationVersionPublishingProfile(*, source: _models.UserArtifactSource, target_regions: List[_models.TargetRegion] | None = None, replica_count: int | None = None, exclude_from_latest: bool | None = None, end_of_life_date: datetime | None = None, storage_account_type: str | _models.StorageAccountType | None = None, replication_mode: str | _models.ReplicationMode | None = None, target_extended_locations: List[_models.GalleryTargetExtendedLocation] | None = None, manage_actions: _models.UserArtifactManage | None = None, settings: _models.UserArtifactSettings | None = None, advanced_settings: Dict[str, str] | None = None, enable_health_check: bool | None = None, **kwargs: Any)[source]¶

Bases: GalleryArtifactPublishingProfileBase

The publishing profile of a gallery image version.

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.

Variables:

target_regions (list[TargetRegion]) – The target regions where the Image Version is going to be replicated to. This property is updatable.
replica_count (int) – The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable.
exclude_from_latest (bool) – If set to true, Virtual Machines deployed from the latest version of the Image Definition won’t use this Image Version.
published_date (datetime) – The timestamp for when the gallery image version is published.
end_of_life_date (datetime) – The end of life date of the gallery image version. This property can be used for decommissioning purposes. This property is updatable.
storage_account_type (str or StorageAccountType) – Specifies the storage account type to be used to store the image. This property is not updatable. Known values are: “Standard_LRS”, “Standard_ZRS”, “Premium_LRS”, and “StandardSSD_LRS”.
replication_mode (str or ReplicationMode) – Optional parameter which specifies the mode to be used for replication. This property is not updatable. Known values are: “Full” and “Shallow”.
target_extended_locations (list[GalleryTargetExtendedLocation]) – The target extended locations where the Image Version is going to be replicated to. This property is updatable.
source (UserArtifactSource) – The source image from which the Image Version is going to be created. Required.
manage_actions (UserArtifactManage)
settings (UserArtifactSettings) – Additional settings for the VM app that contains the target package and config file name when it is deployed to target VM or VM scale set.
advanced_settings (dict[str, str]) – Optional. Additional settings to pass to the vm-application-manager extension. For advanced use only.
enable_health_check (bool) – Optional. Whether or not this application reports health.

Keyword Arguments:

target_regions (list[TargetRegion]) – The target regions where the Image Version is going to be replicated to. This property is updatable.
replica_count (int) – The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable.
exclude_from_latest (bool) – If set to true, Virtual Machines deployed from the latest version of the Image Definition won’t use this Image Version.
end_of_life_date (datetime) – The end of life date of the gallery image version. This property can be used for decommissioning purposes. This property is updatable.
storage_account_type (str or StorageAccountType) – Specifies the storage account type to be used to store the image. This property is not updatable. Known values are: “Standard_LRS”, “Standard_ZRS”, “Premium_LRS”, and “StandardSSD_LRS”.
replication_mode (str or ReplicationMode) – Optional parameter which specifies the mode to be used for replication. This property is not updatable. Known values are: “Full” and “Shallow”.
target_extended_locations (list[GalleryTargetExtendedLocation]) – The target extended locations where the Image Version is going to be replicated to. This property is updatable.
source (UserArtifactSource) – The source image from which the Image Version is going to be created. Required.
manage_actions (UserArtifactManage)
settings (UserArtifactSettings) – Additional settings for the VM app that contains the target package and config file name when it is deployed to target VM or VM scale set.
advanced_settings (dict[str, str]) – Optional. Additional settings to pass to the vm-application-manager extension. For advanced use only.
enable_health_check (bool) – Optional. Whether or not this application reports health.

class azure.mgmt.compute.v2022_01_03.models.GalleryApplicationVersionUpdate(*, tags: Dict[str, str] | None = None, publishing_profile: _models.GalleryApplicationVersionPublishingProfile | None = None, **kwargs: Any)[source]¶

Bases: UpdateResourceDefinition

Specifies information about the gallery Application Version that you want to update.

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

Variables:

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
tags (dict[str, str]) – Resource tags.
publishing_profile (GalleryApplicationVersionPublishingProfile) – The publishing profile of a gallery image version.
provisioning_state (str or GalleryProvisioningState) – The provisioning state, which only appears in the response. Known values are: “Creating”, “Updating”, “Failed”, “Succeeded”, “Deleting”, and “Migrating”.
replication_status (ReplicationStatus) – This is the replication status of the gallery image version.

Keyword Arguments:

tags (dict[str, str]) – Resource tags.
publishing_profile (GalleryApplicationVersionPublishingProfile) – The publishing profile of a gallery image version.

class azure.mgmt.compute.v2022_01_03.models.GalleryArtifactPublishingProfileBase(*, target_regions: List[_models.TargetRegion] | None = None, replica_count: int | None = None, exclude_from_latest: bool | None = None, end_of_life_date: datetime | None = None, storage_account_type: str | _models.StorageAccountType | None = None, replication_mode: str | _models.ReplicationMode | None = None, target_extended_locations: List[_models.GalleryTargetExtendedLocation] | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes the basic gallery artifact publishing profile.

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

Variables:

target_regions (list[TargetRegion]) – The target regions where the Image Version is going to be replicated to. This property is updatable.
replica_count (int) – The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable.
exclude_from_latest (bool) – If set to true, Virtual Machines deployed from the latest version of the Image Definition won’t use this Image Version.
published_date (datetime) – The timestamp for when the gallery image version is published.
end_of_life_date (datetime) – The end of life date of the gallery image version. This property can be used for decommissioning purposes. This property is updatable.
storage_account_type (str or StorageAccountType) – Specifies the storage account type to be used to store the image. This property is not updatable. Known values are: “Standard_LRS”, “Standard_ZRS”, “Premium_LRS”, and “StandardSSD_LRS”.
replication_mode (str or ReplicationMode) – Optional parameter which specifies the mode to be used for replication. This property is not updatable. Known values are: “Full” and “Shallow”.
target_extended_locations (list[GalleryTargetExtendedLocation]) – The target extended locations where the Image Version is going to be replicated to. This property is updatable.

Keyword Arguments:

target_regions (list[TargetRegion]) – The target regions where the Image Version is going to be replicated to. This property is updatable.
replica_count (int) – The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable.
exclude_from_latest (bool) – If set to true, Virtual Machines deployed from the latest version of the Image Definition won’t use this Image Version.
end_of_life_date (datetime) – The end of life date of the gallery image version. This property can be used for decommissioning purposes. This property is updatable.
storage_account_type (str or StorageAccountType) – Specifies the storage account type to be used to store the image. This property is not updatable. Known values are: “Standard_LRS”, “Standard_ZRS”, “Premium_LRS”, and “StandardSSD_LRS”.
replication_mode (str or ReplicationMode) – Optional parameter which specifies the mode to be used for replication. This property is not updatable. Known values are: “Full” and “Shallow”.
target_extended_locations (list[GalleryTargetExtendedLocation]) – The target extended locations where the Image Version is going to be replicated to. This property is updatable.

class azure.mgmt.compute.v2022_01_03.models.GalleryArtifactSource(*, managed_image: _models.ManagedArtifact, **kwargs: Any)[source]¶

Bases: Model

The source image from which the Image Version is going to be created.

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

Variables:: managed_image (ManagedArtifact) – The managed artifact. Required.
Keyword Arguments:: managed_image (ManagedArtifact) – The managed artifact. Required.

class azure.mgmt.compute.v2022_01_03.models.GalleryArtifactVersionSource(*, id: str | None = None, uri: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The gallery artifact version source.

Variables:

id (str) – The id of the gallery artifact version source. Can specify a disk uri, snapshot uri, user image or storage account resource.
uri (str) – The uri of the gallery artifact version source. Currently used to specify vhd/blob source.

Keyword Arguments:

id (str) – The id of the gallery artifact version source. Can specify a disk uri, snapshot uri, user image or storage account resource.
uri (str) – The uri of the gallery artifact version source. Currently used to specify vhd/blob source.

class azure.mgmt.compute.v2022_01_03.models.GalleryDataDiskImage(*, lun: int, host_caching: str | _models.HostCaching | None = None, source: _models.GalleryArtifactVersionSource | None = None, **kwargs: Any)[source]¶

Bases: GalleryDiskImage

This is the data disk image.

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.

Variables:

size_in_gb (int) – This property indicates the size of the VHD to be created.
host_caching (str or HostCaching) – The host caching of the disk. Valid values are ‘None’, ‘ReadOnly’, and ‘ReadWrite’. Known values are: “None”, “ReadOnly”, and “ReadWrite”.
source (GalleryArtifactVersionSource) – The gallery artifact version source.
lun (int) – This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. Required.

Keyword Arguments:

host_caching (str or HostCaching) – The host caching of the disk. Valid values are ‘None’, ‘ReadOnly’, and ‘ReadWrite’. Known values are: “None”, “ReadOnly”, and “ReadWrite”.
source (GalleryArtifactVersionSource) – The gallery artifact version source.
lun (int) – This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. Required.

class azure.mgmt.compute.v2022_01_03.models.GalleryDiskImage(*, host_caching: str | _models.HostCaching | None = None, source: _models.GalleryArtifactVersionSource | None = None, **kwargs: Any)[source]¶

Bases: Model

This is the disk image base class.

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

Variables:

size_in_gb (int) – This property indicates the size of the VHD to be created.
host_caching (str or HostCaching) – The host caching of the disk. Valid values are ‘None’, ‘ReadOnly’, and ‘ReadWrite’. Known values are: “None”, “ReadOnly”, and “ReadWrite”.
source (GalleryArtifactVersionSource) – The gallery artifact version source.

Keyword Arguments:

host_caching (str or HostCaching) – The host caching of the disk. Valid values are ‘None’, ‘ReadOnly’, and ‘ReadWrite’. Known values are: “None”, “ReadOnly”, and “ReadWrite”.
source (GalleryArtifactVersionSource) – The gallery artifact version source.

class azure.mgmt.compute.v2022_01_03.models.GalleryExpandParams(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

GalleryExpandParams.

SHARING_PROFILE_GROUPS = 'SharingProfile/Groups'¶

class azure.mgmt.compute.v2022_01_03.models.GalleryExtendedLocation(*, name: str | None = None, type: str | _models.GalleryExtendedLocationType | None = None, **kwargs: Any)[source]¶

Bases: Model

The name of the extended location.

Variables:

name (str)
type (str or GalleryExtendedLocationType) – It is type of the extended location. Known values are: “EdgeZone” and “Unknown”.

Keyword Arguments:

name (str)
type (str or GalleryExtendedLocationType) – It is type of the extended location. Known values are: “EdgeZone” and “Unknown”.

class azure.mgmt.compute.v2022_01_03.models.GalleryExtendedLocationType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

It is type of the extended location.

EDGE_ZONE = 'EdgeZone'¶

UNKNOWN = 'Unknown'¶

class azure.mgmt.compute.v2022_01_03.models.GalleryIdentifier(**kwargs: Any)[source]¶

Bases: Model

Describes the gallery unique name.

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

Variables:: unique_name (str) – The unique name of the Shared Image Gallery. This name is generated automatically by Azure.

class azure.mgmt.compute.v2022_01_03.models.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, **kwargs: Any)[source]¶

Bases: Resource

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.

Variables:

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.   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”.

Keyword Arguments:

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.   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.
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”.

class azure.mgmt.compute.v2022_01_03.models.GalleryImageFeature(*, name: str | None = None, value: str | None = None, **kwargs: Any)[source]¶

Bases: Model

A feature for gallery image.

Variables:

name (str) – The name of the gallery image feature.
value (str) – The value of the gallery image feature.

Keyword Arguments:

name (str) – The name of the gallery image feature.
value (str) – The value of the gallery image feature.

class azure.mgmt.compute.v2022_01_03.models.GalleryImageIdentifier(*, publisher: str, offer: str, sku: str, **kwargs: Any)[source]¶

Bases: Model

This is the gallery image definition identifier.

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

Variables:

publisher (str) – The name of the gallery image definition publisher. Required.
offer (str) – The name of the gallery image definition offer. Required.
sku (str) – The name of the gallery image definition SKU. Required.

Keyword Arguments:

publisher (str) – The name of the gallery image definition publisher. Required.
offer (str) – The name of the gallery image definition offer. Required.
sku (str) – The name of the gallery image definition SKU. Required.

class azure.mgmt.compute.v2022_01_03.models.GalleryImageList(*, value: List[_models.GalleryImage], next_link: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The List Gallery Images operation response.

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

Variables:

value (list[GalleryImage]) – A list of Shared Image Gallery images. Required.
next_link (str) – The uri to fetch the next page of Image Definitions in the Shared Image Gallery. Call ListNext() with this to fetch the next page of gallery image definitions.

Keyword Arguments:

value (list[GalleryImage]) – A list of Shared Image Gallery images. Required.
next_link (str) – The uri to fetch the next page of Image Definitions in the Shared Image Gallery. Call ListNext() with this to fetch the next page of gallery image definitions.

Bases: UpdateResourceDefinition

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

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

Variables:

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
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.   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”.

Keyword Arguments:

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.   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.
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”.

class azure.mgmt.compute.v2022_01_03.models.GalleryImageVersion(*, location: str, tags: Dict[str, str] | None = None, publishing_profile: _models.GalleryImageVersionPublishingProfile | None = None, storage_profile: _models.GalleryImageVersionStorageProfile | None = None, **kwargs: Any)[source]¶

Bases: Resource

Specifies information about the gallery image version 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.

Variables:

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
publishing_profile (GalleryImageVersionPublishingProfile) – The publishing profile of a gallery image Version.
provisioning_state (str or GalleryProvisioningState) – The provisioning state, which only appears in the response. Known values are: “Creating”, “Updating”, “Failed”, “Succeeded”, “Deleting”, and “Migrating”.
storage_profile (GalleryImageVersionStorageProfile) – This is the storage profile of a Gallery Image Version.
replication_status (ReplicationStatus) – This is the replication status of the gallery image version.

Keyword Arguments:

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
publishing_profile (GalleryImageVersionPublishingProfile) – The publishing profile of a gallery image Version.
storage_profile (GalleryImageVersionStorageProfile) – This is the storage profile of a Gallery Image Version.

class azure.mgmt.compute.v2022_01_03.models.GalleryImageVersionList(*, value: List[_models.GalleryImageVersion], next_link: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The List Gallery Image version operation response.

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

Variables:

value (list[GalleryImageVersion]) – A list of gallery image versions. Required.
next_link (str) – The uri to fetch the next page of gallery image versions. Call ListNext() with this to fetch the next page of gallery image versions.

Keyword Arguments:

value (list[GalleryImageVersion]) – A list of gallery image versions. Required.
next_link (str) – The uri to fetch the next page of gallery image versions. Call ListNext() with this to fetch the next page of gallery image versions.

class azure.mgmt.compute.v2022_01_03.models.GalleryImageVersionPublishingProfile(*, target_regions: List[_models.TargetRegion] | None = None, replica_count: int | None = None, exclude_from_latest: bool | None = None, end_of_life_date: datetime | None = None, storage_account_type: str | _models.StorageAccountType | None = None, replication_mode: str | _models.ReplicationMode | None = None, target_extended_locations: List[_models.GalleryTargetExtendedLocation] | None = None, **kwargs: Any)[source]¶

Bases: GalleryArtifactPublishingProfileBase

The publishing profile of a gallery image Version.

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

Variables:

target_regions (list[TargetRegion]) – The target regions where the Image Version is going to be replicated to. This property is updatable.
replica_count (int) – The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable.
exclude_from_latest (bool) – If set to true, Virtual Machines deployed from the latest version of the Image Definition won’t use this Image Version.
published_date (datetime) – The timestamp for when the gallery image version is published.
end_of_life_date (datetime) – The end of life date of the gallery image version. This property can be used for decommissioning purposes. This property is updatable.
storage_account_type (str or StorageAccountType) – Specifies the storage account type to be used to store the image. This property is not updatable. Known values are: “Standard_LRS”, “Standard_ZRS”, “Premium_LRS”, and “StandardSSD_LRS”.
replication_mode (str or ReplicationMode) – Optional parameter which specifies the mode to be used for replication. This property is not updatable. Known values are: “Full” and “Shallow”.
target_extended_locations (list[GalleryTargetExtendedLocation]) – The target extended locations where the Image Version is going to be replicated to. This property is updatable.

Keyword Arguments:

target_regions (list[TargetRegion]) – The target regions where the Image Version is going to be replicated to. This property is updatable.
replica_count (int) – The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable.
exclude_from_latest (bool) – If set to true, Virtual Machines deployed from the latest version of the Image Definition won’t use this Image Version.
end_of_life_date (datetime) – The end of life date of the gallery image version. This property can be used for decommissioning purposes. This property is updatable.
storage_account_type (str or StorageAccountType) – Specifies the storage account type to be used to store the image. This property is not updatable. Known values are: “Standard_LRS”, “Standard_ZRS”, “Premium_LRS”, and “StandardSSD_LRS”.
replication_mode (str or ReplicationMode) – Optional parameter which specifies the mode to be used for replication. This property is not updatable. Known values are: “Full” and “Shallow”.
target_extended_locations (list[GalleryTargetExtendedLocation]) – The target extended locations where the Image Version is going to be replicated to. This property is updatable.

class azure.mgmt.compute.v2022_01_03.models.GalleryImageVersionStorageProfile(*, source: _models.GalleryArtifactVersionSource | None = None, os_disk_image: _models.GalleryOSDiskImage | None = None, data_disk_images: List[_models.GalleryDataDiskImage] | None = None, **kwargs: Any)[source]¶

Bases: Model

This is the storage profile of a Gallery Image Version.

Variables:

source (GalleryArtifactVersionSource) – The gallery artifact version source.
os_disk_image (GalleryOSDiskImage) – This is the OS disk image.
data_disk_images (list[GalleryDataDiskImage]) – A list of data disk images.

Keyword Arguments:

source (GalleryArtifactVersionSource) – The gallery artifact version source.
os_disk_image (GalleryOSDiskImage) – This is the OS disk image.
data_disk_images (list[GalleryDataDiskImage]) – A list of data disk images.

class azure.mgmt.compute.v2022_01_03.models.GalleryImageVersionUpdate(*, tags: Dict[str, str] | None = None, publishing_profile: _models.GalleryImageVersionPublishingProfile | None = None, storage_profile: _models.GalleryImageVersionStorageProfile | None = None, **kwargs: Any)[source]¶

Bases: UpdateResourceDefinition

Specifies information about the gallery image version that you want to update.

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

Variables:

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
tags (dict[str, str]) – Resource tags.
publishing_profile (GalleryImageVersionPublishingProfile) – The publishing profile of a gallery image Version.
provisioning_state (str or GalleryProvisioningState) – The provisioning state, which only appears in the response. Known values are: “Creating”, “Updating”, “Failed”, “Succeeded”, “Deleting”, and “Migrating”.
storage_profile (GalleryImageVersionStorageProfile) – This is the storage profile of a Gallery Image Version.
replication_status (ReplicationStatus) – This is the replication status of the gallery image version.

Keyword Arguments:

tags (dict[str, str]) – Resource tags.
publishing_profile (GalleryImageVersionPublishingProfile) – The publishing profile of a gallery image Version.
storage_profile (GalleryImageVersionStorageProfile) – This is the storage profile of a Gallery Image Version.

class azure.mgmt.compute.v2022_01_03.models.GalleryList(*, value: List[_models.Gallery], next_link: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The List Galleries operation response.

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

Variables:

value (list[Gallery]) – A list of galleries. Required.
next_link (str) – The uri to fetch the next page of galleries. Call ListNext() with this to fetch the next page of galleries.

Keyword Arguments:

value (list[Gallery]) – A list of galleries. Required.
next_link (str) – The uri to fetch the next page of galleries. Call ListNext() with this to fetch the next page of galleries.

class azure.mgmt.compute.v2022_01_03.models.GalleryOSDiskImage(*, host_caching: str | _models.HostCaching | None = None, source: _models.GalleryArtifactVersionSource | None = None, **kwargs: Any)[source]¶

Bases: GalleryDiskImage

This is the OS disk image.

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

Variables:

size_in_gb (int) – This property indicates the size of the VHD to be created.
host_caching (str or HostCaching) – The host caching of the disk. Valid values are ‘None’, ‘ReadOnly’, and ‘ReadWrite’. Known values are: “None”, “ReadOnly”, and “ReadWrite”.
source (GalleryArtifactVersionSource) – The gallery artifact version source.

Keyword Arguments:

host_caching (str or HostCaching) – The host caching of the disk. Valid values are ‘None’, ‘ReadOnly’, and ‘ReadWrite’. Known values are: “None”, “ReadOnly”, and “ReadWrite”.
source (GalleryArtifactVersionSource) – The gallery artifact version source.

class azure.mgmt.compute.v2022_01_03.models.GalleryProvisioningState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The provisioning state, which only appears in the response.

CREATING = 'Creating'¶

DELETING = 'Deleting'¶

FAILED = 'Failed'¶

MIGRATING = 'Migrating'¶

SUCCEEDED = 'Succeeded'¶

UPDATING = 'Updating'¶

class azure.mgmt.compute.v2022_01_03.models.GallerySharingPermissionTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

This property allows you to specify the permission of sharing gallery.   Possible values are:   Private   Groups   Community.

COMMUNITY = 'Community'¶

GROUPS = 'Groups'¶

PRIVATE = 'Private'¶

class azure.mgmt.compute.v2022_01_03.models.GalleryTargetExtendedLocation(*, name: str | None = None, extended_location: _models.GalleryExtendedLocation | None = None, extended_location_replica_count: int | None = None, storage_account_type: str | _models.StorageAccountType | None = None, encryption: _models.EncryptionImages | None = None, **kwargs: Any)[source]¶

Bases: Model

GalleryTargetExtendedLocation.

Variables:

name (str) – The name of the region.
extended_location (GalleryExtendedLocation) – The name of the extended location.
extended_location_replica_count (int) – The number of replicas of the Image Version to be created per extended location. This property is updatable.
storage_account_type (str or StorageAccountType) – Specifies the storage account type to be used to store the image. This property is not updatable. Known values are: “Standard_LRS”, “Standard_ZRS”, “Premium_LRS”, and “StandardSSD_LRS”.
encryption (EncryptionImages) – Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact.

Keyword Arguments:

name (str) – The name of the region.
extended_location (GalleryExtendedLocation) – The name of the extended location.
extended_location_replica_count (int) – The number of replicas of the Image Version to be created per extended location. This property is updatable.
storage_account_type (str or StorageAccountType) – Specifies the storage account type to be used to store the image. This property is not updatable. Known values are: “Standard_LRS”, “Standard_ZRS”, “Premium_LRS”, and “StandardSSD_LRS”.
encryption (EncryptionImages) – Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact.

class azure.mgmt.compute.v2022_01_03.models.GalleryUpdate(*, tags: Dict[str, str] | None = None, description: str | None = None, identifier: _models.GalleryIdentifier | None = None, sharing_profile: _models.SharingProfile | None = None, soft_delete_policy: _models.SoftDeletePolicy | None = None, **kwargs: Any)[source]¶

Bases: UpdateResourceDefinition

Specifies information about the Shared Image Gallery that you want to update.

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

Variables:

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
tags (dict[str, str]) – Resource tags.
description (str) – The description of this Shared Image Gallery resource. This property is updatable.
identifier (GalleryIdentifier) – Describes the gallery unique name.
provisioning_state (str or GalleryProvisioningState) – The provisioning state, which only appears in the response. Known values are: “Creating”, “Updating”, “Failed”, “Succeeded”, “Deleting”, and “Migrating”.
sharing_profile (SharingProfile) – Profile for gallery sharing to subscription or tenant.
soft_delete_policy (SoftDeletePolicy) – Contains information about the soft deletion policy of the gallery.
sharing_status (SharingStatus) – Sharing status of current gallery.

Keyword Arguments:

tags (dict[str, str]) – Resource tags.
description (str) – The description of this Shared Image Gallery resource. This property is updatable.
identifier (GalleryIdentifier) – Describes the gallery unique name.
sharing_profile (SharingProfile) – Profile for gallery sharing to subscription or tenant.
soft_delete_policy (SoftDeletePolicy) – Contains information about the soft deletion policy of the gallery.

class azure.mgmt.compute.v2022_01_03.models.HostCaching(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The host caching of the disk. Valid values are ‘None’, ‘ReadOnly’, and ‘ReadWrite’.

NONE = 'None'¶

READ_ONLY = 'ReadOnly'¶

READ_WRITE = 'ReadWrite'¶

class azure.mgmt.compute.v2022_01_03.models.HyperVGeneration(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The hypervisor generation of the Virtual Machine. Applicable to OS disks only.

V1 = 'V1'¶

V2 = 'V2'¶

class azure.mgmt.compute.v2022_01_03.models.ImagePurchasePlan(*, name: str | None = None, publisher: str | None = None, product: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes the gallery image definition purchase plan. This is used by marketplace images.

Variables:

name (str) – The plan ID.
publisher (str) – The publisher ID.
product (str) – The product ID.

Keyword Arguments:

name (str) – The plan ID.
publisher (str) – The publisher ID.
product (str) – The product ID.

class azure.mgmt.compute.v2022_01_03.models.InnerError(*, exceptiontype: str | None = None, errordetail: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Inner error details.

Variables:

exceptiontype (str) – The exception type.
errordetail (str) – The internal error message or exception dump.

Keyword Arguments:

exceptiontype (str) – The exception type.
errordetail (str) – The internal error message or exception dump.

class azure.mgmt.compute.v2022_01_03.models.ManagedArtifact(*, id: str, **kwargs: Any)[source]¶

Bases: Model

The managed artifact.

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

Variables:: id (str) – The managed artifact id. Required.
Keyword Arguments:: id (str) – The managed artifact id. Required.

class azure.mgmt.compute.v2022_01_03.models.OSDiskImageEncryption(*, disk_encryption_set_id: str | None = None, security_profile: _models.OSDiskImageSecurityProfile | None = None, **kwargs: Any)[source]¶

Bases: DiskImageEncryption

Contains encryption settings for an OS disk image.

Variables:

disk_encryption_set_id (str) – A relative URI containing the resource ID of the disk encryption set.
security_profile (OSDiskImageSecurityProfile) – This property specifies the security profile of an OS disk image.

Keyword Arguments:

disk_encryption_set_id (str) – A relative URI containing the resource ID of the disk encryption set.
security_profile (OSDiskImageSecurityProfile) – This property specifies the security profile of an OS disk image.

class azure.mgmt.compute.v2022_01_03.models.OSDiskImageSecurityProfile(*, confidential_vm_encryption_type: str | _models.ConfidentialVMEncryptionType | None = None, secure_vm_disk_encryption_set_id: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Contains security profile for an OS disk image.

Variables:

confidential_vm_encryption_type (str or ConfidentialVMEncryptionType) – confidential VM encryption types. Known values are: “EncryptedVMGuestStateOnlyWithPmk”, “EncryptedWithPmk”, and “EncryptedWithCmk”.
secure_vm_disk_encryption_set_id (str) – secure VM disk encryption set id.

Keyword Arguments:

confidential_vm_encryption_type (str or ConfidentialVMEncryptionType) – confidential VM encryption types. Known values are: “EncryptedVMGuestStateOnlyWithPmk”, “EncryptedWithPmk”, and “EncryptedWithCmk”.
secure_vm_disk_encryption_set_id (str) – secure VM disk encryption set id.

class azure.mgmt.compute.v2022_01_03.models.OperatingSystemStateTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

This property allows the user to specify whether the virtual machines created under this image are ‘Generalized’ or ‘Specialized’.

GENERALIZED = 'Generalized'¶

SPECIALIZED = 'Specialized'¶

class azure.mgmt.compute.v2022_01_03.models.OperatingSystemTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

This property allows you to specify the supported type of the OS that application is built for.   Possible values are:   Windows   Linux.

LINUX = 'Linux'¶

WINDOWS = 'Windows'¶

class azure.mgmt.compute.v2022_01_03.models.PirCommunityGalleryResource(*, unique_id: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Base information about the community gallery resource in pir.

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

Variables:

name (str) – Resource name.
location (str) – Resource location.
type (str) – Resource type.
unique_id (str) – The unique id of this community gallery.

Keyword Arguments:

unique_id (str) – The unique id of this community gallery.

class azure.mgmt.compute.v2022_01_03.models.PirResource(**kwargs: Any)[source]¶

Bases: Model

The Resource model definition.

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

Variables:

name (str) – Resource name.
location (str) – Resource location.

class azure.mgmt.compute.v2022_01_03.models.PirSharedGalleryResource(*, unique_id: str | None = None, **kwargs: Any)[source]¶

Bases: PirResource

Base information about the shared gallery resource in pir.

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

Variables:

name (str) – Resource name.
location (str) – Resource location.
unique_id (str) – The unique id of this shared gallery.

Keyword Arguments:

unique_id (str) – The unique id of this shared gallery.

class azure.mgmt.compute.v2022_01_03.models.RecommendedMachineConfiguration(*, v_cp_us: _models.ResourceRange | None = None, memory: _models.ResourceRange | None = None, **kwargs: Any)[source]¶

Bases: Model

The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.

Variables:

v_cp_us (ResourceRange) – Describes the resource range.
memory (ResourceRange) – Describes the resource range.

Keyword Arguments:

v_cp_us (ResourceRange) – Describes the resource range.
memory (ResourceRange) – Describes the resource range.

class azure.mgmt.compute.v2022_01_03.models.RegionalReplicationStatus(**kwargs: Any)[source]¶

Bases: Model

This is the regional replication status.

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

Variables:

region (str) – The region to which the gallery image version is being replicated to.
state (str or ReplicationState) – This is the regional replication state. Known values are: “Unknown”, “Replicating”, “Completed”, and “Failed”.
details (str) – The details of the replication status.
progress (int) – It indicates progress of the replication job.

class azure.mgmt.compute.v2022_01_03.models.RegionalSharingStatus(*, region: str | None = None, details: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Gallery regional sharing status.

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

Variables:

region (str) – Region name.
state (str or SharingState) – Gallery sharing state in current region. Known values are: “Succeeded”, “InProgress”, “Failed”, and “Unknown”.
details (str) – Details of gallery regional sharing failure.

Keyword Arguments:

region (str) – Region name.
details (str) – Details of gallery regional sharing failure.

class azure.mgmt.compute.v2022_01_03.models.ReplicationMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Optional parameter which specifies the mode to be used for replication. This property is not updatable.

FULL = 'Full'¶

SHALLOW = 'Shallow'¶

class azure.mgmt.compute.v2022_01_03.models.ReplicationState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

This is the regional replication state.

COMPLETED = 'Completed'¶

FAILED = 'Failed'¶

REPLICATING = 'Replicating'¶

UNKNOWN = 'Unknown'¶

class azure.mgmt.compute.v2022_01_03.models.ReplicationStatus(**kwargs: Any)[source]¶

Bases: Model

This is the replication status of the gallery image version.

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

Variables:

aggregated_state (str or AggregatedReplicationState) – This is the aggregated replication status based on all the regional replication status flags. Known values are: “Unknown”, “InProgress”, “Completed”, and “Failed”.
summary (list[RegionalReplicationStatus]) – This is a summary of replication status for each region.

class azure.mgmt.compute.v2022_01_03.models.ReplicationStatusTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

ReplicationStatusTypes.

REPLICATION_STATUS = 'ReplicationStatus'¶

class azure.mgmt.compute.v2022_01_03.models.Resource(*, location: str, tags: Dict[str, str] | None = None, **kwargs: Any)[source]¶

Bases: Model

The Resource model definition.

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.

Variables:

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.

Keyword Arguments:

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.

class azure.mgmt.compute.v2022_01_03.models.ResourceRange(*, min: int | None = None, max: int | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes the resource range.

Variables:

min (int) – The minimum number of the resource.
max (int) – The maximum number of the resource.

Keyword Arguments:

min (int) – The minimum number of the resource.
max (int) – The maximum number of the resource.

class azure.mgmt.compute.v2022_01_03.models.ResourceWithOptionalLocation(*, location: str | None = None, tags: Dict[str, str] | None = None, **kwargs: Any)[source]¶

Bases: Model

The Resource model definition with location property as optional.

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

Variables:

location (str) – Resource location.
id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
tags (dict[str, str]) – Resource tags.

Keyword Arguments:

location (str) – Resource location.
tags (dict[str, str]) – Resource tags.

class azure.mgmt.compute.v2022_01_03.models.SelectPermissions(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

SelectPermissions.

PERMISSIONS = 'Permissions'¶

class azure.mgmt.compute.v2022_01_03.models.SharedGallery(*, unique_id: str | None = None, **kwargs: Any)[source]¶

Bases: PirSharedGalleryResource

Specifies information about the Shared Gallery that you want to create or update.

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

Variables:

name (str) – Resource name.
location (str) – Resource location.
unique_id (str) – The unique id of this shared gallery.

Keyword Arguments:

unique_id (str) – The unique id of this shared gallery.

class azure.mgmt.compute.v2022_01_03.models.SharedGalleryDataDiskImage(*, lun: int, host_caching: str | _models.SharedGalleryHostCaching | None = None, **kwargs: Any)[source]¶

Bases: SharedGalleryDiskImage

This is the data disk image.

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.

Variables:

disk_size_gb (int) – This property indicates the size of the VHD to be created.
host_caching (str or SharedGalleryHostCaching) – The host caching of the disk. Valid values are ‘None’, ‘ReadOnly’, and ‘ReadWrite’. Known values are: “None”, “ReadOnly”, and “ReadWrite”.
lun (int) – This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. Required.

Keyword Arguments:

host_caching (str or SharedGalleryHostCaching) – The host caching of the disk. Valid values are ‘None’, ‘ReadOnly’, and ‘ReadWrite’. Known values are: “None”, “ReadOnly”, and “ReadWrite”.
lun (int) – This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. Required.

class azure.mgmt.compute.v2022_01_03.models.SharedGalleryDiskImage(*, host_caching: str | _models.SharedGalleryHostCaching | None = None, **kwargs: Any)[source]¶

Bases: Model

This is the disk image base class.

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

Variables:

disk_size_gb (int) – This property indicates the size of the VHD to be created.
host_caching (str or SharedGalleryHostCaching) – The host caching of the disk. Valid values are ‘None’, ‘ReadOnly’, and ‘ReadWrite’. Known values are: “None”, “ReadOnly”, and “ReadWrite”.

Keyword Arguments:

host_caching (str or SharedGalleryHostCaching) – The host caching of the disk. Valid values are ‘None’, ‘ReadOnly’, and ‘ReadWrite’. Known values are: “None”, “ReadOnly”, and “ReadWrite”.

class azure.mgmt.compute.v2022_01_03.models.SharedGalleryHostCaching(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The host caching of the disk. Valid values are ‘None’, ‘ReadOnly’, and ‘ReadWrite’.

NONE = 'None'¶

READ_ONLY = 'ReadOnly'¶

READ_WRITE = 'ReadWrite'¶

class azure.mgmt.compute.v2022_01_03.models.SharedGalleryImage(*, unique_id: 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, hyper_v_generation: str | _models.HyperVGeneration | None = None, features: List[_models.GalleryImageFeature] | None = None, purchase_plan: _models.ImagePurchasePlan | None = None, architecture: str | _models.Architecture | None = None, **kwargs: Any)[source]¶

Bases: PirSharedGalleryResource

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.

Variables:

name (str) – Resource name.
location (str) – Resource location.
unique_id (str) – The unique id of this shared gallery.
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”.
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.
hyper_v_generation (str or HyperVGeneration) – The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Known values are: “V1” and “V2”.
features (list[GalleryImageFeature]) – A list of gallery image features.
purchase_plan (ImagePurchasePlan) – Describes the gallery image definition purchase plan. This is used by marketplace images.
architecture (str or Architecture) – The architecture of the image. Applicable to OS disks only. Known values are: “x64” and “Arm64”.

Keyword Arguments:

unique_id (str) – The unique id of this shared gallery.
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”.
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.
hyper_v_generation (str or HyperVGeneration) – The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Known values are: “V1” and “V2”.
features (list[GalleryImageFeature]) – A list of gallery image features.
purchase_plan (ImagePurchasePlan) – Describes the gallery image definition purchase plan. This is used by marketplace images.
architecture (str or Architecture) – The architecture of the image. Applicable to OS disks only. Known values are: “x64” and “Arm64”.

class azure.mgmt.compute.v2022_01_03.models.SharedGalleryImageList(*, value: List[_models.SharedGalleryImage], next_link: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The List Shared Gallery Images operation response.

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

Variables:

value (list[SharedGalleryImage]) – A list of shared gallery images. Required.
next_link (str) – The uri to fetch the next page of shared gallery images. Call ListNext() with this to fetch the next page of shared gallery images.

Keyword Arguments:

value (list[SharedGalleryImage]) – A list of shared gallery images. Required.
next_link (str) – The uri to fetch the next page of shared gallery images. Call ListNext() with this to fetch the next page of shared gallery images.

class azure.mgmt.compute.v2022_01_03.models.SharedGalleryImageVersion(*, unique_id: str | None = None, published_date: datetime | None = None, end_of_life_date: datetime | None = None, exclude_from_latest: bool | None = None, storage_profile: _models.SharedGalleryImageVersionStorageProfile | None = None, **kwargs: Any)[source]¶

Bases: PirSharedGalleryResource

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

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

Variables:

name (str) – Resource name.
location (str) – Resource location.
unique_id (str) – The unique id of this shared gallery.
published_date (datetime) – The published date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable.
end_of_life_date (datetime) – The end of life date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable.
exclude_from_latest (bool) – If set to true, Virtual Machines deployed from the latest version of the Image Definition won’t use this Image Version.
storage_profile (SharedGalleryImageVersionStorageProfile) – Describes the storage profile of the image version.

Keyword Arguments:

unique_id (str) – The unique id of this shared gallery.
published_date (datetime) – The published date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable.
end_of_life_date (datetime) – The end of life date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable.
exclude_from_latest (bool) – If set to true, Virtual Machines deployed from the latest version of the Image Definition won’t use this Image Version.
storage_profile (SharedGalleryImageVersionStorageProfile) – Describes the storage profile of the image version.

class azure.mgmt.compute.v2022_01_03.models.SharedGalleryImageVersionList(*, value: List[_models.SharedGalleryImageVersion], next_link: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The List Shared Gallery Image versions operation response.

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

Variables:

value (list[SharedGalleryImageVersion]) – A list of shared gallery images versions. Required.
next_link (str) – The uri to fetch the next page of shared gallery image versions. Call ListNext() with this to fetch the next page of shared gallery image versions.

Keyword Arguments:

value (list[SharedGalleryImageVersion]) – A list of shared gallery images versions. Required.
next_link (str) – The uri to fetch the next page of shared gallery image versions. Call ListNext() with this to fetch the next page of shared gallery image versions.

class azure.mgmt.compute.v2022_01_03.models.SharedGalleryImageVersionStorageProfile(*, os_disk_image: _models.SharedGalleryOSDiskImage | None = None, data_disk_images: List[_models.SharedGalleryDataDiskImage] | None = None, **kwargs: Any)[source]¶

Bases: Model

This is the storage profile of a Gallery Image Version.

Variables:

os_disk_image (SharedGalleryOSDiskImage) – This is the OS disk image.
data_disk_images (list[SharedGalleryDataDiskImage]) – A list of data disk images.

Keyword Arguments:

os_disk_image (SharedGalleryOSDiskImage) – This is the OS disk image.
data_disk_images (list[SharedGalleryDataDiskImage]) – A list of data disk images.

class azure.mgmt.compute.v2022_01_03.models.SharedGalleryList(*, value: List[_models.SharedGallery], next_link: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The List Shared Galleries operation response.

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

Variables:

value (list[SharedGallery]) – A list of shared galleries. Required.
next_link (str) – The uri to fetch the next page of shared galleries. Call ListNext() with this to fetch the next page of shared galleries.

Keyword Arguments:

value (list[SharedGallery]) – A list of shared galleries. Required.
next_link (str) – The uri to fetch the next page of shared galleries. Call ListNext() with this to fetch the next page of shared galleries.

class azure.mgmt.compute.v2022_01_03.models.SharedGalleryOSDiskImage(*, host_caching: str | _models.SharedGalleryHostCaching | None = None, **kwargs: Any)[source]¶

Bases: SharedGalleryDiskImage

This is the OS disk image.

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

Variables:

disk_size_gb (int) – This property indicates the size of the VHD to be created.
host_caching (str or SharedGalleryHostCaching) – The host caching of the disk. Valid values are ‘None’, ‘ReadOnly’, and ‘ReadWrite’. Known values are: “None”, “ReadOnly”, and “ReadWrite”.

Keyword Arguments:

host_caching (str or SharedGalleryHostCaching) – The host caching of the disk. Valid values are ‘None’, ‘ReadOnly’, and ‘ReadWrite’. Known values are: “None”, “ReadOnly”, and “ReadWrite”.

class azure.mgmt.compute.v2022_01_03.models.SharedToValues(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

SharedToValues.

TENANT = 'tenant'¶

class azure.mgmt.compute.v2022_01_03.models.SharingProfile(*, permissions: str | _models.GallerySharingPermissionTypes | None = None, community_gallery_info: _models.CommunityGalleryInfo | None = None, **kwargs: Any)[source]¶

Bases: Model

Profile for gallery sharing to subscription or tenant.

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

Variables:

permissions (str or GallerySharingPermissionTypes) – This property allows you to specify the permission of sharing gallery.   Possible values are:   Private   Groups   Community. Known values are: “Private”, “Groups”, and “Community”.
groups (list[SharingProfileGroup]) – A list of sharing profile groups.
community_gallery_info (CommunityGalleryInfo) – Information of community gallery if current gallery is shared to community.

Keyword Arguments:

permissions (str or GallerySharingPermissionTypes) – This property allows you to specify the permission of sharing gallery.   Possible values are:   Private   Groups   Community. Known values are: “Private”, “Groups”, and “Community”.
community_gallery_info (CommunityGalleryInfo) – Information of community gallery if current gallery is shared to community.

class azure.mgmt.compute.v2022_01_03.models.SharingProfileGroup(*, type: str | _models.SharingProfileGroupTypes | None = None, ids: List[str] | None = None, **kwargs: Any)[source]¶

Bases: Model

Group of the gallery sharing profile.

Variables:

type (str or SharingProfileGroupTypes) – This property allows you to specify the type of sharing group.   Possible values are:   Subscriptions   AADTenants. Known values are: “Subscriptions” and “AADTenants”.
ids (list[str]) – A list of subscription/tenant ids the gallery is aimed to be shared to.

Keyword Arguments:

type (str or SharingProfileGroupTypes) – This property allows you to specify the type of sharing group.   Possible values are:   Subscriptions   AADTenants. Known values are: “Subscriptions” and “AADTenants”.
ids (list[str]) – A list of subscription/tenant ids the gallery is aimed to be shared to.

class azure.mgmt.compute.v2022_01_03.models.SharingProfileGroupTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

This property allows you to specify the type of sharing group.   Possible values are:   Subscriptions   AADTenants.

AAD_TENANTS = 'AADTenants'¶

SUBSCRIPTIONS = 'Subscriptions'¶

class azure.mgmt.compute.v2022_01_03.models.SharingState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The sharing state of the gallery, which only appears in the response.

FAILED = 'Failed'¶

IN_PROGRESS = 'InProgress'¶

SUCCEEDED = 'Succeeded'¶

UNKNOWN = 'Unknown'¶

class azure.mgmt.compute.v2022_01_03.models.SharingStatus(*, summary: List[_models.RegionalSharingStatus] | None = None, **kwargs: Any)[source]¶

Bases: Model

Sharing status of current gallery.

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

Variables:

aggregated_state (str or SharingState) – Aggregated sharing state of current gallery. Known values are: “Succeeded”, “InProgress”, “Failed”, and “Unknown”.
summary (list[RegionalSharingStatus]) – Summary of all regional sharing status.

Keyword Arguments:

summary (list[RegionalSharingStatus]) – Summary of all regional sharing status.

class azure.mgmt.compute.v2022_01_03.models.SharingUpdate(*, operation_type: str | _models.SharingUpdateOperationTypes, groups: List[_models.SharingProfileGroup] | None = None, **kwargs: Any)[source]¶

Bases: Model

Specifies information about the gallery sharing profile update.

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

Variables:

operation_type (str or SharingUpdateOperationTypes) – This property allows you to specify the operation type of gallery sharing update.   Possible values are:   Add   Remove   Reset. Required. Known values are: “Add”, “Remove”, “Reset”, and “EnableCommunity”.
groups (list[SharingProfileGroup]) – A list of sharing profile groups.

Keyword Arguments:

operation_type (str or SharingUpdateOperationTypes) – This property allows you to specify the operation type of gallery sharing update.   Possible values are:   Add   Remove   Reset. Required. Known values are: “Add”, “Remove”, “Reset”, and “EnableCommunity”.
groups (list[SharingProfileGroup]) – A list of sharing profile groups.

class azure.mgmt.compute.v2022_01_03.models.SharingUpdateOperationTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

This property allows you to specify the operation type of gallery sharing update.   Possible values are:   Add   Remove   Reset.

ADD = 'Add'¶

ENABLE_COMMUNITY = 'EnableCommunity'¶

REMOVE = 'Remove'¶

RESET = 'Reset'¶

class azure.mgmt.compute.v2022_01_03.models.SoftDeletePolicy(*, is_soft_delete_enabled: bool | None = None, **kwargs: Any)[source]¶

Bases: Model

Contains information about the soft deletion policy of the gallery.

Variables:: is_soft_delete_enabled (bool) – Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time.
Keyword Arguments:: is_soft_delete_enabled (bool) – Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time.

class azure.mgmt.compute.v2022_01_03.models.StorageAccountType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Specifies the storage account type to be used to store the image. This property is not updatable.

PREMIUM_LRS = 'Premium_LRS'¶

STANDARD_LRS = 'Standard_LRS'¶

STANDARD_SSD_LRS = 'StandardSSD_LRS'¶

STANDARD_ZRS = 'Standard_ZRS'¶

class azure.mgmt.compute.v2022_01_03.models.SubResource(*, id: str | None = None, **kwargs: Any)[source]¶

Bases: Model

SubResource.

Variables:: id (str) – Resource Id.
Keyword Arguments:: id (str) – Resource Id.

class azure.mgmt.compute.v2022_01_03.models.SubResourceReadOnly(**kwargs: Any)[source]¶

Bases: Model

SubResourceReadOnly.

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

Variables:: id (str) – Resource Id.

class azure.mgmt.compute.v2022_01_03.models.TargetRegion(*, name: str, regional_replica_count: int | None = None, storage_account_type: str | _models.StorageAccountType | None = None, encryption: _models.EncryptionImages | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes the target region information.

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

Variables:

name (str) – The name of the region. Required.
regional_replica_count (int) – The number of replicas of the Image Version to be created per region. This property is updatable.
storage_account_type (str or StorageAccountType) – Specifies the storage account type to be used to store the image. This property is not updatable. Known values are: “Standard_LRS”, “Standard_ZRS”, “Premium_LRS”, and “StandardSSD_LRS”.
encryption (EncryptionImages) – Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact.

Keyword Arguments:

name (str) – The name of the region. Required.
regional_replica_count (int) – The number of replicas of the Image Version to be created per region. This property is updatable.
storage_account_type (str or StorageAccountType) – Specifies the storage account type to be used to store the image. This property is not updatable. Known values are: “Standard_LRS”, “Standard_ZRS”, “Premium_LRS”, and “StandardSSD_LRS”.
encryption (EncryptionImages) – Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact.

class azure.mgmt.compute.v2022_01_03.models.UpdateResourceDefinition(*, tags: Dict[str, str] | None = None, **kwargs: Any)[source]¶

Bases: Model

The Update Resource model definition.

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

Variables:

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
tags (dict[str, str]) – Resource tags.

Keyword Arguments:

tags (dict[str, str]) – Resource tags.

class azure.mgmt.compute.v2022_01_03.models.UserArtifactManage(*, install: str, remove: str, update: str | None = None, **kwargs: Any)[source]¶

Bases: Model

UserArtifactManage.

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

Variables:

install (str) – Required. The path and arguments to install the gallery application. This is limited to 4096 characters. Required.
remove (str) – Required. The path and arguments to remove the gallery application. This is limited to 4096 characters. Required.
update (str) – Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters.

Keyword Arguments:

install (str) – Required. The path and arguments to install the gallery application. This is limited to 4096 characters. Required.
remove (str) – Required. The path and arguments to remove the gallery application. This is limited to 4096 characters. Required.
update (str) – Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters.

class azure.mgmt.compute.v2022_01_03.models.UserArtifactSettings(*, package_file_name: str | None = None, config_file_name: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Additional settings for the VM app that contains the target package and config file name when it is deployed to target VM or VM scale set.

Variables:

package_file_name (str) – Optional. The name to assign the downloaded package file on the VM. This is limited to 4096 characters. If not specified, the package file will be named the same as the Gallery Application name.
config_file_name (str) – Optional. The name to assign the downloaded config file on the VM. This is limited to 4096 characters. If not specified, the config file will be named the Gallery Application name appended with “_config”.

Keyword Arguments:

package_file_name (str) – Optional. The name to assign the downloaded package file on the VM. This is limited to 4096 characters. If not specified, the package file will be named the same as the Gallery Application name.
config_file_name (str) – Optional. The name to assign the downloaded config file on the VM. This is limited to 4096 characters. If not specified, the config file will be named the Gallery Application name appended with “_config”.

class azure.mgmt.compute.v2022_01_03.models.UserArtifactSource(*, media_link: str, default_configuration_link: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The source image from which the Image Version is going to be created.

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

Variables:

media_link (str) – Required. The mediaLink of the artifact, must be a readable storage page blob. Required.
default_configuration_link (str) – Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob.

Keyword Arguments:

media_link (str) – Required. The mediaLink of the artifact, must be a readable storage page blob. Required.
default_configuration_link (str) – Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob.

class azure.mgmt.compute.v2022_01_03.models.UserAssignedIdentitiesValue(**kwargs: Any)[source]¶

Bases: Model

UserAssignedIdentitiesValue.

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

Variables:

principal_id (str) – The principal id of user assigned identity.
client_id (str) – The client id of user assigned identity.