azure.mgmt.compute.v2020_05_01.models module¶

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

class azure.mgmt.compute.v2020_05_01.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.v2020_05_01.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.v2020_05_01.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, **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”, 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.
gallery_image_reference (ImageDiskReference) – Required if creating from a Gallery Image. The id 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).

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”, 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.
gallery_image_reference (ImageDiskReference) – Required if creating from a Gallery Image. The id 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).

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, or UltraSSD_LRS.
zones (list[str]) – The Logical zone list for Disk.
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”.
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”, “ActiveSAS”, “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.

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, or UltraSSD_LRS.
zones (list[str]) – The Logical zone list for Disk.
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”.
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.

class azure.mgmt.compute.v2020_05_01.models.DiskAccess(*, location: str, tags: Dict[str, str] | 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.
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.

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

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.

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.

class azure.mgmt.compute.v2020_05_01.models.DiskEncryptionSet(*, location: str, tags: Dict[str, str] | None = None, identity: _models.EncryptionSetIdentity | None = None, encryption_type: str | _models.EncryptionType | None = None, active_key: _models.KeyVaultAndKeyReference | 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 EncryptionType) – The type of key used to encrypt the data of the disk. Known values are: “EncryptionAtRestWithPlatformKey”, “EncryptionAtRestWithCustomerKey”, and “EncryptionAtRestWithPlatformAndCustomerKeys”.
active_key (KeyVaultAndKeyReference) – The key vault key which is currently used by this disk encryption set.
previous_keys (list[KeyVaultAndKeyReference]) – 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.

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 EncryptionType) – The type of key used to encrypt the data of the disk. Known values are: “EncryptionAtRestWithPlatformKey”, “EncryptionAtRestWithCustomerKey”, and “EncryptionAtRestWithPlatformAndCustomerKeys”.
active_key (KeyVaultAndKeyReference) – The key vault key which is currently used by this disk encryption set.

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

SYSTEM_ASSIGNED = 'SystemAssigned'¶

class azure.mgmt.compute.v2020_05_01.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.v2020_05_01.models.DiskEncryptionSetUpdate(*, tags: Dict[str, str] | None = None, encryption_type: str | _models.EncryptionType | None = None, active_key: _models.KeyVaultAndKeyReference | None = None, **kwargs: Any)[source]¶

Bases: Model

disk encryption set update resource.

Variables:

tags (dict[str, str]) – Resource tags.
encryption_type (str or EncryptionType) – The type of key used to encrypt the data of the disk. Known values are: “EncryptionAtRestWithPlatformKey”, “EncryptionAtRestWithCustomerKey”, and “EncryptionAtRestWithPlatformAndCustomerKeys”.
active_key (KeyVaultAndKeyReference) – Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey.

Keyword Arguments:

tags (dict[str, str]) – Resource tags.
encryption_type (str or EncryptionType) – The type of key used to encrypt the data of the disk. Known values are: “EncryptionAtRestWithPlatformKey”, “EncryptionAtRestWithCustomerKey”, and “EncryptionAtRestWithPlatformAndCustomerKeys”.
active_key (KeyVaultAndKeyReference) – Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey.

class azure.mgmt.compute.v2020_05_01.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.v2020_05_01.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, or UltraSSD_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”, and “UltraSSD_LRS”.
tier (str) – The sku tier.

Keyword Arguments:

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

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

Bases: str, Enum

The state of the disk.

ACTIVE_SAS = 'ActiveSAS'¶: The disk currently 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 mounted to a running VM.

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

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

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

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

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.

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.

class azure.mgmt.compute.v2020_05_01.models.DiskUpdate(*, tags: Dict[str, str] | None = None, sku: _models.DiskSku | None = None, os_type: str | _models.OperatingSystemTypes | 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, max_shares: int | None = None, encryption: _models.Encryption | None = None, network_access_policy: str | _models.NetworkAccessPolicy | None = None, disk_access_id: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Disk update resource.

Variables:

tags (dict[str, str]) – Resource tags.
sku (DiskSku) – The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or UltraSSD_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.

Keyword Arguments:

tags (dict[str, str]) – Resource tags.
sku (DiskSku) – The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or UltraSSD_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.

class azure.mgmt.compute.v2020_05_01.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.v2020_05_01.models.EncryptionSetIdentity(*, type: str | _models.DiskEncryptionSetIdentityType | 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. “SystemAssigned”
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.

Keyword Arguments:

type (str or DiskEncryptionSetIdentityType) – The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported. “SystemAssigned”

class azure.mgmt.compute.v2020_05_01.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.v2020_05_01.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.v2020_05_01.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.v2020_05_01.models.GrantAccessData(*, access: str | _models.AccessLevel, duration_in_seconds: int, **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.

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.

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

Bases: Model

The source image used for creating the disk.

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

Variables:

id (str) – A relative uri containing either a Platform Image Repository or user image reference. Required.
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 or user image reference. Required.
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.v2020_05_01.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.v2020_05_01.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.v2020_05_01.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.v2020_05_01.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.v2020_05_01.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.v2020_05_01.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.v2020_05_01.models.PrivateEndpointConnection(*, private_endpoint: _models.PrivateEndpoint | None = None, 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_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.

class azure.mgmt.compute.v2020_05_01.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.v2020_05_01.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.v2020_05_01.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.v2020_05_01.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.v2020_05_01.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.v2020_05_01.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.v2020_05_01.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.v2020_05_01.models.Snapshot(*, location: str, tags: Dict[str, str] | None = None, sku: _models.SnapshotSku | None = None, os_type: str | _models.OperatingSystemTypes | None = None, hyper_v_generation: str | _models.HyperVGeneration | 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, **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.
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”.
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 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.
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.

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

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

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.v2020_05_01.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.v2020_05_01.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, **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.
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.

Keyword Arguments:

tags (dict[str, str]) – Resource tags.
sku (SnapshotSku) – The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS.
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.

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