storage_tasks_report

Creates, updates, deletes, gets or lists a storage_tasks_report resource.

Overview

Name	storage_tasks_report
Type	Resource
Id	azure.storage_actions.storage_tasks_report

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
finishTime	string	End time of the run instance. Filter options such as startTime gt '2023-06-26T20:51:24.4494016Z' and other comparison operators can be used as described for DateTime properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators _.
objectFailedCount	string	Total number of objects where task operation failed when was attempted. Filter options such as objectFailedCount eq 0 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators _.
objectsOperatedOnCount	string	Total number of objects that meet the storage tasks condition and were operated upon. Filter options such as objectsOperatedOnCount ge 100 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators _.
objectsSucceededCount	string	Total number of objects where task operation succeeded when was attempted.Filter options such as objectsSucceededCount gt 150 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators _.
objectsTargetedCount	string	Total number of objects that meet the condition as defined in the storage task assignment execution context. Filter options such as objectsTargetedCount gt 50 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators _.
runResult	string	Represents the overall result of the execution for the run instance. Known values are: "Succeeded" and "Failed". (Succeeded, Failed)
runStatusEnum	string	Represents the status of the execution. Known values are: "InProgress" and "Finished". (InProgress, Finished)
runStatusError	string	Well known Azure Storage error code that represents the error encountered during execution of the run instance.
startTime	string	Start time of the run instance. Filter options such as startTime gt '2023-06-26T20:51:24.4494016Z' and other comparison operators can be used as described for DateTime properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators _.
storageAccountId	string	Resource ID of the Storage Account where this reported run executed.
summaryReportPath	string	Full path to the verbose report stored in the reporting container as specified in the assignment execution context for the storage account.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
taskAssignmentId	string	Resource ID of the Storage Task Assignment associated with this reported run.
taskId	string	Resource ID of the Storage Task applied during this run.
taskVersion	string	Storage Task Version.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	resource_group_name, storage_task_name, subscription_id	$maxpagesize, $filter	Fetch the storage tasks run report summary for each assignment.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
storage_task_name	string	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.
subscription_id	string
$filter	string	Optional. When specified, it can be used to query using reporting properties. Default value is None.
$maxpagesize	integer

SELECT examples

list

Fetch the storage tasks run report summary for each assignment.

SELECT
id,
name,
finishTime,
objectFailedCount,
objectsOperatedOnCount,
objectsSucceededCount,
objectsTargetedCount,
runResult,
runStatusEnum,
runStatusError,
startTime,
storageAccountId,
summaryReportPath,
systemData,
taskAssignmentId,
taskId,
taskVersion,
type
FROM azure.storage_actions.storage_tasks_report
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND storage_task_name = '{{ storage_task_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $maxpagesize = '{{ $maxpagesize }}'
AND $filter = '{{ $filter }}'
;