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 storageMovers/projects/jobDefinitions 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.StorageMover/storageMovers/projects/jobDefinitions resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.StorageMover/storageMovers/projects/jobDefinitions@2025-12-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
agentName: 'string'
connections: [
'string'
]
copyMode: 'string'
dataIntegrityValidation: 'string'
description: 'string'
jobType: 'string'
preservePermissions: bool
schedule: {
cronExpression: 'string'
daysOfMonth: [
int
]
daysOfWeek: [
'string'
]
endDate: 'string'
executionTime: {
hour: int
minute: int
}
frequency: 'string'
isActive: bool
startDate: 'string'
}
sourceName: 'string'
sourceSubpath: 'string'
sourceTargetMap: {}
targetName: 'string'
targetSubpath: 'string'
}
}
Property Values
Microsoft.StorageMover/storageMovers/projects/jobDefinitions
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (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: storageMovers/projects |
| properties | Job definition properties. | JobDefinitionProperties (required) |
JobDefinitionProperties
| Name | Description | Value |
|---|---|---|
| agentName | Name of the Agent to assign for new Job Runs of this Job Definition. | string |
| connections | List of connections associated to this job | string[] |
| copyMode | Strategy to use for copy. | 'Additive' 'Mirror' (required) |
| dataIntegrityValidation | The checksum validation mode for the job definition. | 'None' 'SaveFileMD5' 'SaveVerifyFileMD5' |
| description | A description for the Job Definition. OnPremToCloud is for migrating data from on-premises to cloud. CloudToCloud is for migrating data between cloud to cloud. | string |
| jobType | The type of the Job. | 'CloudToCloud' 'OnPremToCloud' |
| preservePermissions | Boolean to preserve permissions or not. | bool |
| schedule | Schedule information for the Job Definition. | ScheduleInfo |
| sourceName | The name of the source Endpoint. | string (required) |
| sourceSubpath | The subpath to use when reading from the source Endpoint. | string |
| sourceTargetMap | The list of cloud endpoints to migrate. | JobDefinitionPropertiesSourceTargetMap |
| targetName | The name of the target Endpoint. | string (required) |
| targetSubpath | The subpath to use when writing to the target Endpoint. | string |
JobDefinitionPropertiesSourceTargetMap
| Name | Description | Value |
|---|
ScheduleInfo
| Name | Description | Value |
|---|---|---|
| cronExpression | Optional CRON expression for advanced scheduling | string |
| daysOfMonth | Days of the month for monthly schedules | int[] |
| daysOfWeek | Days of the week for weekly schedules | string[] |
| endDate | End time of the schedule (in UTC) | string |
| executionTime | Time of day to execute (hours and minutes) | SchedulerTime |
| frequency | Type of schedule — Monthly, Weekly, or Daily | 'Daily' 'Monthly' 'None' 'Onetime' 'Weekly' |
| isActive | Whether the schedule is currently active | bool |
| startDate | Specific one-time execution date and time | string |
SchedulerTime
| Name | Description | Value |
|---|---|---|
| hour | The hour element of the time. Allowed values range from 0 (start of the selected day) to 24 (end of the selected day). Hour value 24 cannot be combined with any other minute value but 0. | int Constraints: Min value = 0 Max value = 24 |
| minute | The minute element of the time. Allowed values are 0 and 30. If not specified, its value defaults to 0. | int |
ARM template resource definition
The storageMovers/projects/jobDefinitions 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.StorageMover/storageMovers/projects/jobDefinitions resource, add the following JSON to your template.
{
"type": "Microsoft.StorageMover/storageMovers/projects/jobDefinitions",
"apiVersion": "2025-12-01",
"name": "string",
"properties": {
"agentName": "string",
"connections": [ "string" ],
"copyMode": "string",
"dataIntegrityValidation": "string",
"description": "string",
"jobType": "string",
"preservePermissions": "bool",
"schedule": {
"cronExpression": "string",
"daysOfMonth": [ "int" ],
"daysOfWeek": [ "string" ],
"endDate": "string",
"executionTime": {
"hour": "int",
"minute": "int"
},
"frequency": "string",
"isActive": "bool",
"startDate": "string"
},
"sourceName": "string",
"sourceSubpath": "string",
"sourceTargetMap": {
},
"targetName": "string",
"targetSubpath": "string"
}
}
Property Values
Microsoft.StorageMover/storageMovers/projects/jobDefinitions
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2025-12-01' |
| name | The resource name | string (required) |
| properties | Job definition properties. | JobDefinitionProperties (required) |
| type | The resource type | 'Microsoft.StorageMover/storageMovers/projects/jobDefinitions' |
JobDefinitionProperties
| Name | Description | Value |
|---|---|---|
| agentName | Name of the Agent to assign for new Job Runs of this Job Definition. | string |
| connections | List of connections associated to this job | string[] |
| copyMode | Strategy to use for copy. | 'Additive' 'Mirror' (required) |
| dataIntegrityValidation | The checksum validation mode for the job definition. | 'None' 'SaveFileMD5' 'SaveVerifyFileMD5' |
| description | A description for the Job Definition. OnPremToCloud is for migrating data from on-premises to cloud. CloudToCloud is for migrating data between cloud to cloud. | string |
| jobType | The type of the Job. | 'CloudToCloud' 'OnPremToCloud' |
| preservePermissions | Boolean to preserve permissions or not. | bool |
| schedule | Schedule information for the Job Definition. | ScheduleInfo |
| sourceName | The name of the source Endpoint. | string (required) |
| sourceSubpath | The subpath to use when reading from the source Endpoint. | string |
| sourceTargetMap | The list of cloud endpoints to migrate. | JobDefinitionPropertiesSourceTargetMap |
| targetName | The name of the target Endpoint. | string (required) |
| targetSubpath | The subpath to use when writing to the target Endpoint. | string |
JobDefinitionPropertiesSourceTargetMap
| Name | Description | Value |
|---|
ScheduleInfo
| Name | Description | Value |
|---|---|---|
| cronExpression | Optional CRON expression for advanced scheduling | string |
| daysOfMonth | Days of the month for monthly schedules | int[] |
| daysOfWeek | Days of the week for weekly schedules | string[] |
| endDate | End time of the schedule (in UTC) | string |
| executionTime | Time of day to execute (hours and minutes) | SchedulerTime |
| frequency | Type of schedule — Monthly, Weekly, or Daily | 'Daily' 'Monthly' 'None' 'Onetime' 'Weekly' |
| isActive | Whether the schedule is currently active | bool |
| startDate | Specific one-time execution date and time | string |
SchedulerTime
| Name | Description | Value |
|---|---|---|
| hour | The hour element of the time. Allowed values range from 0 (start of the selected day) to 24 (end of the selected day). Hour value 24 cannot be combined with any other minute value but 0. | int Constraints: Min value = 0 Max value = 24 |
| minute | The minute element of the time. Allowed values are 0 and 30. If not specified, its value defaults to 0. | int |
Usage Examples
Terraform (AzAPI provider) resource definition
The storageMovers/projects/jobDefinitions 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.StorageMover/storageMovers/projects/jobDefinitions resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.StorageMover/storageMovers/projects/jobDefinitions@2025-12-01"
name = "string"
parent_id = "string"
body = {
properties = {
agentName = "string"
connections = [
"string"
]
copyMode = "string"
dataIntegrityValidation = "string"
description = "string"
jobType = "string"
preservePermissions = bool
schedule = {
cronExpression = "string"
daysOfMonth = [
int
]
daysOfWeek = [
"string"
]
endDate = "string"
executionTime = {
hour = int
minute = int
}
frequency = "string"
isActive = bool
startDate = "string"
}
sourceName = "string"
sourceSubpath = "string"
sourceTargetMap = {
}
targetName = "string"
targetSubpath = "string"
}
}
}
Property Values
Microsoft.StorageMover/storageMovers/projects/jobDefinitions
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: storageMovers/projects |
| properties | Job definition properties. | JobDefinitionProperties (required) |
| type | The resource type | "Microsoft.StorageMover/storageMovers/projects/jobDefinitions@2025-12-01" |
JobDefinitionProperties
| Name | Description | Value |
|---|---|---|
| agentName | Name of the Agent to assign for new Job Runs of this Job Definition. | string |
| connections | List of connections associated to this job | string[] |
| copyMode | Strategy to use for copy. | 'Additive' 'Mirror' (required) |
| dataIntegrityValidation | The checksum validation mode for the job definition. | 'None' 'SaveFileMD5' 'SaveVerifyFileMD5' |
| description | A description for the Job Definition. OnPremToCloud is for migrating data from on-premises to cloud. CloudToCloud is for migrating data between cloud to cloud. | string |
| jobType | The type of the Job. | 'CloudToCloud' 'OnPremToCloud' |
| preservePermissions | Boolean to preserve permissions or not. | bool |
| schedule | Schedule information for the Job Definition. | ScheduleInfo |
| sourceName | The name of the source Endpoint. | string (required) |
| sourceSubpath | The subpath to use when reading from the source Endpoint. | string |
| sourceTargetMap | The list of cloud endpoints to migrate. | JobDefinitionPropertiesSourceTargetMap |
| targetName | The name of the target Endpoint. | string (required) |
| targetSubpath | The subpath to use when writing to the target Endpoint. | string |
JobDefinitionPropertiesSourceTargetMap
| Name | Description | Value |
|---|
ScheduleInfo
| Name | Description | Value |
|---|---|---|
| cronExpression | Optional CRON expression for advanced scheduling | string |
| daysOfMonth | Days of the month for monthly schedules | int[] |
| daysOfWeek | Days of the week for weekly schedules | string[] |
| endDate | End time of the schedule (in UTC) | string |
| executionTime | Time of day to execute (hours and minutes) | SchedulerTime |
| frequency | Type of schedule — Monthly, Weekly, or Daily | 'Daily' 'Monthly' 'None' 'Onetime' 'Weekly' |
| isActive | Whether the schedule is currently active | bool |
| startDate | Specific one-time execution date and time | string |
SchedulerTime
| Name | Description | Value |
|---|---|---|
| hour | The hour element of the time. Allowed values range from 0 (start of the selected day) to 24 (end of the selected day). Hour value 24 cannot be combined with any other minute value but 0. | int Constraints: Min value = 0 Max value = 24 |
| minute | The minute element of the time. Allowed values are 0 and 30. If not specified, its value defaults to 0. | int |