Microsoft.Storage (stable:2024-01-01)

2025/03/03 • 9 updated methods

StorageAccounts_Failover (updated)
Description :  A failover request can be triggered for a storage account in the event a primary endpoint becomes unavailable for any reason. The failover occurs from the storage account's primary cluster to the secondary cluster for RA-GRS accounts. The secondary cluster will become primary after failover and the account is converted to LRS. In the case of a Planned Failover, the primary and secondary clusters are swapped after failover and the account remains geo-replicated. Failover should continue to be used in the event of availability issues as Planned failover is only available while the primary and secondary endpoints are available. The primary use case of a Planned Failover is disaster recovery testing drills. This type of failover is invoked by setting FailoverType parameter to 'Planned'. Learn more about the failover options here- https://learn.microsoft.com/azure/storage/common/storage-disaster-recovery-guidance
Reference :  Link ¶

⚶ Changes

{
  "#id": "StorageAccounts_Failover",
  "Description": {
    "new": "A failover request can be triggered for a storage account in the event a primary endpoint becomes unavailable for any reason. The failover occurs from the storage account's primary cluster to the secondary cluster for RA-GRS accounts. The secondary cluster will become primary after failover and the account is converted to LRS. In the case of a Planned Failover, the primary and secondary clusters are swapped after failover and the account remains geo-replicated. Failover should continue to be used in the event of availability issues as Planned failover is only available while the primary and secondary endpoints are available. The primary use case of a Planned Failover is disaster recovery testing drills. This type of failover is invoked by setting FailoverType parameter to 'Planned'. Learn more about the failover options here- https://learn.microsoft.com/azure/storage/common/storage-disaster-recovery-guidance",
    "old": "A failover request can be triggered for a storage account in the event a primary endpoint becomes unavailable for any reason. The failover occurs from the storage account's primary cluster to the secondary cluster for RA-GRS accounts. The secondary cluster will become primary after failover and the account is converted to LRS. In the case of a Planned Failover, the primary and secondary clusters are swapped after failover and the account remains geo-replicated. Failover should continue to be used in the event of availability issues as Planned failover is only available while the primary and secondary endpoints are available. The primary use case of a Planned Failover is disaster recovery testing drills. This type of failover is invoked by setting FailoverType parameter to 'Planned'. Learn more about the failover options here- https://learn.microsoft.com/en-us/azure/storage/common/storage-disaster-recovery-guidance"
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/failover
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. 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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
failoverType:
{
Description: The parameter is set to 'Planned' to indicate whether a Planned failover is requested. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
ManagementPolicies_Get (updated)
Description :  Gets the managementpolicy associated with the specified storage account.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ManagementPolicies_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "policy",
            "Description": {
              "new": "The Storage Account ManagementPolicy, in JSON format. See more details in: https://learn.microsoft.com/azure/storage/blobs/lifecycle-management-overview.",
              "old": "The Storage Account ManagementPolicy, in JSON format. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts."
            },
            "$properties": [
              {
                "#name": "rules",
                "Description": {
                  "new": "The Storage Account ManagementPolicies Rules. See more details in: https://learn.microsoft.com/azure/storage/blobs/lifecycle-management-overview.",
                  "old": "The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/managementPolicies/{managementPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. 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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
managementPolicyName:
{
Description: The name of the Storage Account Management Policy. It should always be 'default' ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Returns the Storage Account Data Policies Rules. ,
Required: False ,
}
{
lastModifiedTime:
{
Description: Returns the date and time the ManagementPolicies was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
policy:
{
Description: The Storage Account ManagementPolicy, in JSON format. See more details in: https://learn.microsoft.com/azure/storage/blobs/lifecycle-management-overview. ,
Required: True ,
}
{
rules:
{
Description: The Storage Account ManagementPolicies Rules. See more details in: https://learn.microsoft.com/azure/storage/blobs/lifecycle-management-overview. ,
Required: True ,
}
[
{
enabled:
{
Description: Rule is enabled if set to true. ,
Required: False ,
}
boolean ,
name:
{
Description: A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. ,
Required: True ,
}
string ,
type:
{
Description: The valid value is Lifecycle ,
Enum:
{
Lifecycle: No description available. ,
}
,
Required: True ,
}
enum ,
definition:
{
Description: An object that defines the Lifecycle rule. ,
Required: True ,
}
{
actions:
{
Description: An object that defines the action set. ,
Required: True ,
}
{
baseBlob:
{
Description: The management policy action for base blob ,
Required: False ,
}
{
tierToCool:
{
Description: The function to tier blobs to cool storage. ,
Required: False ,
}
{
daysAfterModificationGreaterThan:
{
Description: Value indicating the age in days after last modification ,
Required: False ,
}
number ,
daysAfterLastAccessTimeGreaterThan:
{
Description: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy ,
Required: False ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after blob creation. ,
Required: False ,
}
number ,
}
,
tierToArchive:
{
Description: The function to tier blobs to archive storage. ,
Required: False ,
}
{
daysAfterModificationGreaterThan:
{
Description: Value indicating the age in days after last modification ,
Required: False ,
}
number ,
daysAfterLastAccessTimeGreaterThan:
{
Description: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy ,
Required: False ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after blob creation. ,
Required: False ,
}
number ,
}
,
tierToCold:
{
Description: The function to tier blobs to cold storage. ,
Required: False ,
}
{
daysAfterModificationGreaterThan:
{
Description: Value indicating the age in days after last modification ,
Required: False ,
}
number ,
daysAfterLastAccessTimeGreaterThan:
{
Description: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy ,
Required: False ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after blob creation. ,
Required: False ,
}
number ,
}
,
tierToHot:
{
Description: The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts ,
Required: False ,
}
{
daysAfterModificationGreaterThan:
{
Description: Value indicating the age in days after last modification ,
Required: False ,
}
number ,
daysAfterLastAccessTimeGreaterThan:
{
Description: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy ,
Required: False ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after blob creation. ,
Required: False ,
}
number ,
}
,
delete:
{
Description: The function to delete the blob ,
Required: False ,
}
{
daysAfterModificationGreaterThan:
{
Description: Value indicating the age in days after last modification ,
Required: False ,
}
number ,
daysAfterLastAccessTimeGreaterThan:
{
Description: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy ,
Required: False ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after blob creation. ,
Required: False ,
}
number ,
}
,
enableAutoTierToHotFromCool:
{
Description: This property enables auto tiering of a blob from cool to hot on a blob access. This property requires tierToCool.daysAfterLastAccessTimeGreaterThan. ,
Required: False ,
}
boolean ,
}
,
snapshot:
{
Description: The management policy action for snapshot ,
Required: False ,
}
{
tierToCool:
{
Description: The function to tier blob snapshot to cool storage. ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
tierToArchive:
{
Description: The function to tier blob snapshot to archive storage. ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
tierToCold:
{
Description: The function to tier blobs to cold storage. ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
tierToHot:
{
Description: The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
delete:
{
Description: The function to delete the blob snapshot ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
}
,
version:
{
Description: The management policy action for version ,
Required: False ,
}
{
tierToCool:
{
Description: The function to tier blob version to cool storage. ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
tierToArchive:
{
Description: The function to tier blob version to archive storage. ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
tierToCold:
{
Description: The function to tier blobs to cold storage. ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
tierToHot:
{
Description: The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
delete:
{
Description: The function to delete the blob version ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
}
,
}
,
filters:
{
Description: An object that defines the filter set. ,
Required: False ,
}
{
prefixMatch:
{
Description: An array of strings for prefixes to be match. ,
Required: False ,
}
[
string ,
]
,
blobTypes:
{
Description: An array of predefined enum values. Currently blockBlob supports all tiering and delete actions. Only delete actions are supported for appendBlob. ,
Required: True ,
}
[
string ,
]
,
blobIndexMatch:
{
Description: An array of blob index tag based filters, there can be at most 10 tag filters ,
Required: False ,
}
[
{
name:
{
Description: This is the filter tag name, it can have 1 - 128 characters ,
Required: True ,
}
string ,
op:
{
Description: This is the comparison operator which is used for object comparison and filtering. Only == (equality operator) is currently supported ,
Required: True ,
}
string ,
value:
{
Description: This is the filter tag value field used for tag based filtering, it can have 0 - 256 characters ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
}
,
}
,
}
ManagementPolicies_CreateOrUpdate (updated)
Description :  Sets the managementpolicy to the specified storage account.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ManagementPolicies_CreateOrUpdate",
  "$parameters": {
    "properties": {
      "$properties": {
        "properties": [
          {
            "#name": "policy",
            "Description": {
              "new": "The Storage Account ManagementPolicy, in JSON format. See more details in: https://learn.microsoft.com/azure/storage/blobs/lifecycle-management-overview.",
              "old": "The Storage Account ManagementPolicy, in JSON format. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts."
            },
            "$properties": [
              {
                "#name": "rules",
                "Description": {
                  "new": "The Storage Account ManagementPolicies Rules. See more details in: https://learn.microsoft.com/azure/storage/blobs/lifecycle-management-overview.",
                  "old": "The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts."
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "policy",
            "Description": {
              "new": "The Storage Account ManagementPolicy, in JSON format. See more details in: https://learn.microsoft.com/azure/storage/blobs/lifecycle-management-overview.",
              "old": "The Storage Account ManagementPolicy, in JSON format. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts."
            },
            "$properties": [
              {
                "#name": "rules",
                "Description": {
                  "new": "The Storage Account ManagementPolicies Rules. See more details in: https://learn.microsoft.com/azure/storage/blobs/lifecycle-management-overview.",
                  "old": "The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/managementPolicies/{managementPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. 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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
managementPolicyName:
{
Description: The name of the Storage Account Management Policy. It should always be 'default' ,
Required: True ,
}
string ,
properties:
{
Description: The ManagementPolicy set to a storage account. ,
Required: True ,
}
{
properties:
{
Description: Returns the Storage Account Data Policies Rules. ,
Required: False ,
}
{
lastModifiedTime:
{
Description: Returns the date and time the ManagementPolicies was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
policy:
{
Description: The Storage Account ManagementPolicy, in JSON format. See more details in: https://learn.microsoft.com/azure/storage/blobs/lifecycle-management-overview. ,
Required: True ,
}
{
rules:
{
Description: The Storage Account ManagementPolicies Rules. See more details in: https://learn.microsoft.com/azure/storage/blobs/lifecycle-management-overview. ,
Required: True ,
}
[
{
enabled:
{
Description: Rule is enabled if set to true. ,
Required: False ,
}
boolean ,
name:
{
Description: A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. ,
Required: True ,
}
string ,
type:
{
Description: The valid value is Lifecycle ,
Enum:
{
Lifecycle: No description available. ,
}
,
Required: True ,
}
enum ,
definition:
{
Description: An object that defines the Lifecycle rule. ,
Required: True ,
}
{
actions:
{
Description: An object that defines the action set. ,
Required: True ,
}
{
baseBlob:
{
Description: The management policy action for base blob ,
Required: False ,
}
{
tierToCool:
{
Description: The function to tier blobs to cool storage. ,
Required: False ,
}
{
daysAfterModificationGreaterThan:
{
Description: Value indicating the age in days after last modification ,
Required: False ,
}
number ,
daysAfterLastAccessTimeGreaterThan:
{
Description: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy ,
Required: False ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after blob creation. ,
Required: False ,
}
number ,
}
,
tierToArchive:
{
Description: The function to tier blobs to archive storage. ,
Required: False ,
}
{
daysAfterModificationGreaterThan:
{
Description: Value indicating the age in days after last modification ,
Required: False ,
}
number ,
daysAfterLastAccessTimeGreaterThan:
{
Description: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy ,
Required: False ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after blob creation. ,
Required: False ,
}
number ,
}
,
tierToCold:
{
Description: The function to tier blobs to cold storage. ,
Required: False ,
}
{
daysAfterModificationGreaterThan:
{
Description: Value indicating the age in days after last modification ,
Required: False ,
}
number ,
daysAfterLastAccessTimeGreaterThan:
{
Description: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy ,
Required: False ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after blob creation. ,
Required: False ,
}
number ,
}
,
tierToHot:
{
Description: The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts ,
Required: False ,
}
{
daysAfterModificationGreaterThan:
{
Description: Value indicating the age in days after last modification ,
Required: False ,
}
number ,
daysAfterLastAccessTimeGreaterThan:
{
Description: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy ,
Required: False ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after blob creation. ,
Required: False ,
}
number ,
}
,
delete:
{
Description: The function to delete the blob ,
Required: False ,
}
{
daysAfterModificationGreaterThan:
{
Description: Value indicating the age in days after last modification ,
Required: False ,
}
number ,
daysAfterLastAccessTimeGreaterThan:
{
Description: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy ,
Required: False ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after blob creation. ,
Required: False ,
}
number ,
}
,
enableAutoTierToHotFromCool:
{
Description: This property enables auto tiering of a blob from cool to hot on a blob access. This property requires tierToCool.daysAfterLastAccessTimeGreaterThan. ,
Required: False ,
}
boolean ,
}
,
snapshot:
{
Description: The management policy action for snapshot ,
Required: False ,
}
{
tierToCool:
{
Description: The function to tier blob snapshot to cool storage. ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
tierToArchive:
{
Description: The function to tier blob snapshot to archive storage. ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
tierToCold:
{
Description: The function to tier blobs to cold storage. ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
tierToHot:
{
Description: The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
delete:
{
Description: The function to delete the blob snapshot ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
}
,
version:
{
Description: The management policy action for version ,
Required: False ,
}
{
tierToCool:
{
Description: The function to tier blob version to cool storage. ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
tierToArchive:
{
Description: The function to tier blob version to archive storage. ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
tierToCold:
{
Description: The function to tier blobs to cold storage. ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
tierToHot:
{
Description: The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
delete:
{
Description: The function to delete the blob version ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
}
,
}
,
filters:
{
Description: An object that defines the filter set. ,
Required: False ,
}
{
prefixMatch:
{
Description: An array of strings for prefixes to be match. ,
Required: False ,
}
[
string ,
]
,
blobTypes:
{
Description: An array of predefined enum values. Currently blockBlob supports all tiering and delete actions. Only delete actions are supported for appendBlob. ,
Required: True ,
}
[
string ,
]
,
blobIndexMatch:
{
Description: An array of blob index tag based filters, there can be at most 10 tag filters ,
Required: False ,
}
[
{
name:
{
Description: This is the filter tag name, it can have 1 - 128 characters ,
Required: True ,
}
string ,
op:
{
Description: This is the comparison operator which is used for object comparison and filtering. Only == (equality operator) is currently supported ,
Required: True ,
}
string ,
value:
{
Description: This is the filter tag value field used for tag based filtering, it can have 0 - 256 characters ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Returns the Storage Account Data Policies Rules. ,
Required: False ,
}
{
lastModifiedTime:
{
Description: Returns the date and time the ManagementPolicies was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
policy:
{
Description: The Storage Account ManagementPolicy, in JSON format. See more details in: https://learn.microsoft.com/azure/storage/blobs/lifecycle-management-overview. ,
Required: True ,
}
{
rules:
{
Description: The Storage Account ManagementPolicies Rules. See more details in: https://learn.microsoft.com/azure/storage/blobs/lifecycle-management-overview. ,
Required: True ,
}
[
{
enabled:
{
Description: Rule is enabled if set to true. ,
Required: False ,
}
boolean ,
name:
{
Description: A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. ,
Required: True ,
}
string ,
type:
{
Description: The valid value is Lifecycle ,
Enum:
{
Lifecycle: No description available. ,
}
,
Required: True ,
}
enum ,
definition:
{
Description: An object that defines the Lifecycle rule. ,
Required: True ,
}
{
actions:
{
Description: An object that defines the action set. ,
Required: True ,
}
{
baseBlob:
{
Description: The management policy action for base blob ,
Required: False ,
}
{
tierToCool:
{
Description: The function to tier blobs to cool storage. ,
Required: False ,
}
{
daysAfterModificationGreaterThan:
{
Description: Value indicating the age in days after last modification ,
Required: False ,
}
number ,
daysAfterLastAccessTimeGreaterThan:
{
Description: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy ,
Required: False ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after blob creation. ,
Required: False ,
}
number ,
}
,
tierToArchive:
{
Description: The function to tier blobs to archive storage. ,
Required: False ,
}
{
daysAfterModificationGreaterThan:
{
Description: Value indicating the age in days after last modification ,
Required: False ,
}
number ,
daysAfterLastAccessTimeGreaterThan:
{
Description: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy ,
Required: False ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after blob creation. ,
Required: False ,
}
number ,
}
,
tierToCold:
{
Description: The function to tier blobs to cold storage. ,
Required: False ,
}
{
daysAfterModificationGreaterThan:
{
Description: Value indicating the age in days after last modification ,
Required: False ,
}
number ,
daysAfterLastAccessTimeGreaterThan:
{
Description: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy ,
Required: False ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after blob creation. ,
Required: False ,
}
number ,
}
,
tierToHot:
{
Description: The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts ,
Required: False ,
}
{
daysAfterModificationGreaterThan:
{
Description: Value indicating the age in days after last modification ,
Required: False ,
}
number ,
daysAfterLastAccessTimeGreaterThan:
{
Description: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy ,
Required: False ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after blob creation. ,
Required: False ,
}
number ,
}
,
delete:
{
Description: The function to delete the blob ,
Required: False ,
}
{
daysAfterModificationGreaterThan:
{
Description: Value indicating the age in days after last modification ,
Required: False ,
}
number ,
daysAfterLastAccessTimeGreaterThan:
{
Description: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy ,
Required: False ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after blob creation. ,
Required: False ,
}
number ,
}
,
enableAutoTierToHotFromCool:
{
Description: This property enables auto tiering of a blob from cool to hot on a blob access. This property requires tierToCool.daysAfterLastAccessTimeGreaterThan. ,
Required: False ,
}
boolean ,
}
,
snapshot:
{
Description: The management policy action for snapshot ,
Required: False ,
}
{
tierToCool:
{
Description: The function to tier blob snapshot to cool storage. ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
tierToArchive:
{
Description: The function to tier blob snapshot to archive storage. ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
tierToCold:
{
Description: The function to tier blobs to cold storage. ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
tierToHot:
{
Description: The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
delete:
{
Description: The function to delete the blob snapshot ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
}
,
version:
{
Description: The management policy action for version ,
Required: False ,
}
{
tierToCool:
{
Description: The function to tier blob version to cool storage. ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
tierToArchive:
{
Description: The function to tier blob version to archive storage. ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
tierToCold:
{
Description: The function to tier blobs to cold storage. ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
tierToHot:
{
Description: The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
delete:
{
Description: The function to delete the blob version ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
}
,
}
,
filters:
{
Description: An object that defines the filter set. ,
Required: False ,
}
{
prefixMatch:
{
Description: An array of strings for prefixes to be match. ,
Required: False ,
}
[
string ,
]
,
blobTypes:
{
Description: An array of predefined enum values. Currently blockBlob supports all tiering and delete actions. Only delete actions are supported for appendBlob. ,
Required: True ,
}
[
string ,
]
,
blobIndexMatch:
{
Description: An array of blob index tag based filters, there can be at most 10 tag filters ,
Required: False ,
}
[
{
name:
{
Description: This is the filter tag name, it can have 1 - 128 characters ,
Required: True ,
}
string ,
op:
{
Description: This is the comparison operator which is used for object comparison and filtering. Only == (equality operator) is currently supported ,
Required: True ,
}
string ,
value:
{
Description: This is the filter tag value field used for tag based filtering, it can have 0 - 256 characters ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
}
,
}
,
}
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": [
          {
            "runStatus": [
              {
                "#name": "startTime",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "finishTime",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "objectsTargetedCount",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "objectsOperatedOnCount",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "objectFailedCount",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "objectsSucceededCount",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "runStatus": [
              {
                "#name": "startTime",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "finishTime",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "objectsTargetedCount",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "objectsOperatedOnCount",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "objectFailedCount",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "objectsSucceededCount",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              }
            ]
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "runStatus": [
              {
                "#name": "startTime",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "finishTime",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "objectsTargetedCount",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "objectsOperatedOnCount",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "objectFailedCount",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "objectsSucceededCount",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ 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. ,
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/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/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/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/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/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/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. ,
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/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/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/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/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/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/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. ,
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/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/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/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/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/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/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": [
          {
            "runStatus": [
              {
                "#name": "startTime",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "finishTime",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "objectsTargetedCount",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "objectsOperatedOnCount",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "objectFailedCount",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "objectsSucceededCount",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "runStatus": [
              {
                "#name": "startTime",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "finishTime",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "objectsTargetedCount",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "objectsOperatedOnCount",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "objectFailedCount",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "objectsSucceededCount",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ 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. ,
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/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/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/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/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/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/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. ,
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/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/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/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/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/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/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": [
          {
            "runStatus": [
              {
                "#name": "startTime",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "finishTime",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "objectsTargetedCount",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "objectsOperatedOnCount",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "objectFailedCount",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "objectsSucceededCount",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ 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. ,
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/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/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/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/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/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/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": [
              {
                "runStatus": [
                  {
                    "#name": "startTime",
                    "Description": {
                      "new": "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",
                      "old": "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"
                    }
                  },
                  {
                    "#name": "finishTime",
                    "Description": {
                      "new": "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",
                      "old": "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"
                    }
                  },
                  {
                    "#name": "objectsTargetedCount",
                    "Description": {
                      "new": "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",
                      "old": "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"
                    }
                  },
                  {
                    "#name": "objectsOperatedOnCount",
                    "Description": {
                      "new": "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",
                      "old": "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"
                    }
                  },
                  {
                    "#name": "objectFailedCount",
                    "Description": {
                      "new": "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",
                      "old": "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"
                    }
                  },
                  {
                    "#name": "objectsSucceededCount",
                    "Description": {
                      "new": "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",
                      "old": "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"
                    }
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ 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. ,
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/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/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/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/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/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/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 ,
}
,
]
,
}
,
}
StorageTaskAssignmentsInstancesReport_List (updated)
Description :  Fetch the report summary of all the storage task assignments and instances in an account
Reference :  Link ¶

⚶ Changes

{
  "#id": "StorageTaskAssignmentsInstancesReport_List",
  "$parameters": [
    {
      "#name": "$filter",
      "Description": {
        "new": "Optional. When specified, it can be used to query using reporting properties. See [Constructing Filter Strings](https://learn.microsoft.com/rest/api/storageservices/querying-tables-and-entities#constructing-filter-strings) for details.",
        "old": "Optional. When specified, it can be used to query using reporting properties. See [Constructing Filter Strings](https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#constructing-filter-strings) for details."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "startTime",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "finishTime",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "objectsTargetedCount",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "objectsOperatedOnCount",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "objectFailedCount",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "objectsSucceededCount",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/reports
{
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 instances to be included in the list response. ,
Format: int32 ,
Required: False ,
}
integer ,
$filter:
{
Description: Optional. When specified, it can be used to query using reporting properties. See [Constructing Filter Strings](https://learn.microsoft.com/rest/api/storageservices/querying-tables-and-entities#constructing-filter-strings) for details. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets storage tasks run result summary. ,
Required: False ,
}
[
{
properties:
{
Description: Storage task execution report for a run instance. ,
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/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/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/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/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/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/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 run results summary. Returned when the number of run instances and summary reports 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 ,
}
,
]
,
}
,
}
StorageTaskAssignmentInstancesReport_List (updated)
Description :  Fetch the report summary of a single storage task assignment's instances
Reference :  Link ¶

⚶ Changes

{
  "#id": "StorageTaskAssignmentInstancesReport_List",
  "$parameters": [
    {
      "#name": "$filter",
      "Description": {
        "new": "Optional. When specified, it can be used to query using reporting properties. See [Constructing Filter Strings](https://learn.microsoft.com/rest/api/storageservices/querying-tables-and-entities#constructing-filter-strings) for details.",
        "old": "Optional. When specified, it can be used to query using reporting properties. See [Constructing Filter Strings](https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#constructing-filter-strings) for details."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "startTime",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "finishTime",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "objectsTargetedCount",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "objectsOperatedOnCount",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "objectFailedCount",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              },
              {
                "#name": "objectsSucceededCount",
                "Description": {
                  "new": "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",
                  "old": "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"
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/storageTaskAssignments/{storageTaskAssignmentName}/reports
{
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 ,
$maxpagesize:
{
Description: Optional, specifies the maximum number of storage task assignment instances to be included in the list response. ,
Format: int32 ,
Required: False ,
}
integer ,
$filter:
{
Description: Optional. When specified, it can be used to query using reporting properties. See [Constructing Filter Strings](https://learn.microsoft.com/rest/api/storageservices/querying-tables-and-entities#constructing-filter-strings) for details. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets storage tasks run result summary. ,
Required: False ,
}
[
{
properties:
{
Description: Storage task execution report for a run instance. ,
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/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/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/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/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/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/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 run results summary. Returned when the number of run instances and summary reports 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 ,
}
,
]
,
}
,
}