Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The storageAccounts/storageTaskAssignments resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Storage/storageAccounts/storageTaskAssignments resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Storage/storageAccounts/storageTaskAssignments@2023-05-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
description: 'string'
enabled: bool
executionContext: {
target: {
excludePrefix: [
'string'
]
prefix: [
'string'
]
}
trigger: {
parameters: {
endBy: 'string'
interval: int
intervalUnit: 'Days'
startFrom: 'string'
startOn: 'string'
}
type: 'string'
}
}
report: {
prefix: 'string'
}
runStatus: {}
taskId: 'string'
}
}
Property Values
ExecutionTarget
| Name | Description | Value |
|---|---|---|
| excludePrefix | List of object prefixes to be excluded from task execution. If there is a conflict between include and exclude prefixes, the exclude prefix will be the determining factor | string[] |
| prefix | Required list of object prefixes to be included for task execution | string[] |
ExecutionTrigger
| Name | Description | Value |
|---|---|---|
| parameters | The trigger parameters of the storage task assignment execution | TriggerParameters (required) |
| type | The trigger type of the storage task assignment execution | 'OnSchedule' 'RunOnce' (required) |
Microsoft.Storage/storageAccounts/storageTaskAssignments
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Min length = 3 Max length = 24 Pattern = ^[a-z0-9]{3,24}$ (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: storageAccounts |
| properties | Properties of the storage task assignment. | StorageTaskAssignmentProperties (required) |
StorageTaskAssignmentExecutionContext
| Name | Description | Value |
|---|---|---|
| target | Execution target of the storage task assignment | ExecutionTarget |
| trigger | Execution trigger of the storage task assignment | ExecutionTrigger (required) |
StorageTaskAssignmentProperties
| Name | Description | Value |
|---|---|---|
| description | Text that describes the purpose of the storage task assignment | string (required) |
| enabled | Whether the storage task assignment is enabled or not | bool (required) |
| executionContext | The storage task assignment execution context | StorageTaskAssignmentExecutionContext (required) |
| report | The storage task assignment report | StorageTaskAssignmentReport (required) |
| runStatus | Run status of storage task assignment | StorageTaskReportProperties |
| taskId | Id of the corresponding storage task | string (required) |
StorageTaskAssignmentReport
| Name | Description | Value |
|---|---|---|
| prefix | The container prefix for the location of storage task assignment report | string (required) |
StorageTaskReportProperties
| Name | Description | Value |
|---|
TriggerParameters
| Name | Description | Value |
|---|---|---|
| endBy | When to end task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' | string |
| interval | Run interval of task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' | int Constraints: Min value = 1 |
| intervalUnit | Run interval unit of task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' | 'Days' |
| startFrom | When to start task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' | string |
| startOn | When to start task execution. This is an optional field when ExecutionTrigger.properties.type is 'RunOnce'; this property should not be present when ExecutionTrigger.properties.type is 'OnSchedule' | string |
ARM template resource definition
The storageAccounts/storageTaskAssignments resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Storage/storageAccounts/storageTaskAssignments resource, add the following JSON to your template.
{
"type": "Microsoft.Storage/storageAccounts/storageTaskAssignments",
"apiVersion": "2023-05-01",
"name": "string",
"properties": {
"description": "string",
"enabled": "bool",
"executionContext": {
"target": {
"excludePrefix": [ "string" ],
"prefix": [ "string" ]
},
"trigger": {
"parameters": {
"endBy": "string",
"interval": "int",
"intervalUnit": "Days",
"startFrom": "string",
"startOn": "string"
},
"type": "string"
}
},
"report": {
"prefix": "string"
},
"runStatus": {
},
"taskId": "string"
}
}
Property Values
ExecutionTarget
| Name | Description | Value |
|---|---|---|
| excludePrefix | List of object prefixes to be excluded from task execution. If there is a conflict between include and exclude prefixes, the exclude prefix will be the determining factor | string[] |
| prefix | Required list of object prefixes to be included for task execution | string[] |
ExecutionTrigger
| Name | Description | Value |
|---|---|---|
| parameters | The trigger parameters of the storage task assignment execution | TriggerParameters (required) |
| type | The trigger type of the storage task assignment execution | 'OnSchedule' 'RunOnce' (required) |
Microsoft.Storage/storageAccounts/storageTaskAssignments
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-05-01' |
| name | The resource name | string Constraints: Min length = 3 Max length = 24 Pattern = ^[a-z0-9]{3,24}$ (required) |
| properties | Properties of the storage task assignment. | StorageTaskAssignmentProperties (required) |
| type | The resource type | 'Microsoft.Storage/storageAccounts/storageTaskAssignments' |
StorageTaskAssignmentExecutionContext
| Name | Description | Value |
|---|---|---|
| target | Execution target of the storage task assignment | ExecutionTarget |
| trigger | Execution trigger of the storage task assignment | ExecutionTrigger (required) |
StorageTaskAssignmentProperties
| Name | Description | Value |
|---|---|---|
| description | Text that describes the purpose of the storage task assignment | string (required) |
| enabled | Whether the storage task assignment is enabled or not | bool (required) |
| executionContext | The storage task assignment execution context | StorageTaskAssignmentExecutionContext (required) |
| report | The storage task assignment report | StorageTaskAssignmentReport (required) |
| runStatus | Run status of storage task assignment | StorageTaskReportProperties |
| taskId | Id of the corresponding storage task | string (required) |
StorageTaskAssignmentReport
| Name | Description | Value |
|---|---|---|
| prefix | The container prefix for the location of storage task assignment report | string (required) |
StorageTaskReportProperties
| Name | Description | Value |
|---|
TriggerParameters
| Name | Description | Value |
|---|---|---|
| endBy | When to end task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' | string |
| interval | Run interval of task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' | int Constraints: Min value = 1 |
| intervalUnit | Run interval unit of task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' | 'Days' |
| startFrom | When to start task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' | string |
| startOn | When to start task execution. This is an optional field when ExecutionTrigger.properties.type is 'RunOnce'; this property should not be present when ExecutionTrigger.properties.type is 'OnSchedule' | string |
Usage Examples
Terraform (AzAPI provider) resource definition
The storageAccounts/storageTaskAssignments resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Storage/storageAccounts/storageTaskAssignments resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Storage/storageAccounts/storageTaskAssignments@2023-05-01"
name = "string"
parent_id = "string"
body = {
properties = {
description = "string"
enabled = bool
executionContext = {
target = {
excludePrefix = [
"string"
]
prefix = [
"string"
]
}
trigger = {
parameters = {
endBy = "string"
interval = int
intervalUnit = "Days"
startFrom = "string"
startOn = "string"
}
type = "string"
}
}
report = {
prefix = "string"
}
runStatus = {
}
taskId = "string"
}
}
}
Property Values
ExecutionTarget
| Name | Description | Value |
|---|---|---|
| excludePrefix | List of object prefixes to be excluded from task execution. If there is a conflict between include and exclude prefixes, the exclude prefix will be the determining factor | string[] |
| prefix | Required list of object prefixes to be included for task execution | string[] |
ExecutionTrigger
| Name | Description | Value |
|---|---|---|
| parameters | The trigger parameters of the storage task assignment execution | TriggerParameters (required) |
| type | The trigger type of the storage task assignment execution | 'OnSchedule' 'RunOnce' (required) |
Microsoft.Storage/storageAccounts/storageTaskAssignments
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Min length = 3 Max length = 24 Pattern = ^[a-z0-9]{3,24}$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: storageAccounts |
| properties | Properties of the storage task assignment. | StorageTaskAssignmentProperties (required) |
| type | The resource type | "Microsoft.Storage/storageAccounts/storageTaskAssignments@2023-05-01" |
StorageTaskAssignmentExecutionContext
| Name | Description | Value |
|---|---|---|
| target | Execution target of the storage task assignment | ExecutionTarget |
| trigger | Execution trigger of the storage task assignment | ExecutionTrigger (required) |
StorageTaskAssignmentProperties
| Name | Description | Value |
|---|---|---|
| description | Text that describes the purpose of the storage task assignment | string (required) |
| enabled | Whether the storage task assignment is enabled or not | bool (required) |
| executionContext | The storage task assignment execution context | StorageTaskAssignmentExecutionContext (required) |
| report | The storage task assignment report | StorageTaskAssignmentReport (required) |
| runStatus | Run status of storage task assignment | StorageTaskReportProperties |
| taskId | Id of the corresponding storage task | string (required) |
StorageTaskAssignmentReport
| Name | Description | Value |
|---|---|---|
| prefix | The container prefix for the location of storage task assignment report | string (required) |
StorageTaskReportProperties
| Name | Description | Value |
|---|
TriggerParameters
| Name | Description | Value |
|---|---|---|
| endBy | When to end task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' | string |
| interval | Run interval of task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' | int Constraints: Min value = 1 |
| intervalUnit | Run interval unit of task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' | 'Days' |
| startFrom | When to start task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' | string |
| startOn | When to start task execution. This is an optional field when ExecutionTrigger.properties.type is 'RunOnce'; this property should not be present when ExecutionTrigger.properties.type is 'OnSchedule' | string |