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

2025/03/31 • 5 updated methods

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",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "ValidateSubscriptionQuotaBegin",
                  ""
                ],
                [
                  "ValidateSubscriptionQuotaEnd",
                  ""
                ],
                [
                  "Accepted",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Failed",
                  ""
                ]
              ],
              "old": [
                [
                  "ValidateSubscriptionQuotaBegin",
                  ""
                ],
                [
                  "ValidateSubscriptionQuotaEnd",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Failed",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "ValidateSubscriptionQuotaBegin",
                  ""
                ],
                [
                  "ValidateSubscriptionQuotaEnd",
                  ""
                ],
                [
                  "Accepted",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Failed",
                  ""
                ]
              ],
              "old": [
                [
                  "ValidateSubscriptionQuotaBegin",
                  ""
                ],
                [
                  "ValidateSubscriptionQuotaEnd",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Failed",
                  ""
                ]
              ]
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "ValidateSubscriptionQuotaBegin",
                  ""
                ],
                [
                  "ValidateSubscriptionQuotaEnd",
                  ""
                ],
                [
                  "Accepted",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Failed",
                  ""
                ]
              ],
              "old": [
                [
                  "ValidateSubscriptionQuotaBegin",
                  ""
                ],
                [
                  "ValidateSubscriptionQuotaEnd",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Failed",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageActions/storageTasks/{storageTaskName}
{
resourceGroupName: string ,
storageTaskName: string ,
parameters:
{
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
properties:
{
taskVersion: integer ,
enabled: boolean ,
description: string ,
action:
{
if:
{
condition: string ,
operations:
[
{
name: enum ,
parameters: object ,
onSuccess: enum ,
onFailure: enum ,
}
,
]
,
}
,
else:
{
operations:
[
{
name: enum ,
parameters: object ,
onSuccess: enum ,
onFailure: enum ,
}
,
]
,
}
,
}
,
provisioningState: enum ,
creationTimeInUtc: string ,
}
,
}
,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
properties:
{
taskVersion: integer ,
enabled: boolean ,
description: string ,
action:
{
if:
{
condition: string ,
operations:
[
{
name: enum ,
parameters: object ,
onSuccess: enum ,
onFailure: enum ,
}
,
]
,
}
,
else:
{
operations:
[
{
name: enum ,
parameters: object ,
onSuccess: enum ,
onFailure: enum ,
}
,
]
,
}
,
}
,
provisioningState: enum ,
creationTimeInUtc: string ,
}
,
}

⚐ Response (201)

{
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
properties:
{
taskVersion: integer ,
enabled: boolean ,
description: string ,
action:
{
if:
{
condition: string ,
operations:
[
{
name: enum ,
parameters: object ,
onSuccess: enum ,
onFailure: enum ,
}
,
]
,
}
,
else:
{
operations:
[
{
name: enum ,
parameters: object ,
onSuccess: enum ,
onFailure: enum ,
}
,
]
,
}
,
}
,
provisioningState: enum ,
creationTimeInUtc: string ,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
StorageTasks_Get (updated)
Description Get the storage task properties
Reference Link ¶

⚶ Changes

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageActions/storageTasks/{storageTaskName}
{
resourceGroupName: string ,
storageTaskName: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
properties:
{
taskVersion: integer ,
enabled: boolean ,
description: string ,
action:
{
if:
{
condition: string ,
operations:
[
{
name: enum ,
parameters: object ,
onSuccess: enum ,
onFailure: enum ,
}
,
]
,
}
,
else:
{
operations:
[
{
name: enum ,
parameters: object ,
onSuccess: enum ,
onFailure: enum ,
}
,
]
,
}
,
}
,
provisioningState: enum ,
creationTimeInUtc: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
StorageTasks_Update (updated)
Description Update storage task properties
Reference Link ¶

⚶ Changes

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageActions/storageTasks/{storageTaskName}
{
resourceGroupName: string ,
storageTaskName: string ,
parameters:
{
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
tags: object ,
properties:
{
taskVersion: integer ,
enabled: boolean ,
description: string ,
action:
{
if:
{
condition: string ,
operations:
[
{
name: enum ,
parameters: object ,
onSuccess: enum ,
onFailure: enum ,
}
,
]
,
}
,
else:
{
operations:
[
{
name: enum ,
parameters: object ,
onSuccess: enum ,
onFailure: enum ,
}
,
]
,
}
,
}
,
provisioningState: enum ,
creationTimeInUtc: string ,
}
,
}
,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
properties:
{
taskVersion: integer ,
enabled: boolean ,
description: string ,
action:
{
if:
{
condition: string ,
operations:
[
{
name: enum ,
parameters: object ,
onSuccess: enum ,
onFailure: enum ,
}
,
]
,
}
,
else:
{
operations:
[
{
name: enum ,
parameters: object ,
onSuccess: enum ,
onFailure: enum ,
}
,
]
,
}
,
}
,
provisioningState: enum ,
creationTimeInUtc: string ,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
StorageTasks_ListBySubscription (updated)
Description Lists all the storage tasks available under the subscription.
Reference Link ¶

⚶ Changes

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.StorageActions/storageTasks
{
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
value:
[
{
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
properties:
{
taskVersion: integer ,
enabled: boolean ,
description: string ,
action:
{
if:
{
condition: string ,
operations:
[
{
name: enum ,
parameters: object ,
onSuccess: enum ,
onFailure: enum ,
}
,
]
,
}
,
else:
{
operations:
[
{
name: enum ,
parameters: object ,
onSuccess: enum ,
onFailure: enum ,
}
,
]
,
}
,
}
,
provisioningState: enum ,
creationTimeInUtc: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "provisioningState",
                "Enum": {
                  "new": [
                    [
                      "ValidateSubscriptionQuotaBegin",
                      ""
                    ],
                    [
                      "ValidateSubscriptionQuotaEnd",
                      ""
                    ],
                    [
                      "Accepted",
                      ""
                    ],
                    [
                      "Creating",
                      ""
                    ],
                    [
                      "Succeeded",
                      ""
                    ],
                    [
                      "Deleting",
                      ""
                    ],
                    [
                      "Canceled",
                      ""
                    ],
                    [
                      "Failed",
                      ""
                    ]
                  ],
                  "old": [
                    [
                      "ValidateSubscriptionQuotaBegin",
                      ""
                    ],
                    [
                      "ValidateSubscriptionQuotaEnd",
                      ""
                    ],
                    [
                      "Creating",
                      ""
                    ],
                    [
                      "Succeeded",
                      ""
                    ],
                    [
                      "Deleting",
                      ""
                    ],
                    [
                      "Canceled",
                      ""
                    ],
                    [
                      "Failed",
                      ""
                    ]
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageActions/storageTasks
{
resourceGroupName: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
value:
[
{
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
properties:
{
taskVersion: integer ,
enabled: boolean ,
description: string ,
action:
{
if:
{
condition: string ,
operations:
[
{
name: enum ,
parameters: object ,
onSuccess: enum ,
onFailure: enum ,
}
,
]
,
}
,
else:
{
operations:
[
{
name: enum ,
parameters: object ,
onSuccess: enum ,
onFailure: enum ,
}
,
]
,
}
,
}
,
provisioningState: enum ,
creationTimeInUtc: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}