azure.mgmt.compute.v2024_03_02.operations module

class azure.mgmt.compute.v2024_03_02.operations.DiskAccessesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ComputeManagementClient’s disk_accesses attribute.

begin_create_or_update(resource_group_name: str, disk_access_name: str, disk_access: _models.DiskAccess, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.DiskAccess][source]
begin_create_or_update(resource_group_name: str, disk_access_name: str, disk_access: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.DiskAccess]

Creates or updates a disk access resource.

Parameters:

  • resource_group_name (str) – The name of the resource group. Required.

  • disk_access_name (str) – The name of the disk access resource that is being created. The name can’t be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. Required.

  • disk_access (DiskAccess or IO[bytes]) – disk access object supplied in the body of the Put disk access operation. Is either a DiskAccess type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either DiskAccess or the result of cls(response)

Return type:

LROPoller[DiskAccess]

Raises:

HttpResponseError –

begin_delete(resource_group_name: str, disk_access_name: str, **kwargs: Any) → LROPoller[None][source]

Deletes a disk access resource.

Parameters:

  • resource_group_name (str) – The name of the resource group. Required.

  • disk_access_name (str) – The name of the disk access resource that is being created. The name can’t be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. Required.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_delete_a_private_endpoint_connection(resource_group_name: str, disk_access_name: str, private_endpoint_connection_name: str, **kwargs: Any) → LROPoller[None][source]

Deletes a private endpoint connection under a disk access resource.

Parameters:

  • resource_group_name (str) – The name of the resource group. Required.

  • disk_access_name (str) – The name of the disk access resource that is being created. The name can’t be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. Required.

  • private_endpoint_connection_name (str) – The name of the private endpoint connection. Required.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_update(resource_group_name: str, disk_access_name: str, disk_access: _models.DiskAccessUpdate, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.DiskAccess][source]
begin_update(resource_group_name: str, disk_access_name: str, disk_access: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.DiskAccess]

Updates (patches) a disk access resource.

Parameters:

  • resource_group_name (str) – The name of the resource group. Required.

  • disk_access_name (str) – The name of the disk access resource that is being created. The name can’t be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. Required.

  • disk_access (DiskAccessUpdate or IO[bytes]) – disk access object supplied in the body of the Patch disk access operation. Is either a DiskAccessUpdate type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either DiskAccess or the result of cls(response)

Return type:

LROPoller[DiskAccess]

Raises:

HttpResponseError –

begin_update_a_private_endpoint_connection(resource_group_name: str, disk_access_name: str, private_endpoint_connection_name: str, private_endpoint_connection: _models.PrivateEndpointConnection, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.PrivateEndpointConnection][source]
begin_update_a_private_endpoint_connection(resource_group_name: str, disk_access_name: str, private_endpoint_connection_name: str, private_endpoint_connection: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.PrivateEndpointConnection]

Approve or reject a private endpoint connection under disk access resource, this can’t be used to create a new private endpoint connection.

Parameters:

  • resource_group_name (str) – The name of the resource group. Required.

  • disk_access_name (str) – The name of the disk access resource that is being created. The name can’t be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. Required.

  • private_endpoint_connection_name (str) – The name of the private endpoint connection. Required.

  • private_endpoint_connection (PrivateEndpointConnection or IO[bytes]) – private endpoint connection object supplied in the body of the Put private endpoint connection operation. Is either a PrivateEndpointConnection type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either PrivateEndpointConnection or the result of cls(response)

Return type:

LROPoller[PrivateEndpointConnection]

Raises:

HttpResponseError –

get(resource_group_name: str, disk_access_name: str, **kwargs: Any) → DiskAccess[source]

Gets information about a disk access resource.

Parameters:

  • resource_group_name (str) – The name of the resource group. Required.

  • disk_access_name (str) – The name of the disk access resource that is being created. The name can’t be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. Required.

Returns:

DiskAccess or the result of cls(response)

Return type:

DiskAccess

Raises:

HttpResponseError –

get_a_private_endpoint_connection(resource_group_name: str, disk_access_name: str, private_endpoint_connection_name: str, **kwargs: Any) → PrivateEndpointConnection[source]

Gets information about a private endpoint connection under a disk access resource.

Parameters:

  • resource_group_name (str) – The name of the resource group. Required.

  • disk_access_name (str) – The name of the disk access resource that is being created. The name can’t be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. Required.

  • private_endpoint_connection_name (str) – The name of the private endpoint connection. Required.

Returns:

PrivateEndpointConnection or the result of cls(response)

Return type:

PrivateEndpointConnection

Raises:

HttpResponseError –

Gets the private link resources possible under disk access resource.

Parameters:

  • resource_group_name (str) – The name of the resource group. Required.

  • disk_access_name (str) – The name of the disk access resource that is being created. The name can’t be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. Required.

Returns:

PrivateLinkResourceListResult or the result of cls(response)

Return type:

PrivateLinkResourceListResult

Raises:

HttpResponseError –

list(**kwargs: Any) → Iterable[DiskAccess][source]

Lists all the disk access resources under a subscription.

Returns:

An iterator like instance of either DiskAccess or the result of cls(response)

Return type:

ItemPaged[DiskAccess]

Raises:

HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[DiskAccess][source]

Lists all the disk access resources under a resource group.

Parameters:

resource_group_name (str) – The name of the resource group. Required.

Returns:

An iterator like instance of either DiskAccess or the result of cls(response)

Return type:

ItemPaged[DiskAccess]

Raises:

HttpResponseError –

list_private_endpoint_connections(resource_group_name: str, disk_access_name: str, **kwargs: Any) → Iterable[PrivateEndpointConnection][source]

List information about private endpoint connections under a disk access resource.

Parameters:

  • resource_group_name (str) – The name of the resource group. Required.

  • disk_access_name (str) – The name of the disk access resource that is being created. The name can’t be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. Required.

Returns:

An iterator like instance of either PrivateEndpointConnection or the result of cls(response)

Return type:

ItemPaged[PrivateEndpointConnection]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.compute.v2024_03_02.models' from '/mnt/vss/_work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/compute/v2024_03_02/models/__init__.py'>
class azure.mgmt.compute.v2024_03_02.operations.DiskEncryptionSetsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ComputeManagementClient’s disk_encryption_sets attribute.

begin_create_or_update(resource_group_name: str, disk_encryption_set_name: str, disk_encryption_set: _models.DiskEncryptionSet, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.DiskEncryptionSet][source]
begin_create_or_update(resource_group_name: str, disk_encryption_set_name: str, disk_encryption_set: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.DiskEncryptionSet]

Creates or updates a disk encryption set.

Parameters:

  • resource_group_name (str) – The name of the resource group. Required.

  • disk_encryption_set_name (str) – The name of the disk encryption set that is being created. The name can’t be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. Required.

  • disk_encryption_set (DiskEncryptionSet or IO[bytes]) – disk encryption set object supplied in the body of the Put disk encryption set operation. Is either a DiskEncryptionSet type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either DiskEncryptionSet or the result of cls(response)

Return type:

LROPoller[DiskEncryptionSet]

Raises:

HttpResponseError –

begin_delete(resource_group_name: str, disk_encryption_set_name: str, **kwargs: Any) → LROPoller[None][source]

Deletes a disk encryption set.

Parameters:

  • resource_group_name (str) – The name of the resource group. Required.

  • disk_encryption_set_name (str) – The name of the disk encryption set that is being created. The name can’t be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. Required.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_update(resource_group_name: str, disk_encryption_set_name: str, disk_encryption_set: _models.DiskEncryptionSetUpdate, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.DiskEncryptionSet][source]
begin_update(resource_group_name: str, disk_encryption_set_name: str, disk_encryption_set: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.DiskEncryptionSet]

Updates (patches) a disk encryption set.

Parameters:

  • resource_group_name (str) – The name of the resource group. Required.

  • disk_encryption_set_name (str) – The name of the disk encryption set that is being created. The name can’t be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. Required.

  • disk_encryption_set (DiskEncryptionSetUpdate or IO[bytes]) – disk encryption set object supplied in the body of the Patch disk encryption set operation. Is either a DiskEncryptionSetUpdate type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either DiskEncryptionSet or the result of cls(response)

Return type:

LROPoller[DiskEncryptionSet]

Raises:

HttpResponseError –

get(resource_group_name: str, disk_encryption_set_name: str, **kwargs: Any) → DiskEncryptionSet[source]

Gets information about a disk encryption set.

Parameters:

  • resource_group_name (str) – The name of the resource group. Required.

  • disk_encryption_set_name (str) – The name of the disk encryption set that is being created. The name can’t be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. Required.

Returns:

DiskEncryptionSet or the result of cls(response)

Return type:

DiskEncryptionSet

Raises:

HttpResponseError –

list(**kwargs: Any) → Iterable[DiskEncryptionSet][source]

Lists all the disk encryption sets under a subscription.

Returns:

An iterator like instance of either DiskEncryptionSet or the result of cls(response)

Return type:

ItemPaged[DiskEncryptionSet]

Raises:

HttpResponseError –

list_associated_resources(resource_group_name: str, disk_encryption_set_name: str, **kwargs: Any) → Iterable[str][source]

Lists all resources that are encrypted with this disk encryption set.

Parameters:

  • resource_group_name (str) – The name of the resource group. Required.

  • disk_encryption_set_name (str) – The name of the disk encryption set that is being created. The name can’t be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. Required.

Returns:

An iterator like instance of either str or the result of cls(response)

Return type:

ItemPaged[str]

Raises:

HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[DiskEncryptionSet][source]

Lists all the disk encryption sets under a resource group.

Parameters:

resource_group_name (str) – The name of the resource group. Required.

Returns:

An iterator like instance of either DiskEncryptionSet or the result of cls(response)

Return type:

ItemPaged[DiskEncryptionSet]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.compute.v2024_03_02.models' from '/mnt/vss/_work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/compute/v2024_03_02/models/__init__.py'>
class azure.mgmt.compute.v2024_03_02.operations.DiskRestorePointOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ComputeManagementClient’s disk_restore_point attribute.

begin_grant_access(resource_group_name: str, restore_point_collection_name: str, vm_restore_point_name: str, disk_restore_point_name: str, grant_access_data: _models.GrantAccessData, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.AccessUri][source]
begin_grant_access(resource_group_name: str, restore_point_collection_name: str, vm_restore_point_name: str, disk_restore_point_name: str, grant_access_data: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.AccessUri]

Grants access to a diskRestorePoint.

Parameters:

  • resource_group_name (str) – The name of the resource group. Required.

  • restore_point_collection_name (str) – The name of the restore point collection that the disk restore point belongs. Required.

  • vm_restore_point_name (str) – The name of the vm restore point that the disk disk restore point belongs. Required.

  • disk_restore_point_name (str) – The name of the disk restore point created. Required.

  • grant_access_data (GrantAccessData or IO[bytes]) – Access data object supplied in the body of the get disk access operation. Is either a GrantAccessData type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either AccessUri or the result of cls(response)

Return type:

LROPoller[AccessUri]

Raises:

HttpResponseError –

begin_revoke_access(resource_group_name: str, restore_point_collection_name: str, vm_restore_point_name: str, disk_restore_point_name: str, **kwargs: Any) → LROPoller[None][source]

Revokes access to a diskRestorePoint.

Parameters:

  • resource_group_name (str) – The name of the resource group. Required.

  • restore_point_collection_name (str) – The name of the restore point collection that the disk restore point belongs. Required.

  • vm_restore_point_name (str) – The name of the vm restore point that the disk disk restore point belongs. Required.

  • disk_restore_point_name (str) – The name of the disk restore point created. Required.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

HttpResponseError –

get(resource_group_name: str, restore_point_collection_name: str, vm_restore_point_name: str, disk_restore_point_name: str, **kwargs: Any) → DiskRestorePoint[source]

Get disk restorePoint resource.

Parameters:

  • resource_group_name (str) – The name of the resource group. Required.

  • restore_point_collection_name (str) – The name of the restore point collection that the disk restore point belongs. Required.

  • vm_restore_point_name (str) – The name of the vm restore point that the disk disk restore point belongs. Required.

  • disk_restore_point_name (str) – The name of the disk restore point created. Required.

Returns:

DiskRestorePoint or the result of cls(response)

Return type:

DiskRestorePoint

Raises:

HttpResponseError –

list_by_restore_point(resource_group_name: str, restore_point_collection_name: str, vm_restore_point_name: str, **kwargs: Any) → Iterable[DiskRestorePoint][source]

Lists diskRestorePoints under a vmRestorePoint.

Parameters:

  • resource_group_name (str) – The name of the resource group. Required.

  • restore_point_collection_name (str) – The name of the restore point collection that the disk restore point belongs. Required.

  • vm_restore_point_name (str) – The name of the vm restore point that the disk disk restore point belongs. Required.

Returns:

An iterator like instance of either DiskRestorePoint or the result of cls(response)

Return type:

ItemPaged[DiskRestorePoint]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.compute.v2024_03_02.models' from '/mnt/vss/_work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/compute/v2024_03_02/models/__init__.py'>
class azure.mgmt.compute.v2024_03_02.operations.DisksOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ComputeManagementClient’s disks attribute.

begin_create_or_update(resource_group_name: str, disk_name: str, disk: _models.Disk, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.Disk][source]
begin_create_or_update(resource_group_name: str, disk_name: str, disk: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.Disk]

Creates or updates a disk.

Parameters:

  • resource_group_name (str) – The name of the resource group. Required.

  • disk_name (str) – The name of the managed disk that is being created. The name can’t be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. Required.

  • disk (Disk or IO[bytes]) – Disk object supplied in the body of the Put disk operation. Is either a Disk type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either Disk or the result of cls(response)

Return type:

LROPoller[Disk]

Raises:

HttpResponseError –

begin_delete(resource_group_name: str, disk_name: str, **kwargs: Any) → LROPoller[None][source]

Deletes a disk.

Parameters:

  • resource_group_name (str) – The name of the resource group. Required.

  • disk_name (str) – The name of the managed disk that is being created. The name can’t be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. Required.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_grant_access(resource_group_name: str, disk_name: str, grant_access_data: _models.GrantAccessData, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.AccessUri][source]
begin_grant_access(resource_group_name: str, disk_name: str, grant_access_data: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.AccessUri]

Grants access to a disk.

Parameters:

  • resource_group_name (str) – The name of the resource group. Required.

  • disk_name (str) – The name of the managed disk that is being created. The name can’t be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. Required.

  • grant_access_data (GrantAccessData or IO[bytes]) – Access data object supplied in the body of the get disk access operation. Is either a GrantAccessData type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either AccessUri or the result of cls(response)

Return type:

LROPoller[AccessUri]

Raises:

HttpResponseError –

begin_revoke_access(resource_group_name: str, disk_name: str, **kwargs: Any) → LROPoller[None][source]

Revokes access to a disk.

Parameters:

  • resource_group_name (str) – The name of the resource group. Required.

  • disk_name (str) – The name of the managed disk that is being created. The name can’t be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. Required.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_update(resource_group_name: str, disk_name: str, disk: _models.DiskUpdate, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.Disk][source]
begin_update(resource_group_name: str, disk_name: str, disk: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.Disk]

Updates (patches) a disk.

Parameters:

  • resource_group_name (str) – The name of the resource group. Required.

  • disk_name (str) – The name of the managed disk that is being created. The name can’t be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. Required.

  • disk (DiskUpdate or IO[bytes]) – Disk object supplied in the body of the Patch disk operation. Is either a DiskUpdate type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either Disk or the result of cls(response)

Return type:

LROPoller[Disk]

Raises:

HttpResponseError –

get(resource_group_name: str, disk_name: str, **kwargs: Any) → Disk[source]

Gets information about a disk.

Parameters:

  • resource_group_name (str) – The name of the resource group. Required.

  • disk_name (str) – The name of the managed disk that is being created. The name can’t be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. Required.

Returns:

Disk or the result of cls(response)

Return type:

Disk

Raises:

HttpResponseError –

list(**kwargs: Any) → Iterable[Disk][source]

Lists all the disks under a subscription.

Returns:

An iterator like instance of either Disk or the result of cls(response)

Return type:

ItemPaged[Disk]

Raises:

HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[Disk][source]

Lists all the disks under a resource group.

Parameters:

resource_group_name (str) – The name of the resource group. Required.

Returns:

An iterator like instance of either Disk or the result of cls(response)

Return type:

ItemPaged[Disk]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.compute.v2024_03_02.models' from '/mnt/vss/_work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/compute/v2024_03_02/models/__init__.py'>
class azure.mgmt.compute.v2024_03_02.operations.SnapshotsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ComputeManagementClient’s snapshots attribute.

begin_create_or_update(resource_group_name: str, snapshot_name: str, snapshot: _models.Snapshot, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.Snapshot][source]
begin_create_or_update(resource_group_name: str, snapshot_name: str, snapshot: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.Snapshot]

Creates or updates a snapshot.

Parameters:

  • resource_group_name (str) – The name of the resource group. Required.

  • snapshot_name (str) – The name of the snapshot that is being created. The name can’t be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The max name length is 80 characters. Required.

  • snapshot (Snapshot or IO[bytes]) – Snapshot object supplied in the body of the Put disk operation. Is either a Snapshot type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either Snapshot or the result of cls(response)

Return type:

LROPoller[Snapshot]

Raises:

HttpResponseError –

begin_delete(resource_group_name: str, snapshot_name: str, **kwargs: Any) → LROPoller[None][source]

Deletes a snapshot.

Parameters:

  • resource_group_name (str) – The name of the resource group. Required.

  • snapshot_name (str) – The name of the snapshot that is being created. The name can’t be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The max name length is 80 characters. Required.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_grant_access(resource_group_name: str, snapshot_name: str, grant_access_data: _models.GrantAccessData, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.AccessUri][source]
begin_grant_access(resource_group_name: str, snapshot_name: str, grant_access_data: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.AccessUri]

Grants access to a snapshot.

Parameters:

  • resource_group_name (str) – The name of the resource group. Required.

  • snapshot_name (str) – The name of the snapshot that is being created. The name can’t be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The max name length is 80 characters. Required.

  • grant_access_data (GrantAccessData or IO[bytes]) – Access data object supplied in the body of the get snapshot access operation. Is either a GrantAccessData type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either AccessUri or the result of cls(response)

Return type:

LROPoller[AccessUri]

Raises:

HttpResponseError –

begin_revoke_access(resource_group_name: str, snapshot_name: str, **kwargs: Any) → LROPoller[None][source]

Revokes access to a snapshot.

Parameters:

  • resource_group_name (str) – The name of the resource group. Required.

  • snapshot_name (str) – The name of the snapshot that is being created. The name can’t be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The max name length is 80 characters. Required.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_update(resource_group_name: str, snapshot_name: str, snapshot: _models.SnapshotUpdate, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.Snapshot][source]
begin_update(resource_group_name: str, snapshot_name: str, snapshot: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.Snapshot]

Updates (patches) a snapshot.

Parameters:

  • resource_group_name (str) – The name of the resource group. Required.

  • snapshot_name (str) – The name of the snapshot that is being created. The name can’t be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The max name length is 80 characters. Required.

  • snapshot (SnapshotUpdate or IO[bytes]) – Snapshot object supplied in the body of the Patch snapshot operation. Is either a SnapshotUpdate type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either Snapshot or the result of cls(response)

Return type:

LROPoller[Snapshot]

Raises:

HttpResponseError –

get(resource_group_name: str, snapshot_name: str, **kwargs: Any) → Snapshot[source]

Gets information about a snapshot.

Parameters:

  • resource_group_name (str) – The name of the resource group. Required.

  • snapshot_name (str) – The name of the snapshot that is being created. The name can’t be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The max name length is 80 characters. Required.

Returns:

Snapshot or the result of cls(response)

Return type:

Snapshot

Raises:

HttpResponseError –

list(**kwargs: Any) → Iterable[Snapshot][source]

Lists snapshots under a subscription.

Returns:

An iterator like instance of either Snapshot or the result of cls(response)

Return type:

ItemPaged[Snapshot]

Raises:

HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[Snapshot][source]

Lists snapshots under a resource group.

Parameters:

resource_group_name (str) – The name of the resource group. Required.

Returns:

An iterator like instance of either Snapshot or the result of cls(response)

Return type:

ItemPaged[Snapshot]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.compute.v2024_03_02.models' from '/mnt/vss/_work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/compute/v2024_03_02/models/__init__.py'>