azure.mgmt.compute.v2018_09_30.operations module

class azure.mgmt.compute.v2018_09_30.operations.DisksOperations(client, config, serializer, deserializer)

Bases: object

DisksOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, disk_name: str, disk: ‘models.Disk’, **kwargs: Any) → LROPoller

Creates or updates a disk.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param disk_name

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.

type disk_name

str

param disk

Disk object supplied in the body of the Put disk operation.

type disk

~azure.mgmt.compute.v2018_09_30.models.Disk

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

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

rtype

~azure.core.polling.LROPoller[~azure.mgmt.compute.v2018_09_30.models.Disk]

raises ~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, disk_name: str, **kwargs: Any) → LROPoller

Deletes a disk.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param disk_name

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.

type disk_name

str

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

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

rtype

~azure.core.polling.LROPoller[None]

raises ~azure.core.exceptions.HttpResponseError

begin_grant_access(resource_group_name: str, disk_name: str, grant_access_data: ‘models.GrantAccessData’, **kwargs: Any) → LROPoller

Grants access to a disk.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param disk_name

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.

type disk_name

str

param grant_access_data

Access data object supplied in the body of the get disk access

operation.

type grant_access_data

~azure.mgmt.compute.v2018_09_30.models.GrantAccessData

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

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

rtype

~azure.core.polling.LROPoller[~azure.mgmt.compute.v2018_09_30.models.AccessUri]

raises ~azure.core.exceptions.HttpResponseError

begin_revoke_access(resource_group_name: str, disk_name: str, **kwargs: Any) → LROPoller

Revokes access to a disk.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param disk_name

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.

type disk_name

str

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

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

rtype

~azure.core.polling.LROPoller[None]

raises ~azure.core.exceptions.HttpResponseError

begin_update(resource_group_name: str, disk_name: str, disk: ‘models.DiskUpdate’, **kwargs: Any) → LROPoller

Updates (patches) a disk.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param disk_name

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.

type disk_name

str

param disk

Disk object supplied in the body of the Patch disk operation.

type disk

~azure.mgmt.compute.v2018_09_30.models.DiskUpdate

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

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

rtype

~azure.core.polling.LROPoller[~azure.mgmt.compute.v2018_09_30.models.Disk]

raises ~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, disk_name: str, **kwargs: Any) → ’models.Disk’

Gets information about a disk.

Parameters

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

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

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

~azure.core.exceptions.HttpResponseError

list(**kwargs: Any) → Iterable[‘models.DiskList’]

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 DiskList or the result of cls(response)

Return type

ItemPaged[DiskList]

Raises

~azure.core.exceptions.HttpResponseError

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[‘models.DiskList’]

Lists all the disks under a resource group.

Parameters

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[DiskList]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.compute.v2018_09_30.models' from '/home/vsts/work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/compute/v2018_09_30/models/__init__.py'>

class azure.mgmt.compute.v2018_09_30.operations.SnapshotsOperations(client, config, serializer, deserializer)

Bases: object

SnapshotsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, snapshot_name: str, snapshot: ‘models.Snapshot’, **kwargs: Any) → LROPoller

Creates or updates a snapshot.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param snapshot_name

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.

type snapshot_name

str

param snapshot

Snapshot object supplied in the body of the Put disk operation.

type snapshot

~azure.mgmt.compute.v2018_09_30.models.Snapshot

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

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

rtype

~azure.core.polling.LROPoller[~azure.mgmt.compute.v2018_09_30.models.Snapshot]

raises ~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, snapshot_name: str, **kwargs: Any) → LROPoller

Deletes a snapshot.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param snapshot_name

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.

type snapshot_name

str

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

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

rtype

~azure.core.polling.LROPoller[None]

raises ~azure.core.exceptions.HttpResponseError

begin_grant_access(resource_group_name: str, snapshot_name: str, grant_access_data: ‘models.GrantAccessData’, **kwargs: Any) → LROPoller

Grants access to a snapshot.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param snapshot_name

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.

type snapshot_name

str

param grant_access_data

Access data object supplied in the body of the get snapshot access

operation.

type grant_access_data

~azure.mgmt.compute.v2018_09_30.models.GrantAccessData

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

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

rtype

~azure.core.polling.LROPoller[~azure.mgmt.compute.v2018_09_30.models.AccessUri]

raises ~azure.core.exceptions.HttpResponseError

begin_revoke_access(resource_group_name: str, snapshot_name: str, **kwargs: Any) → LROPoller

Revokes access to a snapshot.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param snapshot_name

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.

type snapshot_name

str

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

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

rtype

~azure.core.polling.LROPoller[None]

raises ~azure.core.exceptions.HttpResponseError

begin_update(resource_group_name: str, snapshot_name: str, snapshot: ‘models.SnapshotUpdate’, **kwargs: Any) → LROPoller

Updates (patches) a snapshot.

param resource_group_name

The name of the resource group.

type resource_group_name

str

param snapshot_name

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.

type snapshot_name

str

param snapshot

Snapshot object supplied in the body of the Patch snapshot operation.

type snapshot

~azure.mgmt.compute.v2018_09_30.models.SnapshotUpdate

keyword callable cls

A custom type or function that will be passed the direct response

keyword str continuation_token

A continuation token to restart a poller from a saved state.

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

Default waiting time between two polls for LRO operations if no Retry-After header is present.

return

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

rtype

~azure.core.polling.LROPoller[~azure.mgmt.compute.v2018_09_30.models.Snapshot]

raises ~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, snapshot_name: str, **kwargs: Any) → ’models.Snapshot’

Gets information about a snapshot.

Parameters

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

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

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

~azure.core.exceptions.HttpResponseError

list(**kwargs: Any) → Iterable[‘models.SnapshotList’]

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 SnapshotList or the result of cls(response)

Return type

ItemPaged[SnapshotList]

Raises

~azure.core.exceptions.HttpResponseError

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[‘models.SnapshotList’]

Lists snapshots under a resource group.

Parameters

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SnapshotList]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.compute.v2018_09_30.models' from '/home/vsts/work/1/s/sdk/compute/azure-mgmt-compute/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/compute/v2018_09_30/models/__init__.py'>