Microsoft.StorageActions (stable:2023-01-01)

2025/06/25 • 8 updated methods

StorageTasks_PreviewActions (updated)
Description :  Runs the input conditions against input object metadata properties and designates matched objects in response.
Reference :  Link ¶

⚶ Changes

{
  "#id": "StorageTasks_PreviewActions",
  "$parameters": [
    {
      "#name": "location",
      "Description": {
        "new": "Represents an Azure geography region where supported resource providers live.",
        "old": "The location to perform preview of the actions."
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.StorageActions/locations/{location}/previewActions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: Represents an Azure geography region where supported resource providers live. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to preview action condition. ,
Required: True ,
}
{
properties:
{
Description: Properties of the storage task preview. ,
Required: True ,
}
{
container:
{
Description: Properties of a sample container to test for a match with the preview action. ,
Required: True ,
}
{
name:
{
Description: Name of test container ,
Required: False ,
}
string ,
metadata:
{
Description: metadata key value pairs to be tested for a match against the provided condition. ,
Required: False ,
}
[
{
key:
{
Description: Represents the key property of the pair. ,
Required: False ,
}
string ,
value:
{
Description: Represents the value property of the pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
blobs:
{
Description: Properties of some sample blobs in the container to test for matches with the preview action. ,
Required: True ,
}
[
{
name:
{
Description: Name of test blob ,
Required: False ,
}
string ,
properties:
{
Description: properties key value pairs to be tested for a match against the provided condition. ,
Required: False ,
}
[
{
key:
{
Description: Represents the key property of the pair. ,
Required: False ,
}
string ,
value:
{
Description: Represents the value property of the pair. ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: metadata key value pairs to be tested for a match against the provided condition. ,
Required: False ,
}
[
{
key:
{
Description: Represents the key property of the pair. ,
Required: False ,
}
string ,
value:
{
Description: Represents the value property of the pair. ,
Required: False ,
}
string ,
}
,
]
,
tags:
{
Description: tags key value pairs to be tested for a match against the provided condition. ,
Required: False ,
}
[
{
key:
{
Description: Represents the key property of the pair. ,
Required: False ,
}
string ,
value:
{
Description: Represents the value property of the pair. ,
Required: False ,
}
string ,
}
,
]
,
matchedBlock:
{
Description: Represents the condition block name that matched blob properties. ,
Enum:
{
If: No description available. ,
Else: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
action:
{
Description: Preview action to test ,
Required: True ,
}
{
if:
{
Description: The condition to be tested for a match with container and blob properties. ,
Required: True ,
}
{
condition:
{
Description: Storage task condition to bes tested for a match. ,
Required: False ,
}
string ,
}
,
elseBlockExists:
{
Description: Specify whether the else block is present in the condition. ,
Required: True ,
}
boolean ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the storage task preview. ,
Required: True ,
}
{
container:
{
Description: Properties of a sample container to test for a match with the preview action. ,
Required: True ,
}
{
name:
{
Description: Name of test container ,
Required: False ,
}
string ,
metadata:
{
Description: metadata key value pairs to be tested for a match against the provided condition. ,
Required: False ,
}
[
{
key:
{
Description: Represents the key property of the pair. ,
Required: False ,
}
string ,
value:
{
Description: Represents the value property of the pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
blobs:
{
Description: Properties of some sample blobs in the container to test for matches with the preview action. ,
Required: True ,
}
[
{
name:
{
Description: Name of test blob ,
Required: False ,
}
string ,
properties:
{
Description: properties key value pairs to be tested for a match against the provided condition. ,
Required: False ,
}
[
{
key:
{
Description: Represents the key property of the pair. ,
Required: False ,
}
string ,
value:
{
Description: Represents the value property of the pair. ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: metadata key value pairs to be tested for a match against the provided condition. ,
Required: False ,
}
[
{
key:
{
Description: Represents the key property of the pair. ,
Required: False ,
}
string ,
value:
{
Description: Represents the value property of the pair. ,
Required: False ,
}
string ,
}
,
]
,
tags:
{
Description: tags key value pairs to be tested for a match against the provided condition. ,
Required: False ,
}
[
{
key:
{
Description: Represents the key property of the pair. ,
Required: False ,
}
string ,
value:
{
Description: Represents the value property of the pair. ,
Required: False ,
}
string ,
}
,
]
,
matchedBlock:
{
Description: Represents the condition block name that matched blob properties. ,
Enum:
{
If: No description available. ,
Else: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
action:
{
Description: Preview action to test ,
Required: True ,
}
{
if:
{
Description: The condition to be tested for a match with container and blob properties. ,
Required: True ,
}
{
condition:
{
Description: Storage task condition to bes tested for a match. ,
Required: False ,
}
string ,
}
,
elseBlockExists:
{
Description: Specify whether the else block is present in the condition. ,
Required: True ,
}
boolean ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
StorageTasks_ListBySubscription (updated)
Description :  Lists all the storage tasks available under the subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "StorageTasks_ListBySubscription",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Request URL that can be used to query next page of storage tasks. Returned when total number of requested storage tasks exceed maximum page size."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.StorageActions/storageTasks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets the list of storage tasks and their properties. ,
Required: True ,
}
[
{
identity:
{
Description: The managed service identity of the resource. ,
Required: True ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Properties of the storage task. ,
Required: True ,
}
{
taskVersion:
{
Description: Storage task version. ,
Format: int64 ,
Required: False ,
}
integer ,
enabled:
{
Description: Storage Task is enabled when set to true and disabled when set to false ,
Required: True ,
}
boolean ,
description:
{
Description: Text that describes the purpose of the storage task ,
Required: True ,
}
string ,
action:
{
Description: The storage task action that is executed ,
Required: True ,
}
{
if:
{
Description: The if block of storage task operation ,
Required: True ,
}
{
condition:
{
Description: Condition predicate to evaluate each object. See https://aka.ms/storagetaskconditions for valid properties and operators. ,
Required: True ,
}
string ,
operations:
{
Description: List of operations to execute when the condition predicate satisfies. ,
Required: True ,
}
[
{
name:
{
Description: The operation to be performed on the object. ,
Enum:
{
SetBlobTier: No description available. ,
SetBlobTags: No description available. ,
SetBlobImmutabilityPolicy: No description available. ,
SetBlobLegalHold: No description available. ,
SetBlobExpiry: No description available. ,
DeleteBlob: No description available. ,
UndeleteBlob: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: Key-value parameters for the operation. ,
Required: False ,
}
object ,
onSuccess:
{
Description: Action to be taken when the operation is successful for a object. ,
Enum:
{
continue: No description available. ,
}
,
Required: False ,
}
enum ,
onFailure:
{
Description: Action to be taken when the operation fails for a object. ,
Enum:
{
break: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
else:
{
Description: The else block of storage task operation ,
Required: False ,
}
{
operations:
{
Description: List of operations to execute in the else block ,
Required: True ,
}
[
{
name:
{
Description: The operation to be performed on the object. ,
Enum:
{
SetBlobTier: No description available. ,
SetBlobTags: No description available. ,
SetBlobImmutabilityPolicy: No description available. ,
SetBlobLegalHold: No description available. ,
SetBlobExpiry: No description available. ,
DeleteBlob: No description available. ,
UndeleteBlob: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: Key-value parameters for the operation. ,
Required: False ,
}
object ,
onSuccess:
{
Description: Action to be taken when the operation is successful for a object. ,
Enum:
{
continue: No description available. ,
}
,
Required: False ,
}
enum ,
onFailure:
{
Description: Action to be taken when the operation fails for a object. ,
Enum:
{
break: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
provisioningState:
{
Description: Represents the provisioning state of the storage task. ,
Enum:
{
ValidateSubscriptionQuotaBegin: No description available. ,
ValidateSubscriptionQuotaEnd: No description available. ,
Accepted: No description available. ,
Creating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
creationTimeInUtc:
{
Description: The creation date and time of the storage task in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
StorageTasks_ListByResourceGroup (updated)
Description :  Lists all the storage tasks available under the given resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "StorageTasks_ListByResourceGroup",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Request URL that can be used to query next page of storage tasks. Returned when total number of requested storage tasks exceed maximum page size."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageActions/storageTasks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: Gets the list of storage tasks and their properties. ,
Required: True ,
}
[
{
identity:
{
Description: The managed service identity of the resource. ,
Required: True ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Properties of the storage task. ,
Required: True ,
}
{
taskVersion:
{
Description: Storage task version. ,
Format: int64 ,
Required: False ,
}
integer ,
enabled:
{
Description: Storage Task is enabled when set to true and disabled when set to false ,
Required: True ,
}
boolean ,
description:
{
Description: Text that describes the purpose of the storage task ,
Required: True ,
}
string ,
action:
{
Description: The storage task action that is executed ,
Required: True ,
}
{
if:
{
Description: The if block of storage task operation ,
Required: True ,
}
{
condition:
{
Description: Condition predicate to evaluate each object. See https://aka.ms/storagetaskconditions for valid properties and operators. ,
Required: True ,
}
string ,
operations:
{
Description: List of operations to execute when the condition predicate satisfies. ,
Required: True ,
}
[
{
name:
{
Description: The operation to be performed on the object. ,
Enum:
{
SetBlobTier: No description available. ,
SetBlobTags: No description available. ,
SetBlobImmutabilityPolicy: No description available. ,
SetBlobLegalHold: No description available. ,
SetBlobExpiry: No description available. ,
DeleteBlob: No description available. ,
UndeleteBlob: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: Key-value parameters for the operation. ,
Required: False ,
}
object ,
onSuccess:
{
Description: Action to be taken when the operation is successful for a object. ,
Enum:
{
continue: No description available. ,
}
,
Required: False ,
}
enum ,
onFailure:
{
Description: Action to be taken when the operation fails for a object. ,
Enum:
{
break: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
else:
{
Description: The else block of storage task operation ,
Required: False ,
}
{
operations:
{
Description: List of operations to execute in the else block ,
Required: True ,
}
[
{
name:
{
Description: The operation to be performed on the object. ,
Enum:
{
SetBlobTier: No description available. ,
SetBlobTags: No description available. ,
SetBlobImmutabilityPolicy: No description available. ,
SetBlobLegalHold: No description available. ,
SetBlobExpiry: No description available. ,
DeleteBlob: No description available. ,
UndeleteBlob: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: Key-value parameters for the operation. ,
Required: False ,
}
object ,
onSuccess:
{
Description: Action to be taken when the operation is successful for a object. ,
Enum:
{
continue: No description available. ,
}
,
Required: False ,
}
enum ,
onFailure:
{
Description: Action to be taken when the operation fails for a object. ,
Enum:
{
break: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
provisioningState:
{
Description: Represents the provisioning state of the storage task. ,
Enum:
{
ValidateSubscriptionQuotaBegin: No description available. ,
ValidateSubscriptionQuotaEnd: No description available. ,
Accepted: No description available. ,
Creating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
creationTimeInUtc:
{
Description: The creation date and time of the storage task in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
StorageTasks_Create (updated)
Description :  Asynchronously creates a new storage task resource with the specified parameters. If a storage task is already created and a subsequent create request is issued with different properties, the storage task properties will be updated. If a storage task 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": "StorageTasks_Create",
  "$responses": {
    "202": [
      {
        "@added_fae92310e681456c8262eb6058b51a73": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageActions/storageTasks/{storageTaskName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
storageTaskName:
{
Description: The name of the storage task within the specified resource group. Storage task names must be between 3 and 18 characters in length and use numbers and lower-case letters only. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to create a Storage Task. ,
Required: True ,
}
{
identity:
{
Description: The managed service identity of the resource. ,
Required: True ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Properties of the storage task. ,
Required: True ,
}
{
taskVersion:
{
Description: Storage task version. ,
Format: int64 ,
Required: False ,
}
integer ,
enabled:
{
Description: Storage Task is enabled when set to true and disabled when set to false ,
Required: True ,
}
boolean ,
description:
{
Description: Text that describes the purpose of the storage task ,
Required: True ,
}
string ,
action:
{
Description: The storage task action that is executed ,
Required: True ,
}
{
if:
{
Description: The if block of storage task operation ,
Required: True ,
}
{
condition:
{
Description: Condition predicate to evaluate each object. See https://aka.ms/storagetaskconditions for valid properties and operators. ,
Required: True ,
}
string ,
operations:
{
Description: List of operations to execute when the condition predicate satisfies. ,
Required: True ,
}
[
{
name:
{
Description: The operation to be performed on the object. ,
Enum:
{
SetBlobTier: No description available. ,
SetBlobTags: No description available. ,
SetBlobImmutabilityPolicy: No description available. ,
SetBlobLegalHold: No description available. ,
SetBlobExpiry: No description available. ,
DeleteBlob: No description available. ,
UndeleteBlob: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: Key-value parameters for the operation. ,
Required: False ,
}
object ,
onSuccess:
{
Description: Action to be taken when the operation is successful for a object. ,
Enum:
{
continue: No description available. ,
}
,
Required: False ,
}
enum ,
onFailure:
{
Description: Action to be taken when the operation fails for a object. ,
Enum:
{
break: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
else:
{
Description: The else block of storage task operation ,
Required: False ,
}
{
operations:
{
Description: List of operations to execute in the else block ,
Required: True ,
}
[
{
name:
{
Description: The operation to be performed on the object. ,
Enum:
{
SetBlobTier: No description available. ,
SetBlobTags: No description available. ,
SetBlobImmutabilityPolicy: No description available. ,
SetBlobLegalHold: No description available. ,
SetBlobExpiry: No description available. ,
DeleteBlob: No description available. ,
UndeleteBlob: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: Key-value parameters for the operation. ,
Required: False ,
}
object ,
onSuccess:
{
Description: Action to be taken when the operation is successful for a object. ,
Enum:
{
continue: No description available. ,
}
,
Required: False ,
}
enum ,
onFailure:
{
Description: Action to be taken when the operation fails for a object. ,
Enum:
{
break: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
provisioningState:
{
Description: Represents the provisioning state of the storage task. ,
Enum:
{
ValidateSubscriptionQuotaBegin: No description available. ,
ValidateSubscriptionQuotaEnd: No description available. ,
Accepted: No description available. ,
Creating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
creationTimeInUtc:
{
Description: The creation date and time of the storage task in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: The managed service identity of the resource. ,
Required: True ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Properties of the storage task. ,
Required: True ,
}
{
taskVersion:
{
Description: Storage task version. ,
Format: int64 ,
Required: False ,
}
integer ,
enabled:
{
Description: Storage Task is enabled when set to true and disabled when set to false ,
Required: True ,
}
boolean ,
description:
{
Description: Text that describes the purpose of the storage task ,
Required: True ,
}
string ,
action:
{
Description: The storage task action that is executed ,
Required: True ,
}
{
if:
{
Description: The if block of storage task operation ,
Required: True ,
}
{
condition:
{
Description: Condition predicate to evaluate each object. See https://aka.ms/storagetaskconditions for valid properties and operators. ,
Required: True ,
}
string ,
operations:
{
Description: List of operations to execute when the condition predicate satisfies. ,
Required: True ,
}
[
{
name:
{
Description: The operation to be performed on the object. ,
Enum:
{
SetBlobTier: No description available. ,
SetBlobTags: No description available. ,
SetBlobImmutabilityPolicy: No description available. ,
SetBlobLegalHold: No description available. ,
SetBlobExpiry: No description available. ,
DeleteBlob: No description available. ,
UndeleteBlob: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: Key-value parameters for the operation. ,
Required: False ,
}
object ,
onSuccess:
{
Description: Action to be taken when the operation is successful for a object. ,
Enum:
{
continue: No description available. ,
}
,
Required: False ,
}
enum ,
onFailure:
{
Description: Action to be taken when the operation fails for a object. ,
Enum:
{
break: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
else:
{
Description: The else block of storage task operation ,
Required: False ,
}
{
operations:
{
Description: List of operations to execute in the else block ,
Required: True ,
}
[
{
name:
{
Description: The operation to be performed on the object. ,
Enum:
{
SetBlobTier: No description available. ,
SetBlobTags: No description available. ,
SetBlobImmutabilityPolicy: No description available. ,
SetBlobLegalHold: No description available. ,
SetBlobExpiry: No description available. ,
DeleteBlob: No description available. ,
UndeleteBlob: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: Key-value parameters for the operation. ,
Required: False ,
}
object ,
onSuccess:
{
Description: Action to be taken when the operation is successful for a object. ,
Enum:
{
continue: No description available. ,
}
,
Required: False ,
}
enum ,
onFailure:
{
Description: Action to be taken when the operation fails for a object. ,
Enum:
{
break: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
provisioningState:
{
Description: Represents the provisioning state of the storage task. ,
Enum:
{
ValidateSubscriptionQuotaBegin: No description available. ,
ValidateSubscriptionQuotaEnd: No description available. ,
Accepted: No description available. ,
Creating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
creationTimeInUtc:
{
Description: The creation date and time of the storage task in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Represents Storage Task. ,
}
{
identity:
{
Description: The managed service identity of the resource. ,
Required: True ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Properties of the storage task. ,
Required: True ,
}
{
taskVersion:
{
Description: Storage task version. ,
Format: int64 ,
Required: False ,
}
integer ,
enabled:
{
Description: Storage Task is enabled when set to true and disabled when set to false ,
Required: True ,
}
boolean ,
description:
{
Description: Text that describes the purpose of the storage task ,
Required: True ,
}
string ,
action:
{
Description: The storage task action that is executed ,
Required: True ,
}
{
if:
{
Description: The if block of storage task operation ,
Required: True ,
}
{
condition:
{
Description: Condition predicate to evaluate each object. See https://aka.ms/storagetaskconditions for valid properties and operators. ,
Required: True ,
}
string ,
operations:
{
Description: List of operations to execute when the condition predicate satisfies. ,
Required: True ,
}
[
{
name:
{
Description: The operation to be performed on the object. ,
Enum:
{
SetBlobTier: No description available. ,
SetBlobTags: No description available. ,
SetBlobImmutabilityPolicy: No description available. ,
SetBlobLegalHold: No description available. ,
SetBlobExpiry: No description available. ,
DeleteBlob: No description available. ,
UndeleteBlob: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: Key-value parameters for the operation. ,
Required: False ,
}
object ,
onSuccess:
{
Description: Action to be taken when the operation is successful for a object. ,
Enum:
{
continue: No description available. ,
}
,
Required: False ,
}
enum ,
onFailure:
{
Description: Action to be taken when the operation fails for a object. ,
Enum:
{
break: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
else:
{
Description: The else block of storage task operation ,
Required: False ,
}
{
operations:
{
Description: List of operations to execute in the else block ,
Required: True ,
}
[
{
name:
{
Description: The operation to be performed on the object. ,
Enum:
{
SetBlobTier: No description available. ,
SetBlobTags: No description available. ,
SetBlobImmutabilityPolicy: No description available. ,
SetBlobLegalHold: No description available. ,
SetBlobExpiry: No description available. ,
DeleteBlob: No description available. ,
UndeleteBlob: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: Key-value parameters for the operation. ,
Required: False ,
}
object ,
onSuccess:
{
Description: Action to be taken when the operation is successful for a object. ,
Enum:
{
continue: No description available. ,
}
,
Required: False ,
}
enum ,
onFailure:
{
Description: Action to be taken when the operation fails for a object. ,
Enum:
{
break: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
provisioningState:
{
Description: Represents the provisioning state of the storage task. ,
Enum:
{
ValidateSubscriptionQuotaBegin: No description available. ,
ValidateSubscriptionQuotaEnd: No description available. ,
Accepted: No description available. ,
Creating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
creationTimeInUtc:
{
Description: The creation date and time of the storage task in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 ,
}
,
]
,
}
,
}
StorageTasks_Update (updated)
Description :  Update storage task properties
Reference :  Link ¶

⚶ Changes

{
  "#id": "StorageTasks_Update",
  "$responses": {
    "202": [
      {
        "@added_e63227e126574e339141d51ec0c26ece": {
          "#name": "azure-asyncoperation",
          "Description": "A link to the status monitor",
          "Type": "string"
        }
      },
      {
        "@added_4d82ce65381f449fb24c8f834fb03228": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageActions/storageTasks/{storageTaskName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
storageTaskName:
{
Description: The name of the storage task within the specified resource group. Storage task names must be between 3 and 18 characters in length and use numbers and lower-case letters only. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide to update the storage task resource. ,
Required: True ,
}
{
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater in length than 128 characters and a value no greater in length than 256 characters. ,
Required: False ,
}
object ,
properties:
{
Description: Properties of the storage task. ,
Required: False ,
}
{
taskVersion:
{
Description: Storage task version. ,
Format: int64 ,
Required: False ,
}
integer ,
enabled:
{
Description: Storage Task is enabled when set to true and disabled when set to false ,
Required: False ,
}
boolean ,
description:
{
Description: Text that describes the purpose of the storage task ,
Required: False ,
}
string ,
action:
{
Description: The storage task action that is executed ,
Required: False ,
}
{
if:
{
Description: The if block of storage task operation ,
Required: True ,
}
{
condition:
{
Description: Condition predicate to evaluate each object. See https://aka.ms/storagetaskconditions for valid properties and operators. ,
Required: True ,
}
string ,
operations:
{
Description: List of operations to execute when the condition predicate satisfies. ,
Required: True ,
}
[
{
name:
{
Description: The operation to be performed on the object. ,
Enum:
{
SetBlobTier: No description available. ,
SetBlobTags: No description available. ,
SetBlobImmutabilityPolicy: No description available. ,
SetBlobLegalHold: No description available. ,
SetBlobExpiry: No description available. ,
DeleteBlob: No description available. ,
UndeleteBlob: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: Key-value parameters for the operation. ,
Required: False ,
}
object ,
onSuccess:
{
Description: Action to be taken when the operation is successful for a object. ,
Enum:
{
continue: No description available. ,
}
,
Required: False ,
}
enum ,
onFailure:
{
Description: Action to be taken when the operation fails for a object. ,
Enum:
{
break: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
else:
{
Description: The else block of storage task operation ,
Required: False ,
}
{
operations:
{
Description: List of operations to execute in the else block ,
Required: True ,
}
[
{
name:
{
Description: The operation to be performed on the object. ,
Enum:
{
SetBlobTier: No description available. ,
SetBlobTags: No description available. ,
SetBlobImmutabilityPolicy: No description available. ,
SetBlobLegalHold: No description available. ,
SetBlobExpiry: No description available. ,
DeleteBlob: No description available. ,
UndeleteBlob: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: Key-value parameters for the operation. ,
Required: False ,
}
object ,
onSuccess:
{
Description: Action to be taken when the operation is successful for a object. ,
Enum:
{
continue: No description available. ,
}
,
Required: False ,
}
enum ,
onFailure:
{
Description: Action to be taken when the operation fails for a object. ,
Enum:
{
break: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
provisioningState:
{
Description: Represents the provisioning state of the storage task. ,
Enum:
{
ValidateSubscriptionQuotaBegin: No description available. ,
ValidateSubscriptionQuotaEnd: No description available. ,
Accepted: No description available. ,
Creating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
creationTimeInUtc:
{
Description: The creation date and time of the storage task in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: The managed service identity of the resource. ,
Required: True ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Properties of the storage task. ,
Required: True ,
}
{
taskVersion:
{
Description: Storage task version. ,
Format: int64 ,
Required: False ,
}
integer ,
enabled:
{
Description: Storage Task is enabled when set to true and disabled when set to false ,
Required: True ,
}
boolean ,
description:
{
Description: Text that describes the purpose of the storage task ,
Required: True ,
}
string ,
action:
{
Description: The storage task action that is executed ,
Required: True ,
}
{
if:
{
Description: The if block of storage task operation ,
Required: True ,
}
{
condition:
{
Description: Condition predicate to evaluate each object. See https://aka.ms/storagetaskconditions for valid properties and operators. ,
Required: True ,
}
string ,
operations:
{
Description: List of operations to execute when the condition predicate satisfies. ,
Required: True ,
}
[
{
name:
{
Description: The operation to be performed on the object. ,
Enum:
{
SetBlobTier: No description available. ,
SetBlobTags: No description available. ,
SetBlobImmutabilityPolicy: No description available. ,
SetBlobLegalHold: No description available. ,
SetBlobExpiry: No description available. ,
DeleteBlob: No description available. ,
UndeleteBlob: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: Key-value parameters for the operation. ,
Required: False ,
}
object ,
onSuccess:
{
Description: Action to be taken when the operation is successful for a object. ,
Enum:
{
continue: No description available. ,
}
,
Required: False ,
}
enum ,
onFailure:
{
Description: Action to be taken when the operation fails for a object. ,
Enum:
{
break: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
else:
{
Description: The else block of storage task operation ,
Required: False ,
}
{
operations:
{
Description: List of operations to execute in the else block ,
Required: True ,
}
[
{
name:
{
Description: The operation to be performed on the object. ,
Enum:
{
SetBlobTier: No description available. ,
SetBlobTags: No description available. ,
SetBlobImmutabilityPolicy: No description available. ,
SetBlobLegalHold: No description available. ,
SetBlobExpiry: No description available. ,
DeleteBlob: No description available. ,
UndeleteBlob: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: Key-value parameters for the operation. ,
Required: False ,
}
object ,
onSuccess:
{
Description: Action to be taken when the operation is successful for a object. ,
Enum:
{
continue: No description available. ,
}
,
Required: False ,
}
enum ,
onFailure:
{
Description: Action to be taken when the operation fails for a object. ,
Enum:
{
break: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
provisioningState:
{
Description: Represents the provisioning state of the storage task. ,
Enum:
{
ValidateSubscriptionQuotaBegin: No description available. ,
ValidateSubscriptionQuotaEnd: No description available. ,
Accepted: No description available. ,
Creating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
creationTimeInUtc:
{
Description: The creation date and time of the storage task in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 ,
}
,
]
,
}
,
}
StorageTasks_Delete (updated)
Description :  Delete the storage task resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "StorageTasks_Delete",
  "$responses": {
    "202": [
      {
        "@added_124e87b5c3634690958a4a5001dba2a3": {
          "#name": "azure-asyncoperation",
          "Description": "A link to the status monitor",
          "Type": "string"
        }
      },
      {
        "@added_6f94d994c1fd49479ebc31f8dbb37b23": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageActions/storageTasks/{storageTaskName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
storageTaskName:
{
Description: The name of the storage task within the specified resource group. Storage task names must be between 3 and 18 characters in length and use numbers and lower-case letters only. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
StorageTasksReport_List (updated)
Description :  Fetch the storage tasks run report summary for each assignment.
Reference :  Link ¶

⚶ Changes

{
  "#id": "StorageTasksReport_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "summaryReportPath",
                  "Description": {
                    "new": "Full path to the verbose report stored in the reporting container as specified in the assignment execution context for the storage account.",
                    "old": "Full path to the verbose report stored in the reporting container as specified in the assignment execution context for the storage account. "
                  }
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "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."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageActions/storageTasks/{storageTaskName}/reports
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
storageTaskName:
{
Description: The name of the storage task within the specified resource group. Storage task names must be between 3 and 18 characters in length and use numbers and lower-case letters only. ,
Required: True ,
}
string ,
$maxpagesize:
{
Description: Optional, specifies the maximum number of Storage Task Assignment Resource IDs 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. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets storage tasks run result summary. ,
Required: True ,
}
[
{
properties:
{
Description: Storage task execution report for a run instance. ,
Required: False ,
}
{
taskAssignmentId:
{
Description: Resource ID of the Storage Task Assignment associated with this reported run. ,
Format: arm-id ,
Required: False ,
}
string ,
storageAccountId:
{
Description: Resource ID of the Storage Account where this reported run executed. ,
Format: arm-id ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the run instance. Filter options such as startTime gt '2023-06-26T20:51:24.4494016Z' and other comparison operators can be used as described for DateTime properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
finishTime:
{
Description: End time of the run instance. Filter options such as startTime gt '2023-06-26T20:51:24.4494016Z' and other comparison operators can be used as described for DateTime properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsTargetedCount:
{
Description: Total number of objects that meet the condition as defined in the storage task assignment execution context. Filter options such as objectsTargetedCount gt 50 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsOperatedOnCount:
{
Description: Total number of objects that meet the storage tasks condition and were operated upon. Filter options such as objectsOperatedOnCount ge 100 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectFailedCount:
{
Description: Total number of objects where task operation failed when was attempted. Filter options such as objectFailedCount eq 0 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsSucceededCount:
{
Description: Total number of objects where task operation succeeded when was attempted.Filter options such as objectsSucceededCount gt 150 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
runStatusError:
{
Description: Well known Azure Storage error code that represents the error encountered during execution of the run instance. ,
Required: False ,
}
string ,
runStatusEnum:
{
Description: Represents the status of the execution. ,
Enum:
{
InProgress: No description available. ,
Finished: No description available. ,
}
,
Required: False ,
}
enum ,
summaryReportPath:
{
Description: Full path to the verbose report stored in the reporting container as specified in the assignment execution context for the storage account. ,
Required: False ,
}
string ,
taskId:
{
Description: Resource ID of the Storage Task applied during this run. ,
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: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
StorageTaskAssignment_List (updated)
Description :  Lists Resource IDs of the Storage Task Assignments associated with this Storage Task.
Reference :  Link ¶

⚶ Changes

{
  "#id": "StorageTaskAssignment_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Request URL that can be used to query next page of Resource IDs. Returned when total number of requested Resource IDs exceed maximum page size."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageActions/storageTasks/{storageTaskName}/storageTaskAssignments
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
storageTaskName:
{
Description: The name of the storage task within the specified resource group. Storage task names must be between 3 and 18 characters in length and use numbers and lower-case letters only. ,
Required: True ,
}
string ,
$maxpagesize:
{
Description: Optional, specifies the maximum number of Storage Task Assignment Resource IDs to be included in the list response. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: List of Storage Task Assignment Resource IDs associated with this Storage Task. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID of the Storage Task Assignment. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}