Microsoft.StorageMover (stable:2024-07-01)

2025/08/20 • 4 updated methods

JobDefinitions_List (updated)
Description :  Lists all Job Definitions in a Project.
Reference :  Link ¶

⚶ Changes

{
  "#id": "JobDefinitions_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "description",
                "Description": {
                  "new": "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.",
                  "old": "A description for the Job Definition."
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/projects/{projectName}/jobDefinitions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storageMoverName:
{
Description: The name of the Storage Mover resource. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the Project resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The JobDefinition items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Job definition properties. ,
Required: True ,
}
{
description:
{
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. ,
Required: False ,
}
string ,
copyMode:
{
Description: Strategy to use for copy. ,
Enum:
{
Additive: No description available. ,
Mirror: No description available. ,
}
,
Required: True ,
}
enum ,
sourceName:
{
Description: The name of the source Endpoint. ,
Required: True ,
}
string ,
sourceResourceId:
{
Description: Fully qualified resource ID of the source Endpoint. ,
Required: False ,
}
string ,
sourceSubpath:
{
Description: The subpath to use when reading from the source Endpoint. ,
Required: False ,
}
string ,
targetName:
{
Description: The name of the target Endpoint. ,
Required: True ,
}
string ,
targetResourceId:
{
Description: Fully qualified resource ID of the target Endpoint. ,
Required: False ,
}
string ,
targetSubpath:
{
Description: The subpath to use when writing to the target Endpoint. ,
Required: False ,
}
string ,
latestJobRunName:
{
Description: The name of the Job Run in a non-terminal state, if exists. ,
Required: False ,
}
string ,
latestJobRunResourceId:
{
Description: The fully qualified resource ID of the Job Run in a non-terminal state, if exists. ,
Required: False ,
}
string ,
latestJobRunStatus:
{
Description: The current status of the Job Run in a non-terminal state, if exists. ,
Enum:
{
Queued: No description available. ,
Started: No description available. ,
Running: No description available. ,
CancelRequested: No description available. ,
Canceling: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
PausedByBandwidthManagement: No description available. ,
}
,
Required: False ,
}
enum ,
agentName:
{
Description: Name of the Agent to assign for new Job Runs of this Job Definition. ,
Required: False ,
}
string ,
agentResourceId:
{
Description: Fully qualified resource id of the Agent to assign for new Job Runs of this Job Definition. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of this resource. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleting: 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 ,
}
,
]
,
}
,
}
JobDefinitions_Get (updated)
Description :  Gets a Job Definition resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "JobDefinitions_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "description",
            "Description": {
              "new": "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.",
              "old": "A description for the Job Definition."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/projects/{projectName}/jobDefinitions/{jobDefinitionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storageMoverName:
{
Description: The name of the Storage Mover resource. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the Project resource. ,
Required: True ,
}
string ,
jobDefinitionName:
{
Description: The name of the Job Definition resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Job definition properties. ,
Required: True ,
}
{
description:
{
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. ,
Required: False ,
}
string ,
copyMode:
{
Description: Strategy to use for copy. ,
Enum:
{
Additive: No description available. ,
Mirror: No description available. ,
}
,
Required: True ,
}
enum ,
sourceName:
{
Description: The name of the source Endpoint. ,
Required: True ,
}
string ,
sourceResourceId:
{
Description: Fully qualified resource ID of the source Endpoint. ,
Required: False ,
}
string ,
sourceSubpath:
{
Description: The subpath to use when reading from the source Endpoint. ,
Required: False ,
}
string ,
targetName:
{
Description: The name of the target Endpoint. ,
Required: True ,
}
string ,
targetResourceId:
{
Description: Fully qualified resource ID of the target Endpoint. ,
Required: False ,
}
string ,
targetSubpath:
{
Description: The subpath to use when writing to the target Endpoint. ,
Required: False ,
}
string ,
latestJobRunName:
{
Description: The name of the Job Run in a non-terminal state, if exists. ,
Required: False ,
}
string ,
latestJobRunResourceId:
{
Description: The fully qualified resource ID of the Job Run in a non-terminal state, if exists. ,
Required: False ,
}
string ,
latestJobRunStatus:
{
Description: The current status of the Job Run in a non-terminal state, if exists. ,
Enum:
{
Queued: No description available. ,
Started: No description available. ,
Running: No description available. ,
CancelRequested: No description available. ,
Canceling: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
PausedByBandwidthManagement: No description available. ,
}
,
Required: False ,
}
enum ,
agentName:
{
Description: Name of the Agent to assign for new Job Runs of this Job Definition. ,
Required: False ,
}
string ,
agentResourceId:
{
Description: Fully qualified resource id of the Agent to assign for new Job Runs of this Job Definition. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of this resource. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
JobDefinitions_CreateOrUpdate (updated)
Description :  Creates or updates a Job Definition resource, which contains configuration for a single unit of managed data transfer.
Reference :  Link ¶

⚶ Changes

{
  "#id": "JobDefinitions_CreateOrUpdate",
  "$parameters": {
    "jobDefinition": {
      "$properties": {
        "properties": [
          {
            "#name": "description",
            "Description": {
              "new": "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.",
              "old": "A description for the Job Definition."
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "description",
            "Description": {
              "new": "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.",
              "old": "A description for the Job Definition."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/projects/{projectName}/jobDefinitions/{jobDefinitionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storageMoverName:
{
Description: The name of the Storage Mover resource. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the Project resource. ,
Required: True ,
}
string ,
jobDefinitionName:
{
Description: The name of the Job Definition resource. ,
Required: True ,
}
string ,
jobDefinition:
{
Required: True ,
}
{
properties:
{
Description: Job definition properties. ,
Required: True ,
}
{
description:
{
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. ,
Required: False ,
}
string ,
copyMode:
{
Description: Strategy to use for copy. ,
Enum:
{
Additive: No description available. ,
Mirror: No description available. ,
}
,
Required: True ,
}
enum ,
sourceName:
{
Description: The name of the source Endpoint. ,
Required: True ,
}
string ,
sourceResourceId:
{
Description: Fully qualified resource ID of the source Endpoint. ,
Required: False ,
}
string ,
sourceSubpath:
{
Description: The subpath to use when reading from the source Endpoint. ,
Required: False ,
}
string ,
targetName:
{
Description: The name of the target Endpoint. ,
Required: True ,
}
string ,
targetResourceId:
{
Description: Fully qualified resource ID of the target Endpoint. ,
Required: False ,
}
string ,
targetSubpath:
{
Description: The subpath to use when writing to the target Endpoint. ,
Required: False ,
}
string ,
latestJobRunName:
{
Description: The name of the Job Run in a non-terminal state, if exists. ,
Required: False ,
}
string ,
latestJobRunResourceId:
{
Description: The fully qualified resource ID of the Job Run in a non-terminal state, if exists. ,
Required: False ,
}
string ,
latestJobRunStatus:
{
Description: The current status of the Job Run in a non-terminal state, if exists. ,
Enum:
{
Queued: No description available. ,
Started: No description available. ,
Running: No description available. ,
CancelRequested: No description available. ,
Canceling: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
PausedByBandwidthManagement: No description available. ,
}
,
Required: False ,
}
enum ,
agentName:
{
Description: Name of the Agent to assign for new Job Runs of this Job Definition. ,
Required: False ,
}
string ,
agentResourceId:
{
Description: Fully qualified resource id of the Agent to assign for new Job Runs of this Job Definition. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of this resource. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Job definition properties. ,
Required: True ,
}
{
description:
{
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. ,
Required: False ,
}
string ,
copyMode:
{
Description: Strategy to use for copy. ,
Enum:
{
Additive: No description available. ,
Mirror: No description available. ,
}
,
Required: True ,
}
enum ,
sourceName:
{
Description: The name of the source Endpoint. ,
Required: True ,
}
string ,
sourceResourceId:
{
Description: Fully qualified resource ID of the source Endpoint. ,
Required: False ,
}
string ,
sourceSubpath:
{
Description: The subpath to use when reading from the source Endpoint. ,
Required: False ,
}
string ,
targetName:
{
Description: The name of the target Endpoint. ,
Required: True ,
}
string ,
targetResourceId:
{
Description: Fully qualified resource ID of the target Endpoint. ,
Required: False ,
}
string ,
targetSubpath:
{
Description: The subpath to use when writing to the target Endpoint. ,
Required: False ,
}
string ,
latestJobRunName:
{
Description: The name of the Job Run in a non-terminal state, if exists. ,
Required: False ,
}
string ,
latestJobRunResourceId:
{
Description: The fully qualified resource ID of the Job Run in a non-terminal state, if exists. ,
Required: False ,
}
string ,
latestJobRunStatus:
{
Description: The current status of the Job Run in a non-terminal state, if exists. ,
Enum:
{
Queued: No description available. ,
Started: No description available. ,
Running: No description available. ,
CancelRequested: No description available. ,
Canceling: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
PausedByBandwidthManagement: No description available. ,
}
,
Required: False ,
}
enum ,
agentName:
{
Description: Name of the Agent to assign for new Job Runs of this Job Definition. ,
Required: False ,
}
string ,
agentResourceId:
{
Description: Fully qualified resource id of the Agent to assign for new Job Runs of this Job Definition. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of this resource. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
JobDefinitions_Update (updated)
Description :  Updates properties for a Job Definition resource. Properties not specified in the request body will be unchanged.
Reference :  Link ¶

⚶ Changes

{
  "#id": "JobDefinitions_Update",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "description",
            "Description": {
              "new": "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.",
              "old": "A description for the Job Definition."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/projects/{projectName}/jobDefinitions/{jobDefinitionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storageMoverName:
{
Description: The name of the Storage Mover resource. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the Project resource. ,
Required: True ,
}
string ,
jobDefinitionName:
{
Description: The name of the Job Definition resource. ,
Required: True ,
}
string ,
jobDefinition:
{
Required: True ,
}
{
properties:
{
Description: Job definition properties. ,
Required: False ,
}
{
description:
{
Description: A description for the Job Definition. ,
Required: False ,
}
string ,
copyMode:
{
Description: Strategy to use for copy. ,
Enum:
{
Additive: No description available. ,
Mirror: No description available. ,
}
,
Required: False ,
}
enum ,
agentName:
{
Description: Name of the Agent to assign for new Job Runs of this Job Definition. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Job definition properties. ,
Required: True ,
}
{
description:
{
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. ,
Required: False ,
}
string ,
copyMode:
{
Description: Strategy to use for copy. ,
Enum:
{
Additive: No description available. ,
Mirror: No description available. ,
}
,
Required: True ,
}
enum ,
sourceName:
{
Description: The name of the source Endpoint. ,
Required: True ,
}
string ,
sourceResourceId:
{
Description: Fully qualified resource ID of the source Endpoint. ,
Required: False ,
}
string ,
sourceSubpath:
{
Description: The subpath to use when reading from the source Endpoint. ,
Required: False ,
}
string ,
targetName:
{
Description: The name of the target Endpoint. ,
Required: True ,
}
string ,
targetResourceId:
{
Description: Fully qualified resource ID of the target Endpoint. ,
Required: False ,
}
string ,
targetSubpath:
{
Description: The subpath to use when writing to the target Endpoint. ,
Required: False ,
}
string ,
latestJobRunName:
{
Description: The name of the Job Run in a non-terminal state, if exists. ,
Required: False ,
}
string ,
latestJobRunResourceId:
{
Description: The fully qualified resource ID of the Job Run in a non-terminal state, if exists. ,
Required: False ,
}
string ,
latestJobRunStatus:
{
Description: The current status of the Job Run in a non-terminal state, if exists. ,
Enum:
{
Queued: No description available. ,
Started: No description available. ,
Running: No description available. ,
CancelRequested: No description available. ,
Canceling: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
PausedByBandwidthManagement: No description available. ,
}
,
Required: False ,
}
enum ,
agentName:
{
Description: Name of the Agent to assign for new Job Runs of this Job Definition. ,
Required: False ,
}
string ,
agentResourceId:
{
Description: Fully qualified resource id of the Agent to assign for new Job Runs of this Job Definition. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of this resource. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}