Azure Storage Accounts · Schema
StorageTaskAssignment
The storage task assignment.
Microsoft AzureBlob StorageCloud StorageFile StorageQueue StorageStorageTable Storage
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
| name | string | The name of the resource |
| type | string | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
| systemData | object | Azure Resource Manager metadata containing createdBy and modifiedBy information. |
| properties | object | Properties of the storage task assignment. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/azure-storage-accounts/json-schema/azure-storage-accounts-storage-task-assignment-schema.json",
"title": "StorageTaskAssignment",
"description": "The storage task assignment.",
"x-generated": "2026-11-12",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/azure-storage-accounts-storagetaskassignments-api-openapi.yml#/components/schemas/StorageTaskAssignment",
"type": "object",
"properties": {
"properties": {
"$ref": "#/$defs/StorageTaskAssignmentProperties",
"description": "Properties of the storage task assignment."
}
},
"allOf": [
{
"$ref": "#/$defs/ProxyResource"
}
],
"$defs": {
"ExecutionTarget": {
"type": "object",
"description": "Target helps provide filter parameters for the objects in the storage account and forms the execution context for the storage task",
"properties": {
"prefix": {
"type": "array",
"description": "Required list of object prefixes to be included for task execution",
"items": {
"type": "string"
}
},
"excludePrefix": {
"type": "array",
"description": "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",
"items": {
"type": "string"
}
}
}
},
"ExecutionTrigger": {
"type": "object",
"description": "Execution trigger for storage task assignment",
"properties": {
"type": {
"$ref": "#/$defs/TriggerType",
"description": "The trigger type of the storage task assignment execution"
},
"parameters": {
"$ref": "#/$defs/TriggerParameters",
"description": "The trigger parameters of the storage task assignment execution"
}
},
"required": [
"type",
"parameters"
]
},
"IntervalUnit": {
"type": "string",
"description": "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'",
"enum": [
"Days"
],
"x-ms-enum": {
"name": "IntervalUnit",
"modelAsString": true,
"values": [
{
"name": "days",
"value": "Days"
}
]
}
},
"ProxyResource": {
"type": "object",
"title": "Proxy Resource",
"description": "The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location",
"allOf": [
{
"$ref": "#/$defs/Resource"
}
]
},
"Resource": {
"type": "object",
"title": "Resource",
"description": "Common fields that are returned in the response for all Azure Resource Manager resources",
"properties": {
"id": {
"type": "string",
"format": "arm-id",
"description": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\"",
"readOnly": true
},
"name": {
"type": "string",
"description": "The name of the resource",
"readOnly": true
},
"type": {
"type": "string",
"description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"",
"readOnly": true
},
"systemData": {
"$ref": "#/$defs/systemData",
"description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.",
"readOnly": true
}
},
"x-ms-azure-resource": true
},
"RunResult": {
"type": "string",
"description": "Represents the overall result of the execution for the run instance",
"enum": [
"Succeeded",
"Failed"
],
"x-ms-enum": {
"name": "RunResult",
"modelAsString": true,
"values": [
{
"name": "Succeeded",
"value": "Succeeded"
},
{
"name": "Failed",
"value": "Failed"
}
]
},
"readOnly": true
},
"RunStatusEnum": {
"type": "string",
"description": "Represents the status of the execution.",
"enum": [
"InProgress",
"Finished"
],
"x-ms-enum": {
"name": "RunStatusEnum",
"modelAsString": true,
"values": [
{
"name": "InProgress",
"value": "InProgress"
},
{
"name": "Finished",
"value": "Finished"
}
]
}
},
"StorageTaskAssignmentExecutionContext": {
"type": "object",
"description": "Execution context of the storage task assignment.",
"properties": {
"target": {
"$ref": "#/$defs/ExecutionTarget",
"description": "Execution target of the storage task assignment"
},
"trigger": {
"$ref": "#/$defs/ExecutionTrigger",
"description": "Execution trigger of the storage task assignment"
}
},
"required": [
"trigger"
]
},
"StorageTaskAssignmentProperties": {
"type": "object",
"description": "Properties of the storage task assignment.",
"properties": {
"taskId": {
"type": "string",
"format": "arm-id",
"description": "Id of the corresponding storage task"
},
"enabled": {
"type": "boolean",
"description": "Whether the storage task assignment is enabled or not"
},
"description": {
"type": "string",
"description": "Text that describes the purpose of the storage task assignment"
},
"executionContext": {
"$ref": "#/$defs/StorageTaskAssignmentExecutionContext",
"description": "The storage task assignment execution context"
},
"report": {
"$ref": "#/$defs/StorageTaskAssignmentReport",
"description": "The storage task assignment report"
},
"provisioningState": {
"$ref": "#/$defs/StorageTaskAssignmentProvisioningState",
"description": "Represents the provisioning state of the storage task assignment.",
"readOnly": true
},
"runStatus": {
"$ref": "#/$defs/StorageTaskReportProperties",
"description": "Run status of storage task assignment"
}
},
"required": [
"taskId",
"enabled",
"description",
"executionContext",
"report"
]
},
"StorageTaskAssignmentProvisioningState": {
"type": "string",
"description": "Gets the status of the storage account at the time the operation was called.",
"enum": [
"ValidateSubscriptionQuotaBegin",
"ValidateSubscriptionQuotaEnd",
"Accepted",
"Creating",
"Succeeded",
"Deleting",
"Canceled",
"Failed"
],
"x-ms-enum": {
"name": "StorageTaskAssignmentProvisioningState",
"modelAsString": true,
"values": [
{
"name": "ValidateSubscriptionQuotaBegin",
"value": "ValidateSubscriptionQuotaBegin"
},
{
"name": "ValidateSubscriptionQuotaEnd",
"value": "ValidateSubscriptionQuotaEnd"
},
{
"name": "Accepted",
"value": "Accepted"
},
{
"name": "Creating",
"value": "Creating"
},
{
"name": "Succeeded",
"value": "Succeeded"
},
{
"name": "Deleting",
"value": "Deleting"
},
{
"name": "Canceled",
"value": "Canceled"
},
{
"name": "Failed",
"value": "Failed"
}
]
},
"readOnly": true
},
"StorageTaskAssignmentReport": {
"type": "object",
"description": "The storage task assignment report",
"properties": {
"prefix": {
"type": "string",
"description": "The container prefix for the location of storage task assignment report"
}
},
"required": [
"prefix"
]
},
"StorageTaskReportProperties": {
"type": "object",
"description": "Storage task execution report for a run instance.",
"properties": {
"taskAssignmentId": {
"type": "string",
"format": "arm-id",
"description": "Represents the Storage Task Assignment Id associated with the storage task that provided an execution context.",
"readOnly": true,
"x-ms-arm-id-details": {
"allowedResources": [
{
"type": "Microsoft.Storage/storageAccounts/storageTaskAssignments"
}
]
}
},
"storageAccountId": {
"type": "string",
"format": "arm-id",
"description": "Represents the Storage Account Id where the storage task definition was applied and executed.",
"readOnly": true,
"x-ms-arm-id-details": {
"allowedResources": [
{
"type": "Microsoft.Storage/storageAccounts"
}
]
}
},
"startTime": {
"type": "string",
"description": "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",
"readOnly": true
},
"finishTime": {
"type": "string",
"description": "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",
"readOnly": true
},
"objectsTargetedCount": {
"type": "string",
"description": "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",
"readOnly": true
},
"objectsOperatedOnCount": {
"type": "string",
"description": "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",
"readOnly": true
},
"objectFailedCount": {
"type": "string",
"description": "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",
"readOnly": true
},
"objectsSucceededCount": {
"type": "string",
"description": "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",
"readOnly": true
},
"runStatusError": {
"type": "string",
"description": "Well known Azure Storage error code that represents the error encountered during execution of the run instance.",
"readOnly": true
},
"runStatusEnum": {
"$ref": "#/$defs/RunStatusEnum",
"description": "Represents the status of the execution.",
"readOnly": true
},
"summaryReportPath": {
"type": "string",
"description": "Full path to the verbose report stored in the reporting container as specified in the assignment execution context for the storage account.",
"readOnly": true
},
"taskId": {
"type": "string",
"format": "arm-id",
"description": "Storage Task Arm Id.",
"readOnly": true,
"x-ms-arm-id-details": {
"allowedResources": [
{
"type": "Microsoft.StorageActions/storageTasks"
}
]
}
},
"taskVersion": {
"type": "string",
"description": "Storage Task Version",
"readOnly": true
},
"runResult": {
"$ref": "#/$defs/RunResult",
"description": "Represents the overall result of the execution for the run instance",
"readOnly": true
}
}
},
"TriggerParameters": {
"type": "object",
"description": "The trigger parameters update for the storage task assignment execution",
"properties": {
"startFrom": {
"type": "string",
"format": "date-time",
"description": "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'"
},
"interval": {
"type": "integer",
"format": "int32",
"description": "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'",
"minimum": 1
},
"intervalUnit": {
"$ref": "#/$defs/IntervalUnit",
"description": "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'"
},
"endBy": {
"type": "string",
"format": "date-time",
"description": "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'"
},
"startOn": {
"type": "string",
"format": "date-time",
"description": "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'"
}
}
},
"TriggerType": {
"type": "string",
"description": "The trigger type of the storage task assignment execution",
"enum": [
"RunOnce",
"OnSchedule",
"MockRun"
],
"x-ms-enum": {
"name": "TriggerType",
"modelAsString": true,
"values": [
{
"name": "RunOnce",
"value": "RunOnce"
},
{
"name": "OnSchedule",
"value": "OnSchedule"
},
{
"name": "MockRun",
"value": "MockRun",
"description": "Run the task as a mock for testing"
}
]
}
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/azure-storage-accounts-storage-task-assignment"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.