azure.mgmt.compute.v2024_03_02.models module¶

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

Bases: str, Enum

AccessLevel.

NONE = 'None'¶

READ = 'Read'¶

WRITE = 'Write'¶

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

Bases: Model

A disk access SAS uri.

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

Variables:

access_sas (str) – A SAS uri for accessing a disk.
security_data_access_sas (str) – A SAS uri for accessing a VM guest state.

class azure.mgmt.compute.v2024_03_02.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.v2024_03_02.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.v2024_03_02.models.Architecture(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

CPU architecture supported by an OS disk.

ARM64 = 'Arm64'¶

X64 = 'x64'¶

class azure.mgmt.compute.v2024_03_02.models.CopyCompletionError(*, error_code: str | _models.CopyCompletionErrorReason, error_message: str, **kwargs: Any)[source]¶

Bases: Model

Indicates the error details if the background copy of a resource created via the CopyStart operation fails.

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

Variables:

error_code (str or CopyCompletionErrorReason) – Indicates the error code if the background copy of a resource created via the CopyStart operation fails. Required. “CopySourceNotFound”
error_message (str) – Indicates the error message if the background copy of a resource created via the CopyStart operation fails. Required.

Keyword Arguments:

error_code (str or CopyCompletionErrorReason) – Indicates the error code if the background copy of a resource created via the CopyStart operation fails. Required. “CopySourceNotFound”
error_message (str) – Indicates the error message if the background copy of a resource created via the CopyStart operation fails. Required.

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

Bases: str, Enum

Indicates the error code if the background copy of a resource created via the CopyStart operation fails.

COPY_SOURCE_NOT_FOUND = 'CopySourceNotFound'¶: Indicates that the source snapshot was deleted while the background copy of the resource created via CopyStart operation was in progress.

class azure.mgmt.compute.v2024_03_02.models.CreationData(*, create_option: str | _models.DiskCreateOption, storage_account_id: str | None = None, image_reference: _models.ImageDiskReference | None = None, gallery_image_reference: _models.ImageDiskReference | None = None, source_uri: str | None = None, source_resource_id: str | None = None, upload_size_bytes: int | None = None, logical_sector_size: int | None = None, security_data_uri: str | None = None, performance_plus: bool | None = None, elastic_san_resource_id: str | None = None, provisioned_bandwidth_copy_speed: str | _models.ProvisionedBandwidthCopyOption | None = None, **kwargs: Any)[source]¶

Bases: Model

Data used when creating a disk.

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:

create_option (str or DiskCreateOption) – This enumerates the possible sources of a disk’s creation. Required. Known values are: “Empty”, “Attach”, “FromImage”, “Import”, “Copy”, “Restore”, “Upload”, “CopyStart”, “ImportSecure”, “UploadPreparedSecure”, “CopyFromSanSnapshot”, and “Import”.
storage_account_id (str) – Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk.
image_reference (ImageDiskReference) – Disk source information for PIR or user images.
gallery_image_reference (ImageDiskReference) – Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk.
source_uri (str) – If createOption is Import, this is the URI of a blob to be imported into a managed disk.
source_resource_id (str) – If createOption is Copy, this is the ARM id of the source snapshot or disk.
source_unique_id (str) – If this field is set, this is the unique id identifying the source of this resource.
upload_size_bytes (int) – If createOption is Upload, this is the size of the contents of the upload including the VHD footer. This value should be between 20972032 (20 MiB + 512 bytes for the VHD footer) and 35183298347520 bytes (32 TiB + 512 bytes for the VHD footer).
logical_sector_size (int) – Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default.
security_data_uri (str) – If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state.
performance_plus (bool) – Set this flag to true to get a boost on the performance target of the disk deployed, see here on the respective performance target. This flag can only be set on disk creation time and cannot be disabled after enabled.
elastic_san_resource_id (str) – Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot.
provisioned_bandwidth_copy_speed (str or ProvisionedBandwidthCopyOption) – If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed. Known values are: “None” and “Enhanced”.

Keyword Arguments:

create_option (str or DiskCreateOption) – This enumerates the possible sources of a disk’s creation. Required. Known values are: “Empty”, “Attach”, “FromImage”, “Import”, “Copy”, “Restore”, “Upload”, “CopyStart”, “ImportSecure”, “UploadPreparedSecure”, “CopyFromSanSnapshot”, and “Import”.
storage_account_id (str) – Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk.
image_reference (ImageDiskReference) – Disk source information for PIR or user images.
gallery_image_reference (ImageDiskReference) – Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk.
source_uri (str) – If createOption is Import, this is the URI of a blob to be imported into a managed disk.
source_resource_id (str) – If createOption is Copy, this is the ARM id of the source snapshot or disk.
upload_size_bytes (int) – If createOption is Upload, this is the size of the contents of the upload including the VHD footer. This value should be between 20972032 (20 MiB + 512 bytes for the VHD footer) and 35183298347520 bytes (32 TiB + 512 bytes for the VHD footer).
logical_sector_size (int) – Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default.
security_data_uri (str) – If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state.
performance_plus (bool) – Set this flag to true to get a boost on the performance target of the disk deployed, see here on the respective performance target. This flag can only be set on disk creation time and cannot be disabled after enabled.
elastic_san_resource_id (str) – Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot.
provisioned_bandwidth_copy_speed (str or ProvisionedBandwidthCopyOption) – If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed. Known values are: “None” and “Enhanced”.

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

Bases: str, Enum

Additional authentication requirements when exporting or uploading to a disk or snapshot.

AZURE_ACTIVE_DIRECTORY = 'AzureActiveDirectory'¶: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth.

NONE = 'None'¶: No additional authentication would be performed when accessing export/upload URL.

class azure.mgmt.compute.v2024_03_02.models.Disk(*, location: str, tags: Dict[str, str] | None = None, sku: _models.DiskSku | None = None, zones: List[str] | None = None, extended_location: _models.ExtendedLocation | None = None, os_type: str | _models.OperatingSystemTypes | None = None, hyper_v_generation: str | _models.HyperVGeneration | None = None, purchase_plan: _models.PurchasePlan | None = None, supported_capabilities: _models.SupportedCapabilities | None = None, creation_data: _models.CreationData | None = None, disk_size_gb: int | None = None, encryption_settings_collection: _models.EncryptionSettingsCollection | None = None, disk_iops_read_write: int | None = None, disk_m_bps_read_write: int | None = None, disk_iops_read_only: int | None = None, disk_m_bps_read_only: int | None = None, encryption: _models.Encryption | None = None, max_shares: int | None = None, network_access_policy: str | _models.NetworkAccessPolicy | None = None, disk_access_id: str | None = None, tier: str | None = None, bursting_enabled: bool | None = None, supports_hibernation: bool | None = None, security_profile: _models.DiskSecurityProfile | None = None, completion_percent: float | None = None, public_network_access: str | _models.PublicNetworkAccess | None = None, data_access_auth_mode: str | _models.DataAccessAuthMode | None = None, optimized_for_frequent_attach: bool | None = None, **kwargs: Any)[source]¶

Bases: Resource

Disk resource.

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.
managed_by (str) – A relative URI containing the ID of the VM that has the disk attached.
managed_by_extended (list[str]) – List of relative URIs containing the IDs of the VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs.
sku (DiskSku) – The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS.
zones (list[str]) – The Logical zone list for Disk.
extended_location (ExtendedLocation) – The extended location where the disk will be created. Extended location cannot be changed.
time_created (datetime) – The time when the disk was created.
os_type (str or OperatingSystemTypes) – The Operating System type. Known values are: “Windows” and “Linux”.
hyper_v_generation (str or HyperVGeneration) – The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Known values are: “V1” and “V2”.
purchase_plan (PurchasePlan) – Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer}.
supported_capabilities (SupportedCapabilities) – List of supported capabilities for the image from which the OS disk was created.
creation_data (CreationData) – Disk source information. CreationData information cannot be changed after the disk has been created.
disk_size_gb (int) – If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk’s size.
disk_size_bytes (int) – The size of the disk in bytes. This field is read only.
unique_id (str) – Unique Guid identifying the resource.
encryption_settings_collection (EncryptionSettingsCollection) – Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
provisioning_state (str) – The disk provisioning state.
disk_iops_read_write (int) – The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes.
disk_m_bps_read_write (int) – The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.
disk_iops_read_only (int) – The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes.
disk_m_bps_read_only (int) – The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.
disk_state (str or DiskState) – The state of the disk. Known values are: “Unattached”, “Attached”, “Reserved”, “Frozen”, “ActiveSAS”, “ActiveSASFrozen”, “ReadyToUpload”, and “ActiveUpload”.
encryption (Encryption) – Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
max_shares (int) – The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time.
share_info (list[ShareInfoElement]) – Details of the list of all VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs.
network_access_policy (str or NetworkAccessPolicy) – Policy for accessing the disk via network. Known values are: “AllowAll”, “AllowPrivate”, and “DenyAll”.
disk_access_id (str) – ARM id of the DiskAccess resource for using private endpoints on disks.
bursting_enabled_time (datetime) – Latest time when bursting was last enabled on a disk.
tier (str) – Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks.
bursting_enabled (bool) – Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks.
property_updates_in_progress (PropertyUpdatesInProgress) – Properties of the disk for which update is pending.
supports_hibernation (bool) – Indicates the OS on a disk supports hibernation.
security_profile (DiskSecurityProfile) – Contains the security related information for the resource.
completion_percent (float) – Percentage complete for the background copy when a resource is created via the CopyStart operation.
public_network_access (str or PublicNetworkAccess) – Policy for controlling export on the disk. Known values are: “Enabled” and “Disabled”.
data_access_auth_mode (str or DataAccessAuthMode) – Additional authentication requirements when exporting or uploading to a disk or snapshot. Known values are: “AzureActiveDirectory” and “None”.
optimized_for_frequent_attach (bool) – Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine.
last_ownership_update_time (datetime) – The UTC time when the ownership state of the disk was last changed i.e., the time the disk was last attached or detached from a VM or the time when the VM to which the disk was attached was deallocated or started.

Keyword Arguments:

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
sku (DiskSku) – The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS.
zones (list[str]) – The Logical zone list for Disk.
extended_location (ExtendedLocation) – The extended location where the disk will be created. Extended location cannot be changed.
os_type (str or OperatingSystemTypes) – The Operating System type. Known values are: “Windows” and “Linux”.
hyper_v_generation (str or HyperVGeneration) – The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Known values are: “V1” and “V2”.
purchase_plan (PurchasePlan) – Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer}.
supported_capabilities (SupportedCapabilities) – List of supported capabilities for the image from which the OS disk was created.
creation_data (CreationData) – Disk source information. CreationData information cannot be changed after the disk has been created.
disk_size_gb (int) – If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk’s size.
encryption_settings_collection (EncryptionSettingsCollection) – Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
disk_iops_read_write (int) – The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes.
disk_m_bps_read_write (int) – The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.
disk_iops_read_only (int) – The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes.
disk_m_bps_read_only (int) – The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.
encryption (Encryption) – Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
max_shares (int) – The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time.
network_access_policy (str or NetworkAccessPolicy) – Policy for accessing the disk via network. Known values are: “AllowAll”, “AllowPrivate”, and “DenyAll”.
disk_access_id (str) – ARM id of the DiskAccess resource for using private endpoints on disks.
tier (str) – Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks.
bursting_enabled (bool) – Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks.
supports_hibernation (bool) – Indicates the OS on a disk supports hibernation.
security_profile (DiskSecurityProfile) – Contains the security related information for the resource.
completion_percent (float) – Percentage complete for the background copy when a resource is created via the CopyStart operation.
public_network_access (str or PublicNetworkAccess) – Policy for controlling export on the disk. Known values are: “Enabled” and “Disabled”.
data_access_auth_mode (str or DataAccessAuthMode) – Additional authentication requirements when exporting or uploading to a disk or snapshot. Known values are: “AzureActiveDirectory” and “None”.
optimized_for_frequent_attach (bool) – Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine.

class azure.mgmt.compute.v2024_03_02.models.DiskAccess(*, location: str, tags: Dict[str, str] | None = None, extended_location: _models.ExtendedLocation | None = None, **kwargs: Any)[source]¶

Bases: Resource

disk access resource.

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.
extended_location (ExtendedLocation) – The extended location where the disk access will be created. Extended location cannot be changed.
private_endpoint_connections (list[PrivateEndpointConnection]) – A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported.
provisioning_state (str) – The disk access resource provisioning state.
time_created (datetime) – The time when the disk access was created.

Keyword Arguments:

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
extended_location (ExtendedLocation) – The extended location where the disk access will be created. Extended location cannot be changed.

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

Bases: Model

The List disk access operation response.

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

Variables:

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

Keyword Arguments:

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

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

Bases: Model

Used for updating a disk access resource.

Variables:: tags (dict[str, str]) – Resource tags.
Keyword Arguments:: tags (dict[str, str]) – Resource tags.

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

Bases: str, Enum

This enumerates the possible sources of a disk’s creation.

ATTACH = 'Attach'¶: Disk will be attached to a VM.

COPY = 'Copy'¶: Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId.

COPY_FROM_SAN_SNAPSHOT = 'CopyFromSanSnapshot'¶: Create a new disk by exporting from elastic san volume snapshot

COPY_START = 'CopyStart'¶: Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source.

EMPTY = 'Empty'¶: Create an empty data disk of a size given by diskSizeGB.

FROM_IMAGE = 'FromImage'¶: Create a new disk from a platform image specified by the given imageReference or galleryImageReference.

IMPORT = 'Import'¶: Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId.

IMPORT_ENUM = 'Import'¶: Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId.

IMPORT_SECURE = 'ImportSecure'¶: Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blob for VM guest state specified by securityDataUri in storage account specified by storageAccountId

RESTORE = 'Restore'¶: Create a new disk by copying from a backup recovery point.

UPLOAD = 'Upload'¶: Create a new disk by obtaining a write token and using it to directly upload the contents of the disk.

UPLOAD_PREPARED_SECURE = 'UploadPreparedSecure'¶: Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in both disk and VM guest state

class azure.mgmt.compute.v2024_03_02.models.DiskEncryptionSet(*, location: str, tags: Dict[str, str] | None = None, identity: _models.EncryptionSetIdentity | None = None, encryption_type: str | _models.DiskEncryptionSetType | None = None, active_key: _models.KeyForDiskEncryptionSet | None = None, rotation_to_latest_key_version_enabled: bool | None = None, federated_client_id: str | None = None, **kwargs: Any)[source]¶

Bases: Resource

disk encryption set resource.

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.
identity (EncryptionSetIdentity) – The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks.
encryption_type (str or DiskEncryptionSetType) – The type of key used to encrypt the data of the disk. Known values are: “EncryptionAtRestWithCustomerKey”, “EncryptionAtRestWithPlatformAndCustomerKeys”, and “ConfidentialVmEncryptedWithCustomerKey”.
active_key (KeyForDiskEncryptionSet) – The key vault key which is currently used by this disk encryption set.
previous_keys (list[KeyForDiskEncryptionSet]) – A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation.
provisioning_state (str) – The disk encryption set provisioning state.
rotation_to_latest_key_version_enabled (bool) – Set this flag to true to enable auto-updating of this disk encryption set to the latest key version.
last_key_rotation_timestamp (datetime) – The time when the active key of this disk encryption set was updated.
auto_key_rotation_error (ApiError) – The error that was encountered during auto-key rotation. If an error is present, then auto-key rotation will not be attempted until the error on this disk encryption set is fixed.
federated_client_id (str) – Multi-tenant application client id to access key vault in a different tenant. Setting the value to ‘None’ will clear the property.

Keyword Arguments:

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
identity (EncryptionSetIdentity) – The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks.
encryption_type (str or DiskEncryptionSetType) – The type of key used to encrypt the data of the disk. Known values are: “EncryptionAtRestWithCustomerKey”, “EncryptionAtRestWithPlatformAndCustomerKeys”, and “ConfidentialVmEncryptedWithCustomerKey”.
active_key (KeyForDiskEncryptionSet) – The key vault key which is currently used by this disk encryption set.
rotation_to_latest_key_version_enabled (bool) – Set this flag to true to enable auto-updating of this disk encryption set to the latest key version.
federated_client_id (str) – Multi-tenant application client id to access key vault in a different tenant. Setting the value to ‘None’ will clear the property.

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

Bases: str, Enum

The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys.

NONE = 'None'¶

SYSTEM_ASSIGNED = 'SystemAssigned'¶

SYSTEM_ASSIGNED_USER_ASSIGNED = 'SystemAssigned, UserAssigned'¶

USER_ASSIGNED = 'UserAssigned'¶

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

Bases: Model

The List disk encryption set operation response.

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

Variables:

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

Keyword Arguments:

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

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

Bases: str, Enum

The type of key used to encrypt the data of the disk.

CONFIDENTIAL_VM_ENCRYPTED_WITH_CUSTOMER_KEY = 'ConfidentialVmEncryptedWithCustomerKey'¶: Confidential VM supported disk and VM guest state would be encrypted with customer managed key.

ENCRYPTION_AT_REST_WITH_CUSTOMER_KEY = 'EncryptionAtRestWithCustomerKey'¶: Resource using diskEncryptionSet would be encrypted at rest with Customer managed key that can be changed and revoked by a customer.

ENCRYPTION_AT_REST_WITH_PLATFORM_AND_CUSTOMER_KEYS = 'EncryptionAtRestWithPlatformAndCustomerKeys'¶: Resource using diskEncryptionSet would be encrypted at rest with two layers of encryption. One of the keys is Customer managed and the other key is Platform managed.

class azure.mgmt.compute.v2024_03_02.models.DiskEncryptionSetUpdate(*, tags: Dict[str, str] | None = None, identity: _models.EncryptionSetIdentity | None = None, encryption_type: str | _models.DiskEncryptionSetType | None = None, active_key: _models.KeyForDiskEncryptionSet | None = None, rotation_to_latest_key_version_enabled: bool | None = None, federated_client_id: str | None = None, **kwargs: Any)[source]¶

Bases: Model

disk encryption set update resource.

Variables:

tags (dict[str, str]) – Resource tags.
identity (EncryptionSetIdentity) – The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks.
encryption_type (str or DiskEncryptionSetType) – The type of key used to encrypt the data of the disk. Known values are: “EncryptionAtRestWithCustomerKey”, “EncryptionAtRestWithPlatformAndCustomerKeys”, and “ConfidentialVmEncryptedWithCustomerKey”.
active_key (KeyForDiskEncryptionSet) – Key Vault Key Url to be used for server side encryption of Managed Disks and Snapshots.
rotation_to_latest_key_version_enabled (bool) – Set this flag to true to enable auto-updating of this disk encryption set to the latest key version.
federated_client_id (str) – Multi-tenant application client id to access key vault in a different tenant. Setting the value to ‘None’ will clear the property.

Keyword Arguments:

tags (dict[str, str]) – Resource tags.
identity (EncryptionSetIdentity) – The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks.
encryption_type (str or DiskEncryptionSetType) – The type of key used to encrypt the data of the disk. Known values are: “EncryptionAtRestWithCustomerKey”, “EncryptionAtRestWithPlatformAndCustomerKeys”, and “ConfidentialVmEncryptedWithCustomerKey”.
active_key (KeyForDiskEncryptionSet) – Key Vault Key Url to be used for server side encryption of Managed Disks and Snapshots.
rotation_to_latest_key_version_enabled (bool) – Set this flag to true to enable auto-updating of this disk encryption set to the latest key version.
federated_client_id (str) – Multi-tenant application client id to access key vault in a different tenant. Setting the value to ‘None’ will clear the property.

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

Bases: Model

The List Disks operation response.

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

Variables:

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

Keyword Arguments:

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

class azure.mgmt.compute.v2024_03_02.models.DiskRestorePoint(*, hyper_v_generation: str | _models.HyperVGeneration | None = None, purchase_plan: _models.PurchasePlan | None = None, supported_capabilities: _models.SupportedCapabilities | None = None, supports_hibernation: bool | None = None, network_access_policy: str | _models.NetworkAccessPolicy | None = None, public_network_access: str | _models.PublicNetworkAccess | None = None, disk_access_id: str | None = None, completion_percent: float | None = None, security_profile: _models.DiskSecurityProfile | None = None, **kwargs: Any)[source]¶

Bases: ProxyOnlyResource

Properties of disk restore point.

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.
time_created (datetime) – The timestamp of restorePoint creation.
source_resource_id (str) – arm id of source disk or source disk restore point.
os_type (str or OperatingSystemTypes) – The Operating System type. Known values are: “Windows” and “Linux”.
hyper_v_generation (str or HyperVGeneration) – The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Known values are: “V1” and “V2”.
purchase_plan (PurchasePlan) – Purchase plan information for the the image from which the OS disk was created.
supported_capabilities (SupportedCapabilities) – List of supported capabilities for the image from which the OS disk was created.
family_id (str) – id of the backing snapshot’s MIS family.
source_unique_id (str) – unique incarnation id of the source disk.
encryption (Encryption) – Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
supports_hibernation (bool) – Indicates the OS on a disk supports hibernation.
network_access_policy (str or NetworkAccessPolicy) – Policy for accessing the disk via network. Known values are: “AllowAll”, “AllowPrivate”, and “DenyAll”.
public_network_access (str or PublicNetworkAccess) – Policy for controlling export on the disk. Known values are: “Enabled” and “Disabled”.
disk_access_id (str) – ARM id of the DiskAccess resource for using private endpoints on disks.
completion_percent (float) – Percentage complete for the background copy of disk restore point when source resource is from a different region.
replication_state (str) – Replication state of disk restore point when source resource is from a different region.
source_resource_location (str) – Location of source disk or source disk restore point when source resource is from a different region.
security_profile (DiskSecurityProfile) – Contains the security related information for the resource.
logical_sector_size (int) – Logical sector size in bytes for disk restore points of UltraSSD_LRS and PremiumV2_LRS disks. Supported values are 512 and 4096. 4096 is the default.

Keyword Arguments:

hyper_v_generation (str or HyperVGeneration) – The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Known values are: “V1” and “V2”.
purchase_plan (PurchasePlan) – Purchase plan information for the the image from which the OS disk was created.
supported_capabilities (SupportedCapabilities) – List of supported capabilities for the image from which the OS disk was created.
supports_hibernation (bool) – Indicates the OS on a disk supports hibernation.
network_access_policy (str or NetworkAccessPolicy) – Policy for accessing the disk via network. Known values are: “AllowAll”, “AllowPrivate”, and “DenyAll”.
public_network_access (str or PublicNetworkAccess) – Policy for controlling export on the disk. Known values are: “Enabled” and “Disabled”.
disk_access_id (str) – ARM id of the DiskAccess resource for using private endpoints on disks.
completion_percent (float) – Percentage complete for the background copy of disk restore point when source resource is from a different region.
security_profile (DiskSecurityProfile) – Contains the security related information for the resource.

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

Bases: Model

The List Disk Restore Points operation response.

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

Variables:

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

Keyword Arguments:

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

class azure.mgmt.compute.v2024_03_02.models.DiskSecurityProfile(*, security_type: str | _models.DiskSecurityTypes | None = None, secure_vm_disk_encryption_set_id: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Contains the security related information for the resource.

Variables:

security_type (str or DiskSecurityTypes) – Specifies the SecurityType of the VM. Applicable for OS disks only. Known values are: “TrustedLaunch”, “ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey”, “ConfidentialVM_DiskEncryptedWithPlatformKey”, “ConfidentialVM_DiskEncryptedWithCustomerKey”, and “ConfidentialVM_NonPersistedTPM”.
secure_vm_disk_encryption_set_id (str) – ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key.

Keyword Arguments:

security_type (str or DiskSecurityTypes) – Specifies the SecurityType of the VM. Applicable for OS disks only. Known values are: “TrustedLaunch”, “ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey”, “ConfidentialVM_DiskEncryptedWithPlatformKey”, “ConfidentialVM_DiskEncryptedWithCustomerKey”, and “ConfidentialVM_NonPersistedTPM”.
secure_vm_disk_encryption_set_id (str) – ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key.

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

Bases: str, Enum

Specifies the SecurityType of the VM. Applicable for OS disks only.

CONFIDENTIAL_VM_DISK_ENCRYPTED_WITH_CUSTOMER_KEY = 'ConfidentialVM_DiskEncryptedWithCustomerKey'¶: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key

CONFIDENTIAL_VM_DISK_ENCRYPTED_WITH_PLATFORM_KEY = 'ConfidentialVM_DiskEncryptedWithPlatformKey'¶: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key

CONFIDENTIAL_VM_NON_PERSISTED_TPM = 'ConfidentialVM_NonPersistedTPM'¶: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots.

CONFIDENTIAL_VM_VMGUEST_STATE_ONLY_ENCRYPTED_WITH_PLATFORM_KEY = 'ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey'¶: Indicates Confidential VM disk with only VM guest state encrypted

TRUSTED_LAUNCH = 'TrustedLaunch'¶: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM)

class azure.mgmt.compute.v2024_03_02.models.DiskSku(*, name: str | _models.DiskStorageAccountTypes | None = None, **kwargs: Any)[source]¶

Bases: Model

The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS.

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

Variables:

name (str or DiskStorageAccountTypes) – The sku name. Known values are: “Standard_LRS”, “Premium_LRS”, “StandardSSD_LRS”, “UltraSSD_LRS”, “Premium_ZRS”, “StandardSSD_ZRS”, and “PremiumV2_LRS”.
tier (str) – The sku tier.

Keyword Arguments:

name (str or DiskStorageAccountTypes) – The sku name. Known values are: “Standard_LRS”, “Premium_LRS”, “StandardSSD_LRS”, “UltraSSD_LRS”, “Premium_ZRS”, “StandardSSD_ZRS”, and “PremiumV2_LRS”.

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

Bases: str, Enum

This enumerates the possible state of the disk.

ACTIVE_SAS = 'ActiveSAS'¶: The disk currently has an Active SAS Uri associated with it.

ACTIVE_SAS_FROZEN = 'ActiveSASFrozen'¶: The disk is attached to a VM in hibernated state and has an active SAS URI associated with it.

ACTIVE_UPLOAD = 'ActiveUpload'¶: A disk is created for upload and a write token has been issued for uploading to it.

ATTACHED = 'Attached'¶: The disk is currently attached to a running VM.

FROZEN = 'Frozen'¶: The disk is attached to a VM which is in hibernated state.

READY_TO_UPLOAD = 'ReadyToUpload'¶: A disk is ready to be created by upload by requesting a write token.

RESERVED = 'Reserved'¶: The disk is attached to a stopped-deallocated VM.

UNATTACHED = 'Unattached'¶: The disk is not being used and can be attached to a VM.

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

Bases: str, Enum

The sku name.

PREMIUM_LRS = 'Premium_LRS'¶: Premium SSD locally redundant storage. Best for production and performance sensitive workloads.

PREMIUM_V2_LRS = 'PremiumV2_LRS'¶: Premium SSD v2 locally redundant storage. Best for production and performance-sensitive workloads that consistently require low latency and high IOPS and throughput.

PREMIUM_ZRS = 'Premium_ZRS'¶: Premium SSD zone redundant storage. Best for the production workloads that need storage resiliency against zone failures.

STANDARD_LRS = 'Standard_LRS'¶: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access.

STANDARD_SSD_LRS = 'StandardSSD_LRS'¶: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test.

STANDARD_SSD_ZRS = 'StandardSSD_ZRS'¶: Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev/test that need storage resiliency against zone failures.

ULTRA_SSD_LRS = 'UltraSSD_LRS'¶: Ultra SSD locally redundant storage. Best for IO-intensive workloads such as SAP HANA, top tier databases (for example, SQL, Oracle), and other transaction-heavy workloads.

Bases: Model

Disk update resource.

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

Variables:

tags (dict[str, str]) – Resource tags.
sku (DiskSku) – The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS.
os_type (str or OperatingSystemTypes) – the Operating System type. Known values are: “Windows” and “Linux”.
disk_size_gb (int) – If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk’s size.
encryption_settings_collection (EncryptionSettingsCollection) – Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
disk_iops_read_write (int) – The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes.
disk_m_bps_read_write (int) – The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.
disk_iops_read_only (int) – The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes.
disk_m_bps_read_only (int) – The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.
max_shares (int) – The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time.
encryption (Encryption) – Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
network_access_policy (str or NetworkAccessPolicy) – Policy for accessing the disk via network. Known values are: “AllowAll”, “AllowPrivate”, and “DenyAll”.
disk_access_id (str) – ARM id of the DiskAccess resource for using private endpoints on disks.
tier (str) – Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks.
bursting_enabled (bool) – Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks.
purchase_plan (PurchasePlan) – Purchase plan information to be added on the OS disk.
supported_capabilities (SupportedCapabilities) – List of supported capabilities to be added on the OS disk.
property_updates_in_progress (PropertyUpdatesInProgress) – Properties of the disk for which update is pending.
supports_hibernation (bool) – Indicates the OS on a disk supports hibernation.
public_network_access (str or PublicNetworkAccess) – Policy for controlling export on the disk. Known values are: “Enabled” and “Disabled”.
data_access_auth_mode (str or DataAccessAuthMode) – Additional authentication requirements when exporting or uploading to a disk or snapshot. Known values are: “AzureActiveDirectory” and “None”.
optimized_for_frequent_attach (bool) – Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine.

Keyword Arguments:

tags (dict[str, str]) – Resource tags.
sku (DiskSku) – The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS.
os_type (str or OperatingSystemTypes) – the Operating System type. Known values are: “Windows” and “Linux”.
disk_size_gb (int) – If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk’s size.
encryption_settings_collection (EncryptionSettingsCollection) – Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
disk_iops_read_write (int) – The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes.
disk_m_bps_read_write (int) – The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.
disk_iops_read_only (int) – The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes.
disk_m_bps_read_only (int) – The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.
max_shares (int) – The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time.
encryption (Encryption) – Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
network_access_policy (str or NetworkAccessPolicy) – Policy for accessing the disk via network. Known values are: “AllowAll”, “AllowPrivate”, and “DenyAll”.
disk_access_id (str) – ARM id of the DiskAccess resource for using private endpoints on disks.
tier (str) – Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks.
bursting_enabled (bool) – Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks.
purchase_plan (PurchasePlan) – Purchase plan information to be added on the OS disk.
supported_capabilities (SupportedCapabilities) – List of supported capabilities to be added on the OS disk.
supports_hibernation (bool) – Indicates the OS on a disk supports hibernation.
public_network_access (str or PublicNetworkAccess) – Policy for controlling export on the disk. Known values are: “Enabled” and “Disabled”.
data_access_auth_mode (str or DataAccessAuthMode) – Additional authentication requirements when exporting or uploading to a disk or snapshot. Known values are: “AzureActiveDirectory” and “None”.
optimized_for_frequent_attach (bool) – Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine.

class azure.mgmt.compute.v2024_03_02.models.Encryption(*, disk_encryption_set_id: str | None = None, type: str | _models.EncryptionType | None = None, **kwargs: Any)[source]¶

Bases: Model

Encryption at rest settings for disk or snapshot.

Variables:

disk_encryption_set_id (str) – ResourceId of the disk encryption set to use for enabling encryption at rest.
type (str or EncryptionType) – The type of key used to encrypt the data of the disk. Known values are: “EncryptionAtRestWithPlatformKey”, “EncryptionAtRestWithCustomerKey”, and “EncryptionAtRestWithPlatformAndCustomerKeys”.

Keyword Arguments:

disk_encryption_set_id (str) – ResourceId of the disk encryption set to use for enabling encryption at rest.
type (str or EncryptionType) – The type of key used to encrypt the data of the disk. Known values are: “EncryptionAtRestWithPlatformKey”, “EncryptionAtRestWithCustomerKey”, and “EncryptionAtRestWithPlatformAndCustomerKeys”.

class azure.mgmt.compute.v2024_03_02.models.EncryptionSetIdentity(*, type: str | _models.DiskEncryptionSetIdentityType | None = None, user_assigned_identities: Dict[str, _models.UserAssignedIdentitiesValue] | None = None, **kwargs: Any)[source]¶

Bases: Model

The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks.

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

Variables:

type (str or DiskEncryptionSetIdentityType) – The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys. Known values are: “SystemAssigned”, “UserAssigned”, “SystemAssigned, UserAssigned”, and “None”.
principal_id (str) – The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity.
tenant_id (str) – The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity.
user_assigned_identities (dict[str, UserAssignedIdentitiesValue]) – The list of user identities associated with the disk encryption set. The user identity dictionary key references will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’. # pylint: disable=line-too-long

Keyword Arguments:

type (str or DiskEncryptionSetIdentityType) – The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys. Known values are: “SystemAssigned”, “UserAssigned”, “SystemAssigned, UserAssigned”, and “None”.
user_assigned_identities (dict[str, UserAssignedIdentitiesValue]) – The list of user identities associated with the disk encryption set. The user identity dictionary key references will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’. # pylint: disable=line-too-long

class azure.mgmt.compute.v2024_03_02.models.EncryptionSettingsCollection(*, enabled: bool, encryption_settings: List[_models.EncryptionSettingsElement] | None = None, encryption_settings_version: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Encryption settings for disk or snapshot.

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

Variables:

enabled (bool) – Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged. Required.
encryption_settings (list[EncryptionSettingsElement]) – A collection of encryption settings, one for each disk volume.
encryption_settings_version (str) – Describes what type of encryption is used for the disks. Once this field is set, it cannot be overwritten. ‘1.0’ corresponds to Azure Disk Encryption with AAD app.’1.1’ corresponds to Azure Disk Encryption.

Keyword Arguments:

enabled (bool) – Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged. Required.
encryption_settings (list[EncryptionSettingsElement]) – A collection of encryption settings, one for each disk volume.
encryption_settings_version (str) – Describes what type of encryption is used for the disks. Once this field is set, it cannot be overwritten. ‘1.0’ corresponds to Azure Disk Encryption with AAD app.’1.1’ corresponds to Azure Disk Encryption.

class azure.mgmt.compute.v2024_03_02.models.EncryptionSettingsElement(*, disk_encryption_key: _models.KeyVaultAndSecretReference | None = None, key_encryption_key: _models.KeyVaultAndKeyReference | None = None, **kwargs: Any)[source]¶

Bases: Model

Encryption settings for one disk volume.

Variables:

disk_encryption_key (KeyVaultAndSecretReference) – Key Vault Secret Url and vault id of the disk encryption key.
key_encryption_key (KeyVaultAndKeyReference) – Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key.

Keyword Arguments:

disk_encryption_key (KeyVaultAndSecretReference) – Key Vault Secret Url and vault id of the disk encryption key.
key_encryption_key (KeyVaultAndKeyReference) – Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key.

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

Bases: str, Enum

The type of key used to encrypt the data of the disk.

ENCRYPTION_AT_REST_WITH_CUSTOMER_KEY = 'EncryptionAtRestWithCustomerKey'¶: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer.

ENCRYPTION_AT_REST_WITH_PLATFORM_AND_CUSTOMER_KEYS = 'EncryptionAtRestWithPlatformAndCustomerKeys'¶: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed.

ENCRYPTION_AT_REST_WITH_PLATFORM_KEY = 'EncryptionAtRestWithPlatformKey'¶: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets.

class azure.mgmt.compute.v2024_03_02.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.v2024_03_02.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.v2024_03_02.models.FileFormat(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Used to specify the file format when making request for SAS on a VHDX file format snapshot.

VHD = 'VHD'¶: A VHD file is a disk image file in the Virtual Hard Disk file format.

VHDX = 'VHDX'¶: A VHDX file is a disk image file in the Virtual Hard Disk v2 file format.

class azure.mgmt.compute.v2024_03_02.models.GrantAccessData(*, access: str | _models.AccessLevel, duration_in_seconds: int, get_secure_vm_guest_state_sas: bool | None = None, file_format: str | _models.FileFormat | None = None, **kwargs: Any)[source]¶

Bases: Model

Data used for requesting a SAS.

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

Variables:

access (str or AccessLevel) – Required. Known values are: “None”, “Read”, and “Write”.
duration_in_seconds (int) – Time duration in seconds until the SAS access expires. Required.
get_secure_vm_guest_state_sas (bool) – Set this flag to true to get additional SAS for VM guest state.
file_format (str or FileFormat) – Used to specify the file format when making request for SAS on a VHDX file format snapshot. Known values are: “VHD” and “VHDX”.

Keyword Arguments:

access (str or AccessLevel) – Required. Known values are: “None”, “Read”, and “Write”.
duration_in_seconds (int) – Time duration in seconds until the SAS access expires. Required.
get_secure_vm_guest_state_sas (bool) – Set this flag to true to get additional SAS for VM guest state.
file_format (str or FileFormat) – Used to specify the file format when making request for SAS on a VHDX file format snapshot. Known values are: “VHD” and “VHDX”.

class azure.mgmt.compute.v2024_03_02.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.v2024_03_02.models.ImageDiskReference(*, id: str | None = None, shared_gallery_image_id: str | None = None, community_gallery_image_id: str | None = None, lun: int | None = None, **kwargs: Any)[source]¶

Bases: Model

The source image used for creating the disk.

Variables:

id (str) – A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference.
shared_gallery_image_id (str) – A relative uri containing a direct shared Azure Compute Gallery image reference.
community_gallery_image_id (str) – A relative uri containing a community Azure Compute Gallery image reference.
lun (int) – If the disk is created from an image’s data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null.

Keyword Arguments:

id (str) – A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference.
shared_gallery_image_id (str) – A relative uri containing a direct shared Azure Compute Gallery image reference.
community_gallery_image_id (str) – A relative uri containing a community Azure Compute Gallery image reference.
lun (int) – If the disk is created from an image’s data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null.

class azure.mgmt.compute.v2024_03_02.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.v2024_03_02.models.KeyForDiskEncryptionSet(*, key_url: str, source_vault: _models.SourceVault | None = None, **kwargs: Any)[source]¶

Bases: Model

Key Vault Key Url to be used for server side encryption of Managed Disks and Snapshots.

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

Variables:

source_vault (SourceVault) – Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription.
key_url (str) – Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. Required.

Keyword Arguments:

source_vault (SourceVault) – Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription.
key_url (str) – Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. Required.

class azure.mgmt.compute.v2024_03_02.models.KeyVaultAndKeyReference(*, source_vault: _models.SourceVault, key_url: str, **kwargs: Any)[source]¶

Bases: Model

Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey.

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

Variables:

source_vault (SourceVault) – Resource id of the KeyVault containing the key or secret. Required.
key_url (str) – Url pointing to a key or secret in KeyVault. Required.

Keyword Arguments:

source_vault (SourceVault) – Resource id of the KeyVault containing the key or secret. Required.
key_url (str) – Url pointing to a key or secret in KeyVault. Required.

class azure.mgmt.compute.v2024_03_02.models.KeyVaultAndSecretReference(*, source_vault: _models.SourceVault, secret_url: str, **kwargs: Any)[source]¶

Bases: Model

Key Vault Secret Url and vault id of the encryption key.

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

Variables:

source_vault (SourceVault) – Resource id of the KeyVault containing the key or secret. Required.
secret_url (str) – Url pointing to a key or secret in KeyVault. Required.

Keyword Arguments:

source_vault (SourceVault) – Resource id of the KeyVault containing the key or secret. Required.
secret_url (str) – Url pointing to a key or secret in KeyVault. Required.

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

Bases: str, Enum

Policy for accessing the disk via network.

ALLOW_ALL = 'AllowAll'¶: The disk can be exported or uploaded to from any network.

ALLOW_PRIVATE = 'AllowPrivate'¶: The disk can be exported or uploaded to using a DiskAccess resource’s private endpoints.

DENY_ALL = 'DenyAll'¶: The disk cannot be exported.

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

Bases: str, Enum

The Operating System type.

LINUX = 'Linux'¶

WINDOWS = 'Windows'¶

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

Bases: Model

The Private Endpoint resource.

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

Variables:: id (str) – The ARM identifier for Private Endpoint.

class azure.mgmt.compute.v2024_03_02.models.PrivateEndpointConnection(*, private_link_service_connection_state: _models.PrivateLinkServiceConnectionState | None = None, **kwargs: Any)[source]¶

Bases: Model

The Private Endpoint Connection resource.

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

Variables:

id (str) – private endpoint connection Id.
name (str) – private endpoint connection name.
type (str) – private endpoint connection type.
private_endpoint (PrivateEndpoint) – The resource of private end point.
private_link_service_connection_state (PrivateLinkServiceConnectionState) – A collection of information about the state of the connection between DiskAccess and Virtual Network.
provisioning_state (str or PrivateEndpointConnectionProvisioningState) – The provisioning state of the private endpoint connection resource. Known values are: “Succeeded”, “Creating”, “Deleting”, and “Failed”.

Keyword Arguments:

private_link_service_connection_state (PrivateLinkServiceConnectionState) – A collection of information about the state of the connection between DiskAccess and Virtual Network.

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

Bases: Model

A list of private link resources.

Variables:

value (list[PrivateEndpointConnection]) – Array of private endpoint connections.
next_link (str) – The uri to fetch the next page of snapshots. Call ListNext() with this to fetch the next page of snapshots.

Keyword Arguments:

value (list[PrivateEndpointConnection]) – Array of private endpoint connections.
next_link (str) – The uri to fetch the next page of snapshots. Call ListNext() with this to fetch the next page of snapshots.

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

Bases: str, Enum

The current provisioning state.

CREATING = 'Creating'¶

DELETING = 'Deleting'¶

FAILED = 'Failed'¶

SUCCEEDED = 'Succeeded'¶

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

Bases: str, Enum

The private endpoint connection status.

APPROVED = 'Approved'¶

PENDING = 'Pending'¶

REJECTED = 'Rejected'¶

class azure.mgmt.compute.v2024_03_02.models.PrivateLinkResource(*, required_zone_names: List[str] | None = None, **kwargs: Any)[source]¶

Bases: Model

A private link resource.

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

Variables:

id (str) – private link resource Id.
name (str) – private link resource name.
type (str) – private link resource type.
group_id (str) – The private link resource group id.
required_members (list[str]) – The private link resource required member names.
required_zone_names (list[str]) – The private link resource DNS zone name.

Keyword Arguments:

required_zone_names (list[str]) – The private link resource DNS zone name.

class azure.mgmt.compute.v2024_03_02.models.PrivateLinkResourceListResult(*, value: List[_models.PrivateLinkResource] | None = None, **kwargs: Any)[source]¶

Bases: Model

A list of private link resources.

Variables:: value (list[PrivateLinkResource]) – Array of private link resources.
Keyword Arguments:: value (list[PrivateLinkResource]) – Array of private link resources.

class azure.mgmt.compute.v2024_03_02.models.PrivateLinkServiceConnectionState(*, status: str | _models.PrivateEndpointServiceConnectionStatus | None = None, description: str | None = None, actions_required: str | None = None, **kwargs: Any)[source]¶

Bases: Model

A collection of information about the state of the connection between service consumer and provider.

Variables:

status (str or PrivateEndpointServiceConnectionStatus) – Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. Known values are: “Pending”, “Approved”, and “Rejected”.
description (str) – The reason for approval/rejection of the connection.
actions_required (str) – A message indicating if changes on the service provider require any updates on the consumer.

Keyword Arguments:

status (str or PrivateEndpointServiceConnectionStatus) – Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. Known values are: “Pending”, “Approved”, and “Rejected”.
description (str) – The reason for approval/rejection of the connection.
actions_required (str) – A message indicating if changes on the service provider require any updates on the consumer.

class azure.mgmt.compute.v2024_03_02.models.PropertyUpdatesInProgress(*, target_tier: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Properties of the disk for which update is pending.

Variables:: target_tier (str) – The target performance tier of the disk if a tier change operation is in progress.
Keyword Arguments:: target_tier (str) – The target performance tier of the disk if a tier change operation is in progress.

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

Bases: str, Enum

If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed.

ENHANCED = 'Enhanced'¶

NONE = 'None'¶

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

Bases: Model

The ProxyOnly 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.

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

Bases: str, Enum

Policy for controlling export on the disk.

DISABLED = 'Disabled'¶: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate.

ENABLED = 'Enabled'¶: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate.

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

Bases: Model

Used for establishing the purchase context of any 3rd Party artifact through MarketPlace.

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

Variables:

name (str) – The plan ID. Required.
publisher (str) – The publisher ID. Required.
product (str) – Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. Required.
promotion_code (str) – The Offer Promotion Code.

Keyword Arguments:

name (str) – The plan ID. Required.
publisher (str) – The publisher ID. Required.
product (str) – Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. Required.
promotion_code (str) – The Offer Promotion Code.

class azure.mgmt.compute.v2024_03_02.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.v2024_03_02.models.ResourceUriList(*, value: List[str], next_link: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The List resources which are encrypted with the disk encryption set.

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

Variables:

value (list[str]) – A list of IDs or Owner IDs of resources which are encrypted with the disk encryption set. Required.
next_link (str) – The uri to fetch the next page of encrypted resources. Call ListNext() with this to fetch the next page of encrypted resources.

Keyword Arguments:

value (list[str]) – A list of IDs or Owner IDs of resources which are encrypted with the disk encryption set. Required.
next_link (str) – The uri to fetch the next page of encrypted resources. Call ListNext() with this to fetch the next page of encrypted resources.

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

Bases: Model

ShareInfoElement.

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

Variables:: vm_uri (str) – A relative URI containing the ID of the VM that has the disk attached.

class azure.mgmt.compute.v2024_03_02.models.Snapshot(*, location: str, tags: Dict[str, str] | None = None, sku: _models.SnapshotSku | None = None, extended_location: _models.ExtendedLocation | None = None, os_type: str | _models.OperatingSystemTypes | None = None, hyper_v_generation: str | _models.HyperVGeneration | None = None, purchase_plan: _models.PurchasePlan | None = None, supported_capabilities: _models.SupportedCapabilities | None = None, creation_data: _models.CreationData | None = None, disk_size_gb: int | None = None, encryption_settings_collection: _models.EncryptionSettingsCollection | None = None, incremental: bool | None = None, encryption: _models.Encryption | None = None, network_access_policy: str | _models.NetworkAccessPolicy | None = None, disk_access_id: str | None = None, security_profile: _models.DiskSecurityProfile | None = None, supports_hibernation: bool | None = None, public_network_access: str | _models.PublicNetworkAccess | None = None, completion_percent: float | None = None, copy_completion_error: _models.CopyCompletionError | None = None, data_access_auth_mode: str | _models.DataAccessAuthMode | None = None, **kwargs: Any)[source]¶

Bases: Resource

Snapshot resource.

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.
managed_by (str) – Unused. Always Null.
sku (SnapshotSku) – The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot.
extended_location (ExtendedLocation) – The extended location where the snapshot will be created. Extended location cannot be changed.
time_created (datetime) – The time when the snapshot was created.
os_type (str or OperatingSystemTypes) – The Operating System type. Known values are: “Windows” and “Linux”.
hyper_v_generation (str or HyperVGeneration) – The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Known values are: “V1” and “V2”.
purchase_plan (PurchasePlan) – Purchase plan information for the image from which the source disk for the snapshot was originally created.
supported_capabilities (SupportedCapabilities) – List of supported capabilities for the image from which the source disk from the snapshot was originally created.
creation_data (CreationData) – Disk source information. CreationData information cannot be changed after the disk has been created.
disk_size_gb (int) – If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk’s size.
disk_size_bytes (int) – The size of the disk in bytes. This field is read only.
disk_state (str or DiskState) – The state of the snapshot. Known values are: “Unattached”, “Attached”, “Reserved”, “Frozen”, “ActiveSAS”, “ActiveSASFrozen”, “ReadyToUpload”, and “ActiveUpload”.
unique_id (str) – Unique Guid identifying the resource.
encryption_settings_collection (EncryptionSettingsCollection) – Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
provisioning_state (str) – The disk provisioning state.
incremental (bool) – Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed.
incremental_snapshot_family_id (str) – Incremental snapshots for a disk share an incremental snapshot family id. The Get Page Range Diff API can only be called on incremental snapshots with the same family id.
encryption (Encryption) – Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
network_access_policy (str or NetworkAccessPolicy) – Policy for accessing the disk via network. Known values are: “AllowAll”, “AllowPrivate”, and “DenyAll”.
disk_access_id (str) – ARM id of the DiskAccess resource for using private endpoints on disks.
security_profile (DiskSecurityProfile) – Contains the security related information for the resource.
supports_hibernation (bool) – Indicates the OS on a snapshot supports hibernation.
public_network_access (str or PublicNetworkAccess) – Policy for controlling export on the disk. Known values are: “Enabled” and “Disabled”.
completion_percent (float) – Percentage complete for the background copy when a resource is created via the CopyStart operation.
copy_completion_error (CopyCompletionError) – Indicates the error details if the background copy of a resource created via the CopyStart operation fails.
data_access_auth_mode (str or DataAccessAuthMode) – Additional authentication requirements when exporting or uploading to a disk or snapshot. Known values are: “AzureActiveDirectory” and “None”.

Keyword Arguments:

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
sku (SnapshotSku) – The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot.
extended_location (ExtendedLocation) – The extended location where the snapshot will be created. Extended location cannot be changed.
os_type (str or OperatingSystemTypes) – The Operating System type. Known values are: “Windows” and “Linux”.
hyper_v_generation (str or HyperVGeneration) – The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Known values are: “V1” and “V2”.
purchase_plan (PurchasePlan) – Purchase plan information for the image from which the source disk for the snapshot was originally created.
supported_capabilities (SupportedCapabilities) – List of supported capabilities for the image from which the source disk from the snapshot was originally created.
creation_data (CreationData) – Disk source information. CreationData information cannot be changed after the disk has been created.
disk_size_gb (int) – If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk’s size.
encryption_settings_collection (EncryptionSettingsCollection) – Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
incremental (bool) – Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed.
encryption (Encryption) – Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
network_access_policy (str or NetworkAccessPolicy) – Policy for accessing the disk via network. Known values are: “AllowAll”, “AllowPrivate”, and “DenyAll”.
disk_access_id (str) – ARM id of the DiskAccess resource for using private endpoints on disks.
security_profile (DiskSecurityProfile) – Contains the security related information for the resource.
supports_hibernation (bool) – Indicates the OS on a snapshot supports hibernation.
public_network_access (str or PublicNetworkAccess) – Policy for controlling export on the disk. Known values are: “Enabled” and “Disabled”.
completion_percent (float) – Percentage complete for the background copy when a resource is created via the CopyStart operation.
copy_completion_error (CopyCompletionError) – Indicates the error details if the background copy of a resource created via the CopyStart operation fails.
data_access_auth_mode (str or DataAccessAuthMode) – Additional authentication requirements when exporting or uploading to a disk or snapshot. Known values are: “AzureActiveDirectory” and “None”.

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

Bases: Model

The List Snapshots operation response.

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

Variables:

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

Keyword Arguments:

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

class azure.mgmt.compute.v2024_03_02.models.SnapshotSku(*, name: str | _models.SnapshotStorageAccountTypes | None = None, **kwargs: Any)[source]¶

Bases: Model

The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot.

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

Variables:

name (str or SnapshotStorageAccountTypes) – The sku name. Known values are: “Standard_LRS”, “Premium_LRS”, and “Standard_ZRS”.
tier (str) – The sku tier.

Keyword Arguments:

name (str or SnapshotStorageAccountTypes) – The sku name. Known values are: “Standard_LRS”, “Premium_LRS”, and “Standard_ZRS”.

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

Bases: str, Enum

The sku name.

PREMIUM_LRS = 'Premium_LRS'¶: Premium SSD locally redundant storage

STANDARD_LRS = 'Standard_LRS'¶: Standard HDD locally redundant storage

STANDARD_ZRS = 'Standard_ZRS'¶: Standard zone redundant storage

class azure.mgmt.compute.v2024_03_02.models.SnapshotUpdate(*, tags: Dict[str, str] | None = None, sku: _models.SnapshotSku | None = None, os_type: str | _models.OperatingSystemTypes | None = None, disk_size_gb: int | None = None, encryption_settings_collection: _models.EncryptionSettingsCollection | None = None, encryption: _models.Encryption | None = None, network_access_policy: str | _models.NetworkAccessPolicy | None = None, disk_access_id: str | None = None, supports_hibernation: bool | None = None, public_network_access: str | _models.PublicNetworkAccess | None = None, data_access_auth_mode: str | _models.DataAccessAuthMode | None = None, supported_capabilities: _models.SupportedCapabilities | None = None, **kwargs: Any)[source]¶

Bases: Model

Snapshot update resource.

Variables:

tags (dict[str, str]) – Resource tags.
sku (SnapshotSku) – The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot.
os_type (str or OperatingSystemTypes) – the Operating System type. Known values are: “Windows” and “Linux”.
disk_size_gb (int) – If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk’s size.
encryption_settings_collection (EncryptionSettingsCollection) – Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
encryption (Encryption) – Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
network_access_policy (str or NetworkAccessPolicy) – Policy for accessing the disk via network. Known values are: “AllowAll”, “AllowPrivate”, and “DenyAll”.
disk_access_id (str) – ARM id of the DiskAccess resource for using private endpoints on disks.
supports_hibernation (bool) – Indicates the OS on a snapshot supports hibernation.
public_network_access (str or PublicNetworkAccess) – Policy for controlling export on the disk. Known values are: “Enabled” and “Disabled”.
data_access_auth_mode (str or DataAccessAuthMode) – Additional authentication requirements when exporting or uploading to a disk or snapshot. Known values are: “AzureActiveDirectory” and “None”.
supported_capabilities (SupportedCapabilities) – List of supported capabilities for the image from which the OS disk was created.

Keyword Arguments:

tags (dict[str, str]) – Resource tags.
sku (SnapshotSku) – The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot.
os_type (str or OperatingSystemTypes) – the Operating System type. Known values are: “Windows” and “Linux”.
disk_size_gb (int) – If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk’s size.
encryption_settings_collection (EncryptionSettingsCollection) – Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
encryption (Encryption) – Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
network_access_policy (str or NetworkAccessPolicy) – Policy for accessing the disk via network. Known values are: “AllowAll”, “AllowPrivate”, and “DenyAll”.
disk_access_id (str) – ARM id of the DiskAccess resource for using private endpoints on disks.
supports_hibernation (bool) – Indicates the OS on a snapshot supports hibernation.
public_network_access (str or PublicNetworkAccess) – Policy for controlling export on the disk. Known values are: “Enabled” and “Disabled”.
data_access_auth_mode (str or DataAccessAuthMode) – Additional authentication requirements when exporting or uploading to a disk or snapshot. Known values are: “AzureActiveDirectory” and “None”.
supported_capabilities (SupportedCapabilities) – List of supported capabilities for the image from which the OS disk was created.

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

Bases: Model

The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}.

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

class azure.mgmt.compute.v2024_03_02.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.v2024_03_02.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.v2024_03_02.models.SupportedCapabilities(*, disk_controller_types: str | None = None, accelerated_network: bool | None = None, architecture: str | _models.Architecture | None = None, **kwargs: Any)[source]¶

Bases: Model

List of supported capabilities persisted on the disk resource for VM use.

Variables:

disk_controller_types (str) – The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI.
accelerated_network (bool) – True if the image from which the OS disk is created supports accelerated networking.
architecture (str or Architecture) – CPU architecture supported by an OS disk. Known values are: “x64” and “Arm64”.

Keyword Arguments:

disk_controller_types (str) – The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI.
accelerated_network (bool) – True if the image from which the OS disk is created supports accelerated networking.
architecture (str or Architecture) – CPU architecture supported by an OS disk. Known values are: “x64” and “Arm64”.

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

Bases: Model

The system meta data relating to this resource.

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

Variables:

created_at (datetime) – Specifies the time in UTC at which the Cloud Service (extended support) resource was created. :code:`<br />`Minimum api-version: 2022-04-04.
last_modified_at (datetime) – Specifies the time in UTC at which the Cloud Service (extended support) resource was last modified. :code:`<br />`Minimum api-version: 2022-04-04.

class azure.mgmt.compute.v2024_03_02.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.