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) → ItemPaged[Operation][source]

Lists all of the available Storage Actions Rest API operations.

Returns:: An iterator like instance of Operation
Return type:: ItemPaged[Operation]
Raises:: HttpResponseError –

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, **kwargs: Any) → ItemPaged[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.

Returns:

An iterator like instance of StorageTaskAssignment

Return type:

ItemPaged[StorageTaskAssignment]

Raises:

HttpResponseError –

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 | MutableMapping[str, Any] | 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 JSON or IO[bytes]) – The parameters to create a Storage Task. Is one of the following types: StorageTask, JSON, IO[bytes] Required.

Returns:

An instance of LROPoller that returns StorageTask. The StorageTask is compatible with MutableMapping

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 None

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_update(resource_group_name: str, storage_task_name: str, parameters: StorageTaskUpdateParameters | MutableMapping[str, Any] | 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 JSON or IO[bytes]) – The parameters to provide to update the storage task resource. Is one of the following types: StorageTaskUpdateParameters, JSON, IO[bytes] Required.

Returns:

An instance of LROPoller that returns StorageTask. The StorageTask is compatible with MutableMapping

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. The StorageTask is compatible with MutableMapping

Return type:

StorageTask

Raises:

HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → ItemPaged[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 StorageTask
Return type:: ItemPaged[StorageTask]
Raises:: HttpResponseError –

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

Lists all the storage tasks available under the subscription.

Returns:: An iterator like instance of StorageTask
Return type:: ItemPaged[StorageTask]
Raises:: HttpResponseError –

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

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

Parameters:

location (str) – Required.
parameters (StorageTaskPreviewAction or JSON or IO[bytes]) – The parameters to preview action condition. Is one of the following types: StorageTaskPreviewAction, JSON, IO[bytes] Required.

Returns:

StorageTaskPreviewAction. The StorageTaskPreviewAction is compatible with MutableMapping

Return type:

StorageTaskPreviewAction

Raises:

HttpResponseError –

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, *, filter: str | None = None, **kwargs: Any) → ItemPaged[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.

Keyword Arguments:

filter (str) – Optional. When specified, it can be used to query using reporting properties. Default value is None.

Returns:

An iterator like instance of StorageTaskReportInstance

Return type:

ItemPaged[StorageTaskReportInstance]

Raises:

HttpResponseError –