IStorageTaskAssignment Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.StorageTaskAssignmentTypeConverter))]
public interface IStorageTaskAssignment : Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.IResource[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.StorageTaskAssignmentTypeConverter))>]
type IStorageTaskAssignment = interface
interface IJsonSerializable
interface IResourcePublic Interface IStorageTaskAssignment
Implements IResource- Derived
- Attributes
- Implements
Properties
| Description |
Text that describes the purpose of the storage task assignment |
| Enabled |
Whether the storage task assignment is enabled or not |
| EndBy |
When to end task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' |
| Id |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} (Inherited from IResource) |
| Interval |
Run interval of task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' |
| IntervalUnit |
Run interval unit of task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' |
| Name |
The name of the resource (Inherited from IResource) |
| ProvisioningState |
Represents the provisioning state of the storage task assignment. |
| ReportPrefix |
The container prefix for the location of storage task assignment report |
| RunStatusEnum |
Represents the status of the execution. |
| RunStatusError |
Well known Azure Storage error code that represents the error encountered during execution of the run instance. |
| RunStatusFinishTime |
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/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators |
| RunStatusObjectFailedCount |
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/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators |
| RunStatusObjectsOperatedOnCount |
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/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators |
| RunStatusObjectsSucceededCount |
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/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators |
| RunStatusObjectsTargetedCount |
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/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators |
| RunStatusRunResult |
Represents the overall result of the execution for the run instance |
| RunStatusStartTime |
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/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators |
| RunStatusStorageAccountId |
Represents the Storage Account Id where the storage task definition was applied and executed. |
| RunStatusSummaryReportPath |
Full path to the verbose report stored in the reporting container as specified in the assignment execution context for the storage account. |
| RunStatusTaskAssignmentId |
Represents the Storage Task Assignment Id associated with the storage task that provided an execution context. |
| RunStatusTaskId |
Storage Task Arm Id. |
| RunStatusTaskVersion |
Storage Task Version |
| StartFrom |
When to start task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' |
| StartOn |
When to start task execution. This is a required field when ExecutionTrigger.properties.type is 'RunOnce'; this property should not be present when ExecutionTrigger.properties.type is 'OnSchedule' |
| TargetExcludePrefix |
List of object prefixes to be excluded from task execution. If there is a conflict between include and exclude prefixes, the exclude prefix will be the determining factor |
| TargetPrefix |
Required list of object prefixes to be included for task execution |
| TaskId |
Id of the corresponding storage task |
| TriggerType |
The trigger type of the storage task assignment execution |
| Type |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" (Inherited from IResource) |
Methods
| ToJson(JsonObject, SerializationMode) | (Inherited from IJsonSerializable) |