Microsoft.Storage (stable:2023-05-01)

2025/03/31 • 4 updated methods

StorageTaskAssignments_Create (updated)
Description :  Asynchronously creates a new storage task assignment sub-resource with the specified parameters. If a storage task assignment is already created and a subsequent create request is issued with different properties, the storage task assignment properties will be updated. If a storage task assignment is already created and a subsequent create or update request is issued with the exact same set of properties, the request will succeed.
Reference :  Link ¶

⚶ Changes

{
  "#id": "StorageTaskAssignments_Create",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "ValidateSubscriptionQuotaBegin",
                  ""
                ],
                [
                  "ValidateSubscriptionQuotaEnd",
                  ""
                ],
                [
                  "Accepted",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Failed",
                  ""
                ]
              ],
              "old": [
                [
                  "ValidateSubscriptionQuotaBegin",
                  ""
                ],
                [
                  "ValidateSubscriptionQuotaEnd",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Failed",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "ValidateSubscriptionQuotaBegin",
                  ""
                ],
                [
                  "ValidateSubscriptionQuotaEnd",
                  ""
                ],
                [
                  "Accepted",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Failed",
                  ""
                ]
              ],
              "old": [
                [
                  "ValidateSubscriptionQuotaBegin",
                  ""
                ],
                [
                  "ValidateSubscriptionQuotaEnd",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Failed",
                  ""
                ]
              ]
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "ValidateSubscriptionQuotaBegin",
                  ""
                ],
                [
                  "ValidateSubscriptionQuotaEnd",
                  ""
                ],
                [
                  "Accepted",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Failed",
                  ""
                ]
              ],
              "old": [
                [
                  "ValidateSubscriptionQuotaBegin",
                  ""
                ],
                [
                  "ValidateSubscriptionQuotaEnd",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Failed",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/storageTaskAssignments/{storageTaskAssignmentName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. ,
Required: True ,
}
string ,
storageTaskAssignmentName:
{
Description: The name of the storage task assignment within the specified resource group. Storage task assignment names must be between 3 and 24 characters in length and use numbers and lower-case letters only. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to create a Storage Task Assignment. ,
Required: True ,
}
{
properties:
{
Description: Properties of the storage task assignment. ,
Required: True ,
}
{
taskId:
{
Description: Id of the corresponding storage task ,
Format: arm-id ,
Required: True ,
}
string ,
enabled:
{
Description: Whether the storage task assignment is enabled or not ,
Required: True ,
}
boolean ,
description:
{
Description: Text that describes the purpose of the storage task assignment ,
Required: True ,
}
string ,
executionContext:
{
Description: The storage task assignment execution context ,
Required: True ,
}
{
target:
{
Description: Execution target of the storage task assignment ,
Required: False ,
}
{
prefix:
{
Description: Required list of object prefixes to be included for task execution ,
Required: False ,
}
[
string ,
]
,
excludePrefix:
{
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 ,
Required: False ,
}
[
string ,
]
,
}
,
trigger:
{
Description: Execution trigger of the storage task assignment ,
Required: True ,
}
{
type:
{
Description: The trigger type of the storage task assignment execution ,
Enum:
{
RunOnce: No description available. ,
OnSchedule: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: The trigger parameters of the storage task assignment execution ,
Required: True ,
}
{
startFrom:
{
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' ,
Format: date-time ,
Required: False ,
}
string ,
interval:
{
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' ,
Format: int32 ,
Required: False ,
}
integer ,
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' ,
Enum:
{
Days: No description available. ,
}
,
Required: False ,
}
enum ,
endBy:
{
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' ,
Format: date-time ,
Required: False ,
}
string ,
startOn:
{
Description: When to start task execution. This is an optional field when ExecutionTrigger.properties.type is 'RunOnce'; this property should not be present when ExecutionTrigger.properties.type is 'OnSchedule' ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
report:
{
Description: The storage task assignment report ,
Required: True ,
}
{
prefix:
{
Description: The container prefix for the location of storage task assignment report ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: Represents the provisioning state of the storage task assignment. ,
Enum:
{
ValidateSubscriptionQuotaBegin: No description available. ,
ValidateSubscriptionQuotaEnd: No description available. ,
Accepted: No description available. ,
Creating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
runStatus:
{
Description: Run status of storage task assignment ,
Required: False ,
}
{
taskAssignmentId:
{
Description: Represents the Storage Task Assignment Id associated with the storage task that provided an execution context. ,
Format: arm-id ,
Required: False ,
}
string ,
storageAccountId:
{
Description: Represents the Storage Account Id where the storage task definition was applied and executed. ,
Format: arm-id ,
Required: False ,
}
string ,
startTime:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
finishTime:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsTargetedCount:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsOperatedOnCount:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectFailedCount:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsSucceededCount:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
runStatusError:
{
Description: Well known Azure Storage error code that represents the error encountered during execution of the run instance. ,
Required: False ,
}
string ,
runStatusEnum:
{
Description: Represents the status of the execution. ,
Enum:
{
InProgress: No description available. ,
Finished: No description available. ,
}
,
Required: False ,
}
enum ,
summaryReportPath:
{
Description: Full path to the verbose report stored in the reporting container as specified in the assignment execution context for the storage account. ,
Required: False ,
}
string ,
taskId:
{
Description: Storage Task Arm Id. ,
Format: arm-id ,
Required: False ,
}
string ,
taskVersion:
{
Description: Storage Task Version ,
Required: False ,
}
string ,
runResult:
{
Description: Represents the overall result of the execution for the run instance ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the storage task assignment. ,
Required: True ,
}
{
taskId:
{
Description: Id of the corresponding storage task ,
Format: arm-id ,
Required: True ,
}
string ,
enabled:
{
Description: Whether the storage task assignment is enabled or not ,
Required: True ,
}
boolean ,
description:
{
Description: Text that describes the purpose of the storage task assignment ,
Required: True ,
}
string ,
executionContext:
{
Description: The storage task assignment execution context ,
Required: True ,
}
{
target:
{
Description: Execution target of the storage task assignment ,
Required: False ,
}
{
prefix:
{
Description: Required list of object prefixes to be included for task execution ,
Required: False ,
}
[
string ,
]
,
excludePrefix:
{
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 ,
Required: False ,
}
[
string ,
]
,
}
,
trigger:
{
Description: Execution trigger of the storage task assignment ,
Required: True ,
}
{
type:
{
Description: The trigger type of the storage task assignment execution ,
Enum:
{
RunOnce: No description available. ,
OnSchedule: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: The trigger parameters of the storage task assignment execution ,
Required: True ,
}
{
startFrom:
{
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' ,
Format: date-time ,
Required: False ,
}
string ,
interval:
{
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' ,
Format: int32 ,
Required: False ,
}
integer ,
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' ,
Enum:
{
Days: No description available. ,
}
,
Required: False ,
}
enum ,
endBy:
{
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' ,
Format: date-time ,
Required: False ,
}
string ,
startOn:
{
Description: When to start task execution. This is an optional field when ExecutionTrigger.properties.type is 'RunOnce'; this property should not be present when ExecutionTrigger.properties.type is 'OnSchedule' ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
report:
{
Description: The storage task assignment report ,
Required: True ,
}
{
prefix:
{
Description: The container prefix for the location of storage task assignment report ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: Represents the provisioning state of the storage task assignment. ,
Enum:
{
ValidateSubscriptionQuotaBegin: No description available. ,
ValidateSubscriptionQuotaEnd: No description available. ,
Accepted: No description available. ,
Creating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
runStatus:
{
Description: Run status of storage task assignment ,
Required: False ,
}
{
taskAssignmentId:
{
Description: Represents the Storage Task Assignment Id associated with the storage task that provided an execution context. ,
Format: arm-id ,
Required: False ,
}
string ,
storageAccountId:
{
Description: Represents the Storage Account Id where the storage task definition was applied and executed. ,
Format: arm-id ,
Required: False ,
}
string ,
startTime:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
finishTime:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsTargetedCount:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsOperatedOnCount:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectFailedCount:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsSucceededCount:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
runStatusError:
{
Description: Well known Azure Storage error code that represents the error encountered during execution of the run instance. ,
Required: False ,
}
string ,
runStatusEnum:
{
Description: Represents the status of the execution. ,
Enum:
{
InProgress: No description available. ,
Finished: No description available. ,
}
,
Required: False ,
}
enum ,
summaryReportPath:
{
Description: Full path to the verbose report stored in the reporting container as specified in the assignment execution context for the storage account. ,
Required: False ,
}
string ,
taskId:
{
Description: Storage Task Arm Id. ,
Format: arm-id ,
Required: False ,
}
string ,
taskVersion:
{
Description: Storage Task Version ,
Required: False ,
}
string ,
runResult:
{
Description: Represents the overall result of the execution for the run instance ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the storage task assignment. ,
Required: True ,
}
{
taskId:
{
Description: Id of the corresponding storage task ,
Format: arm-id ,
Required: True ,
}
string ,
enabled:
{
Description: Whether the storage task assignment is enabled or not ,
Required: True ,
}
boolean ,
description:
{
Description: Text that describes the purpose of the storage task assignment ,
Required: True ,
}
string ,
executionContext:
{
Description: The storage task assignment execution context ,
Required: True ,
}
{
target:
{
Description: Execution target of the storage task assignment ,
Required: False ,
}
{
prefix:
{
Description: Required list of object prefixes to be included for task execution ,
Required: False ,
}
[
string ,
]
,
excludePrefix:
{
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 ,
Required: False ,
}
[
string ,
]
,
}
,
trigger:
{
Description: Execution trigger of the storage task assignment ,
Required: True ,
}
{
type:
{
Description: The trigger type of the storage task assignment execution ,
Enum:
{
RunOnce: No description available. ,
OnSchedule: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: The trigger parameters of the storage task assignment execution ,
Required: True ,
}
{
startFrom:
{
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' ,
Format: date-time ,
Required: False ,
}
string ,
interval:
{
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' ,
Format: int32 ,
Required: False ,
}
integer ,
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' ,
Enum:
{
Days: No description available. ,
}
,
Required: False ,
}
enum ,
endBy:
{
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' ,
Format: date-time ,
Required: False ,
}
string ,
startOn:
{
Description: When to start task execution. This is an optional field when ExecutionTrigger.properties.type is 'RunOnce'; this property should not be present when ExecutionTrigger.properties.type is 'OnSchedule' ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
report:
{
Description: The storage task assignment report ,
Required: True ,
}
{
prefix:
{
Description: The container prefix for the location of storage task assignment report ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: Represents the provisioning state of the storage task assignment. ,
Enum:
{
ValidateSubscriptionQuotaBegin: No description available. ,
ValidateSubscriptionQuotaEnd: No description available. ,
Accepted: No description available. ,
Creating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
runStatus:
{
Description: Run status of storage task assignment ,
Required: False ,
}
{
taskAssignmentId:
{
Description: Represents the Storage Task Assignment Id associated with the storage task that provided an execution context. ,
Format: arm-id ,
Required: False ,
}
string ,
storageAccountId:
{
Description: Represents the Storage Account Id where the storage task definition was applied and executed. ,
Format: arm-id ,
Required: False ,
}
string ,
startTime:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
finishTime:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsTargetedCount:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsOperatedOnCount:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectFailedCount:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsSucceededCount:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
runStatusError:
{
Description: Well known Azure Storage error code that represents the error encountered during execution of the run instance. ,
Required: False ,
}
string ,
runStatusEnum:
{
Description: Represents the status of the execution. ,
Enum:
{
InProgress: No description available. ,
Finished: No description available. ,
}
,
Required: False ,
}
enum ,
summaryReportPath:
{
Description: Full path to the verbose report stored in the reporting container as specified in the assignment execution context for the storage account. ,
Required: False ,
}
string ,
taskId:
{
Description: Storage Task Arm Id. ,
Format: arm-id ,
Required: False ,
}
string ,
taskVersion:
{
Description: Storage Task Version ,
Required: False ,
}
string ,
runResult:
{
Description: Represents the overall result of the execution for the run instance ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StorageTaskAssignments_Update (updated)
Description :  Update storage task assignment properties
Reference :  Link ¶

⚶ Changes

{
  "#id": "StorageTaskAssignments_Update",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "ValidateSubscriptionQuotaBegin",
                  ""
                ],
                [
                  "ValidateSubscriptionQuotaEnd",
                  ""
                ],
                [
                  "Accepted",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Failed",
                  ""
                ]
              ],
              "old": [
                [
                  "ValidateSubscriptionQuotaBegin",
                  ""
                ],
                [
                  "ValidateSubscriptionQuotaEnd",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Failed",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "ValidateSubscriptionQuotaBegin",
                  ""
                ],
                [
                  "ValidateSubscriptionQuotaEnd",
                  ""
                ],
                [
                  "Accepted",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Failed",
                  ""
                ]
              ],
              "old": [
                [
                  "ValidateSubscriptionQuotaBegin",
                  ""
                ],
                [
                  "ValidateSubscriptionQuotaEnd",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Failed",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/storageTaskAssignments/{storageTaskAssignmentName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. ,
Required: True ,
}
string ,
storageTaskAssignmentName:
{
Description: The name of the storage task assignment within the specified resource group. Storage task assignment names must be between 3 and 24 characters in length and use numbers and lower-case letters only. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to update a Storage Task Assignment. ,
Required: True ,
}
{
properties:
{
Description: Properties of the storage task assignment. ,
Required: False ,
}
{
taskId:
{
Description: Id of the corresponding storage task ,
Required: False ,
}
string ,
enabled:
{
Description: Whether the storage task assignment is enabled or not ,
Required: False ,
}
boolean ,
description:
{
Description: Text that describes the purpose of the storage task assignment ,
Required: False ,
}
string ,
executionContext:
{
Description: The storage task assignment execution context ,
Required: False ,
}
{
target:
{
Description: Execution target of the storage task assignment ,
Required: False ,
}
{
prefix:
{
Description: Required list of object prefixes to be included for task execution ,
Required: False ,
}
[
string ,
]
,
excludePrefix:
{
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 ,
Required: False ,
}
[
string ,
]
,
}
,
trigger:
{
Description: Execution trigger of the storage task assignment ,
Required: False ,
}
{
type:
{
Description: The trigger type of the storage task assignment execution ,
Enum:
{
RunOnce: No description available. ,
OnSchedule: No description available. ,
}
,
Required: False ,
}
enum ,
parameters:
{
Description: The trigger parameters of the storage task assignment execution ,
Required: False ,
}
{
startFrom:
{
Description: When to start task execution. This is a mutable field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' ,
Format: date-time ,
Required: False ,
}
string ,
interval:
{
Description: Run interval of task execution. This is a mutable field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' ,
Format: int32 ,
Required: False ,
}
integer ,
intervalUnit:
{
Description: Run interval unit of task execution. This is a mutable field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' ,
Enum:
{
Days: No description available. ,
}
,
Required: False ,
}
enum ,
endBy:
{
Description: When to end task execution. This is a mutable field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' ,
Format: date-time ,
Required: False ,
}
string ,
startOn:
{
Description: When to start task execution. This is a mutable field when ExecutionTrigger.properties.type is 'RunOnce'; this property should not be present when ExecutionTrigger.properties.type is 'OnSchedule' ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
report:
{
Description: The storage task assignment report ,
Required: False ,
}
{
prefix:
{
Description: The prefix of the storage task assignment report ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Represents the provisioning state of the storage task assignment. ,
Enum:
{
ValidateSubscriptionQuotaBegin: No description available. ,
ValidateSubscriptionQuotaEnd: No description available. ,
Accepted: No description available. ,
Creating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
runStatus:
{
Description: Run status of storage task assignment ,
Required: False ,
}
{
taskAssignmentId:
{
Description: Represents the Storage Task Assignment Id associated with the storage task that provided an execution context. ,
Format: arm-id ,
Required: False ,
}
string ,
storageAccountId:
{
Description: Represents the Storage Account Id where the storage task definition was applied and executed. ,
Format: arm-id ,
Required: False ,
}
string ,
startTime:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
finishTime:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsTargetedCount:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsOperatedOnCount:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectFailedCount:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsSucceededCount:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
runStatusError:
{
Description: Well known Azure Storage error code that represents the error encountered during execution of the run instance. ,
Required: False ,
}
string ,
runStatusEnum:
{
Description: Represents the status of the execution. ,
Enum:
{
InProgress: No description available. ,
Finished: No description available. ,
}
,
Required: False ,
}
enum ,
summaryReportPath:
{
Description: Full path to the verbose report stored in the reporting container as specified in the assignment execution context for the storage account. ,
Required: False ,
}
string ,
taskId:
{
Description: Storage Task Arm Id. ,
Format: arm-id ,
Required: False ,
}
string ,
taskVersion:
{
Description: Storage Task Version ,
Required: False ,
}
string ,
runResult:
{
Description: Represents the overall result of the execution for the run instance ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the storage task assignment. ,
Required: True ,
}
{
taskId:
{
Description: Id of the corresponding storage task ,
Format: arm-id ,
Required: True ,
}
string ,
enabled:
{
Description: Whether the storage task assignment is enabled or not ,
Required: True ,
}
boolean ,
description:
{
Description: Text that describes the purpose of the storage task assignment ,
Required: True ,
}
string ,
executionContext:
{
Description: The storage task assignment execution context ,
Required: True ,
}
{
target:
{
Description: Execution target of the storage task assignment ,
Required: False ,
}
{
prefix:
{
Description: Required list of object prefixes to be included for task execution ,
Required: False ,
}
[
string ,
]
,
excludePrefix:
{
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 ,
Required: False ,
}
[
string ,
]
,
}
,
trigger:
{
Description: Execution trigger of the storage task assignment ,
Required: True ,
}
{
type:
{
Description: The trigger type of the storage task assignment execution ,
Enum:
{
RunOnce: No description available. ,
OnSchedule: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: The trigger parameters of the storage task assignment execution ,
Required: True ,
}
{
startFrom:
{
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' ,
Format: date-time ,
Required: False ,
}
string ,
interval:
{
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' ,
Format: int32 ,
Required: False ,
}
integer ,
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' ,
Enum:
{
Days: No description available. ,
}
,
Required: False ,
}
enum ,
endBy:
{
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' ,
Format: date-time ,
Required: False ,
}
string ,
startOn:
{
Description: When to start task execution. This is an optional field when ExecutionTrigger.properties.type is 'RunOnce'; this property should not be present when ExecutionTrigger.properties.type is 'OnSchedule' ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
report:
{
Description: The storage task assignment report ,
Required: True ,
}
{
prefix:
{
Description: The container prefix for the location of storage task assignment report ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: Represents the provisioning state of the storage task assignment. ,
Enum:
{
ValidateSubscriptionQuotaBegin: No description available. ,
ValidateSubscriptionQuotaEnd: No description available. ,
Accepted: No description available. ,
Creating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
runStatus:
{
Description: Run status of storage task assignment ,
Required: False ,
}
{
taskAssignmentId:
{
Description: Represents the Storage Task Assignment Id associated with the storage task that provided an execution context. ,
Format: arm-id ,
Required: False ,
}
string ,
storageAccountId:
{
Description: Represents the Storage Account Id where the storage task definition was applied and executed. ,
Format: arm-id ,
Required: False ,
}
string ,
startTime:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
finishTime:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsTargetedCount:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsOperatedOnCount:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectFailedCount:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsSucceededCount:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
runStatusError:
{
Description: Well known Azure Storage error code that represents the error encountered during execution of the run instance. ,
Required: False ,
}
string ,
runStatusEnum:
{
Description: Represents the status of the execution. ,
Enum:
{
InProgress: No description available. ,
Finished: No description available. ,
}
,
Required: False ,
}
enum ,
summaryReportPath:
{
Description: Full path to the verbose report stored in the reporting container as specified in the assignment execution context for the storage account. ,
Required: False ,
}
string ,
taskId:
{
Description: Storage Task Arm Id. ,
Format: arm-id ,
Required: False ,
}
string ,
taskVersion:
{
Description: Storage Task Version ,
Required: False ,
}
string ,
runResult:
{
Description: Represents the overall result of the execution for the run instance ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StorageTaskAssignments_Get (updated)
Description :  Get the storage task assignment properties
Reference :  Link ¶

⚶ Changes

{
  "#id": "StorageTaskAssignments_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "ValidateSubscriptionQuotaBegin",
                  ""
                ],
                [
                  "ValidateSubscriptionQuotaEnd",
                  ""
                ],
                [
                  "Accepted",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Failed",
                  ""
                ]
              ],
              "old": [
                [
                  "ValidateSubscriptionQuotaBegin",
                  ""
                ],
                [
                  "ValidateSubscriptionQuotaEnd",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Failed",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/storageTaskAssignments/{storageTaskAssignmentName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. ,
Required: True ,
}
string ,
storageTaskAssignmentName:
{
Description: The name of the storage task assignment within the specified resource group. Storage task assignment names must be between 3 and 24 characters in length and use numbers and lower-case letters only. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the storage task assignment. ,
Required: True ,
}
{
taskId:
{
Description: Id of the corresponding storage task ,
Format: arm-id ,
Required: True ,
}
string ,
enabled:
{
Description: Whether the storage task assignment is enabled or not ,
Required: True ,
}
boolean ,
description:
{
Description: Text that describes the purpose of the storage task assignment ,
Required: True ,
}
string ,
executionContext:
{
Description: The storage task assignment execution context ,
Required: True ,
}
{
target:
{
Description: Execution target of the storage task assignment ,
Required: False ,
}
{
prefix:
{
Description: Required list of object prefixes to be included for task execution ,
Required: False ,
}
[
string ,
]
,
excludePrefix:
{
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 ,
Required: False ,
}
[
string ,
]
,
}
,
trigger:
{
Description: Execution trigger of the storage task assignment ,
Required: True ,
}
{
type:
{
Description: The trigger type of the storage task assignment execution ,
Enum:
{
RunOnce: No description available. ,
OnSchedule: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: The trigger parameters of the storage task assignment execution ,
Required: True ,
}
{
startFrom:
{
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' ,
Format: date-time ,
Required: False ,
}
string ,
interval:
{
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' ,
Format: int32 ,
Required: False ,
}
integer ,
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' ,
Enum:
{
Days: No description available. ,
}
,
Required: False ,
}
enum ,
endBy:
{
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' ,
Format: date-time ,
Required: False ,
}
string ,
startOn:
{
Description: When to start task execution. This is an optional field when ExecutionTrigger.properties.type is 'RunOnce'; this property should not be present when ExecutionTrigger.properties.type is 'OnSchedule' ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
report:
{
Description: The storage task assignment report ,
Required: True ,
}
{
prefix:
{
Description: The container prefix for the location of storage task assignment report ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: Represents the provisioning state of the storage task assignment. ,
Enum:
{
ValidateSubscriptionQuotaBegin: No description available. ,
ValidateSubscriptionQuotaEnd: No description available. ,
Accepted: No description available. ,
Creating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
runStatus:
{
Description: Run status of storage task assignment ,
Required: False ,
}
{
taskAssignmentId:
{
Description: Represents the Storage Task Assignment Id associated with the storage task that provided an execution context. ,
Format: arm-id ,
Required: False ,
}
string ,
storageAccountId:
{
Description: Represents the Storage Account Id where the storage task definition was applied and executed. ,
Format: arm-id ,
Required: False ,
}
string ,
startTime:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
finishTime:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsTargetedCount:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsOperatedOnCount:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectFailedCount:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsSucceededCount:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
runStatusError:
{
Description: Well known Azure Storage error code that represents the error encountered during execution of the run instance. ,
Required: False ,
}
string ,
runStatusEnum:
{
Description: Represents the status of the execution. ,
Enum:
{
InProgress: No description available. ,
Finished: No description available. ,
}
,
Required: False ,
}
enum ,
summaryReportPath:
{
Description: Full path to the verbose report stored in the reporting container as specified in the assignment execution context for the storage account. ,
Required: False ,
}
string ,
taskId:
{
Description: Storage Task Arm Id. ,
Format: arm-id ,
Required: False ,
}
string ,
taskVersion:
{
Description: Storage Task Version ,
Required: False ,
}
string ,
runResult:
{
Description: Represents the overall result of the execution for the run instance ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StorageTaskAssignments_List (updated)
Description :  List all the storage task assignments in an account
Reference :  Link ¶

⚶ Changes

{
  "#id": "StorageTaskAssignments_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "provisioningState",
                "Enum": {
                  "new": [
                    [
                      "ValidateSubscriptionQuotaBegin",
                      ""
                    ],
                    [
                      "ValidateSubscriptionQuotaEnd",
                      ""
                    ],
                    [
                      "Accepted",
                      ""
                    ],
                    [
                      "Creating",
                      ""
                    ],
                    [
                      "Succeeded",
                      ""
                    ],
                    [
                      "Deleting",
                      ""
                    ],
                    [
                      "Canceled",
                      ""
                    ],
                    [
                      "Failed",
                      ""
                    ]
                  ],
                  "old": [
                    [
                      "ValidateSubscriptionQuotaBegin",
                      ""
                    ],
                    [
                      "ValidateSubscriptionQuotaEnd",
                      ""
                    ],
                    [
                      "Creating",
                      ""
                    ],
                    [
                      "Succeeded",
                      ""
                    ],
                    [
                      "Deleting",
                      ""
                    ],
                    [
                      "Canceled",
                      ""
                    ],
                    [
                      "Failed",
                      ""
                    ]
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/storageTaskAssignments
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. ,
Required: True ,
}
string ,
$maxpagesize:
{
Description: Optional, specifies the maximum number of storage task assignment Ids to be included in the list response. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets the list of storage task assignments and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the storage task assignment. ,
Required: True ,
}
{
taskId:
{
Description: Id of the corresponding storage task ,
Format: arm-id ,
Required: True ,
}
string ,
enabled:
{
Description: Whether the storage task assignment is enabled or not ,
Required: True ,
}
boolean ,
description:
{
Description: Text that describes the purpose of the storage task assignment ,
Required: True ,
}
string ,
executionContext:
{
Description: The storage task assignment execution context ,
Required: True ,
}
{
target:
{
Description: Execution target of the storage task assignment ,
Required: False ,
}
{
prefix:
{
Description: Required list of object prefixes to be included for task execution ,
Required: False ,
}
[
string ,
]
,
excludePrefix:
{
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 ,
Required: False ,
}
[
string ,
]
,
}
,
trigger:
{
Description: Execution trigger of the storage task assignment ,
Required: True ,
}
{
type:
{
Description: The trigger type of the storage task assignment execution ,
Enum:
{
RunOnce: No description available. ,
OnSchedule: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: The trigger parameters of the storage task assignment execution ,
Required: True ,
}
{
startFrom:
{
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' ,
Format: date-time ,
Required: False ,
}
string ,
interval:
{
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' ,
Format: int32 ,
Required: False ,
}
integer ,
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' ,
Enum:
{
Days: No description available. ,
}
,
Required: False ,
}
enum ,
endBy:
{
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' ,
Format: date-time ,
Required: False ,
}
string ,
startOn:
{
Description: When to start task execution. This is an optional field when ExecutionTrigger.properties.type is 'RunOnce'; this property should not be present when ExecutionTrigger.properties.type is 'OnSchedule' ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
report:
{
Description: The storage task assignment report ,
Required: True ,
}
{
prefix:
{
Description: The container prefix for the location of storage task assignment report ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: Represents the provisioning state of the storage task assignment. ,
Enum:
{
ValidateSubscriptionQuotaBegin: No description available. ,
ValidateSubscriptionQuotaEnd: No description available. ,
Accepted: No description available. ,
Creating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
runStatus:
{
Description: Run status of storage task assignment ,
Required: False ,
}
{
taskAssignmentId:
{
Description: Represents the Storage Task Assignment Id associated with the storage task that provided an execution context. ,
Format: arm-id ,
Required: False ,
}
string ,
storageAccountId:
{
Description: Represents the Storage Account Id where the storage task definition was applied and executed. ,
Format: arm-id ,
Required: False ,
}
string ,
startTime:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
finishTime:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsTargetedCount:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsOperatedOnCount:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectFailedCount:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsSucceededCount:
{
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/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
runStatusError:
{
Description: Well known Azure Storage error code that represents the error encountered during execution of the run instance. ,
Required: False ,
}
string ,
runStatusEnum:
{
Description: Represents the status of the execution. ,
Enum:
{
InProgress: No description available. ,
Finished: No description available. ,
}
,
Required: False ,
}
enum ,
summaryReportPath:
{
Description: Full path to the verbose report stored in the reporting container as specified in the assignment execution context for the storage account. ,
Required: False ,
}
string ,
taskId:
{
Description: Storage Task Arm Id. ,
Format: arm-id ,
Required: False ,
}
string ,
taskVersion:
{
Description: Storage Task Version ,
Required: False ,
}
string ,
runResult:
{
Description: Represents the overall result of the execution for the run instance ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Request URL that can be used to query next page of storage task assignments. Returned when total number of requested storage task assignments exceed maximum page size. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}