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

2025/04/21 • 1 updated methods

StorageTasks_Update (updated)
Description :  Update storage task properties
Reference :  Link ¶

⚶ Changes

{
  "#id": "StorageTasks_Update",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "#name": "enabled",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "description",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "action",
            "Required": {
              "new": false,
              "old": true
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageActions/storageTasks/{storageTaskName}
{
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 ,
}
,
}
,
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)

{
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: 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 ,
}
,
]
,
}
,
}