azure.mgmt.compute.v2018_09_30.operations module¶

class azure.mgmt.compute.v2018_09_30.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, *, 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) – Disk object supplied in the body of the Put disk operation. Is either a Disk type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

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) → azure.core.polling._poller.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

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, *, 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) – Access data object supplied in the body of the get disk access operation. Is either a GrantAccessData type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

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) → azure.core.polling._poller.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

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, *, 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) – Disk object supplied in the body of the Patch disk operation. Is either a DiskUpdate type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

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) → azure.mgmt.compute.v2018_09_30.models._models_py3.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Disk or the result of cls(response)

Return type

Disk

Raises

HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.compute.v2018_09_30.models._models_py3.Disk][source]¶

Lists all the disks under a subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
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[azure.mgmt.compute.v2018_09_30.models._models_py3.Disk][source]¶

Lists all the disks under a resource group.

Parameters: resource_group_name (str) – The name of the resource group. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
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.v2018_09_30.models' from '/mnt/vss/_work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/compute/v2018_09_30/models/__init__.py'>¶

class azure.mgmt.compute.v2018_09_30.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, *, 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) – Snapshot object supplied in the body of the Put disk operation. Is either a Snapshot type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

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) → azure.core.polling._poller.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

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, *, 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) – Access data object supplied in the body of the get snapshot access operation. Is either a GrantAccessData type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

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) → azure.core.polling._poller.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

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, *, 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) – Snapshot object supplied in the body of the Patch snapshot operation. Is either a SnapshotUpdate type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

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) → azure.mgmt.compute.v2018_09_30.models._models_py3.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Snapshot or the result of cls(response)

Return type

Snapshot

Raises

HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.compute.v2018_09_30.models._models_py3.Snapshot][source]¶

Lists snapshots under a subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
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[azure.mgmt.compute.v2018_09_30.models._models_py3.Snapshot][source]¶

Lists snapshots under a resource group.

Parameters: resource_group_name (str) – The name of the resource group. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
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.v2018_09_30.models' from '/mnt/vss/_work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/compute/v2018_09_30/models/__init__.py'>¶