azure.mgmt.storageactions.operations module

class azure.mgmt.storageactions.operations.Operations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

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

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

Lists all of the available Storage Actions Rest API operations.

Returns:: An iterator like instance of either Operation or the result of cls(response)
Return type:: ItemPaged[Operation]
Raises:: HttpResponseError –

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

class azure.mgmt.storageactions.operations.StorageTaskAssignmentOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through StorageActionsMgmtClient’s storage_task_assignment attribute.

list(resource_group_name: str, storage_task_name: str, maxpagesize: int | None = None, **kwargs: Any) → Iterable[StorageTaskAssignment][source]

Lists Resource IDs of the Storage Task Assignments associated with this Storage Task.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
storage_task_name (str) – The name of the storage task within the specified resource group. Storage task names must be between 3 and 18 characters in length and use numbers and lower-case letters only. Required.
maxpagesize (int) – Optional, specifies the maximum number of Storage Task Assignment Resource IDs to be included in the list response. Default value is None.

Returns:

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

Return type:

ItemPaged[StorageTaskAssignment]

Raises:

HttpResponseError –

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

class azure.mgmt.storageactions.operations.StorageTasksOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through StorageActionsMgmtClient’s storage_tasks attribute.

begin_create(resource_group_name: str, storage_task_name: str, parameters: StorageTask | IO[bytes], **kwargs: Any) → LROPoller[StorageTask][source]

Asynchronously creates a new storage task resource with the specified parameters. If a storage task is already created and a subsequent create request is issued with different properties, the storage task properties will be updated. If a storage task is already created and a subsequent create or update request is issued with the exact same set of properties, the request will succeed.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
storage_task_name (str) – The name of the storage task within the specified resource group. Storage task names must be between 3 and 18 characters in length and use numbers and lower-case letters only. Required.
parameters (StorageTask or IO[bytes]) – The parameters to create a Storage Task. Is either a StorageTask type or a IO[bytes] type. Required.

Returns:

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

Return type:

LROPoller[StorageTask]

Raises:

HttpResponseError –

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

Delete the storage task resource.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
storage_task_name (str) – The name of the storage task within the specified resource group. Storage task names must be between 3 and 18 characters in length and use numbers and lower-case letters only. 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, storage_task_name: str, parameters: StorageTaskUpdateParameters | IO[bytes], **kwargs: Any) → LROPoller[StorageTask][source]

Update storage task properties.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
storage_task_name (str) – The name of the storage task within the specified resource group. Storage task names must be between 3 and 18 characters in length and use numbers and lower-case letters only. Required.
parameters (StorageTaskUpdateParameters or IO[bytes]) – The parameters to provide to update the storage task resource. Is either a StorageTaskUpdateParameters type or a IO[bytes] type. Required.

Returns:

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

Return type:

LROPoller[StorageTask]

Raises:

HttpResponseError –

get(resource_group_name: str, storage_task_name: str, **kwargs: Any) → StorageTask[source]

Get the storage task properties.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
storage_task_name (str) – The name of the storage task within the specified resource group. Storage task names must be between 3 and 18 characters in length and use numbers and lower-case letters only. Required.

Returns:

StorageTask or the result of cls(response)

Return type:

StorageTask

Raises:

HttpResponseError –

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

Lists all the storage tasks available under the given resource group.

Parameters:: resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
Returns:: An iterator like instance of either StorageTask or the result of cls(response)
Return type:: ItemPaged[StorageTask]
Raises:: HttpResponseError –

list_by_subscription(**kwargs: Any) → Iterable[StorageTask][source]

Lists all the storage tasks available under the subscription.

Returns:: An iterator like instance of either StorageTask or the result of cls(response)
Return type:: ItemPaged[StorageTask]
Raises:: HttpResponseError –

preview_actions(location: str, parameters: StorageTaskPreviewAction | IO[bytes], **kwargs: Any) → StorageTaskPreviewAction[source]

Runs the input conditions against input object metadata properties and designates matched objects in response.

Parameters:

location (str) – The location to perform preview of the actions. Required.
parameters (StorageTaskPreviewAction or IO[bytes]) – The parameters to preview action condition. Is either a StorageTaskPreviewAction type or a IO[bytes] type. Required.

Returns:

StorageTaskPreviewAction or the result of cls(response)

Return type:

StorageTaskPreviewAction

Raises:

HttpResponseError –

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

class azure.mgmt.storageactions.operations.StorageTasksReportOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through StorageActionsMgmtClient’s storage_tasks_report attribute.

list(resource_group_name: str, storage_task_name: str, maxpagesize: int | None = None, filter: str | None = None, **kwargs: Any) → Iterable[StorageTaskReportInstance][source]

Fetch the storage tasks run report summary for each assignment.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
storage_task_name (str) – The name of the storage task within the specified resource group. Storage task names must be between 3 and 18 characters in length and use numbers and lower-case letters only. Required.
maxpagesize (int) – Optional, specifies the maximum number of Storage Task Assignment Resource IDs to be included in the list response. Default value is None.
filter (str) – Optional. When specified, it can be used to query using reporting properties. Default value is None.

Returns:

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

Return type:

ItemPaged[StorageTaskReportInstance]

Raises:

HttpResponseError –

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