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

2025/08/20 • 31 new methods

Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.StorageMover/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
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 ,
}
,
]
,
}
,
}
StorageMovers_ListBySubscription (new)
Description :  Lists all Storage Movers in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.StorageMover/storageMovers
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The StorageMover items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource specific properties for the Storage Mover resource. ,
Required: False ,
}
{
description:
{
Description: A description for the Storage Mover. ,
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 ,
}
,
]
,
}
,
}
StorageMovers_List (new)
Description :  Lists all Storage Movers in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The StorageMover items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource specific properties for the Storage Mover resource. ,
Required: False ,
}
{
description:
{
Description: A description for the Storage Mover. ,
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 ,
}
,
]
,
}
,
}
StorageMovers_Get (new)
Description :  Gets a Storage Mover resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}
{
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 ,
}

⚐ Response (200)

{
properties:
{
Description: The resource specific properties for the Storage Mover resource. ,
Required: False ,
}
{
description:
{
Description: A description for the Storage Mover. ,
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 ,
}
,
]
,
}
,
}
StorageMovers_CreateOrUpdate (new)
Description :  Creates or updates a top-level Storage Mover resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}
{
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 ,
storageMover:
{
Required: True ,
}
{
properties:
{
Description: The resource specific properties for the Storage Mover resource. ,
Required: False ,
}
{
description:
{
Description: A description for the Storage Mover. ,
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: The resource specific properties for the Storage Mover resource. ,
Required: False ,
}
{
description:
{
Description: A description for the Storage Mover. ,
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 ,
}
,
]
,
}
,
}
StorageMovers_Update (new)
Description :  Updates properties for a Storage Mover resource. Properties not specified in the request body will be unchanged.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}
{
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 ,
storageMover:
{
Required: True ,
}
{
properties:
{
Description: The resource specific properties for the Storage Mover resource. ,
Required: False ,
}
{
description:
{
Description: A description for the Storage Mover. ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource specific properties for the Storage Mover resource. ,
Required: False ,
}
{
description:
{
Description: A description for the Storage Mover. ,
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 ,
}
,
]
,
}
,
}
StorageMovers_Delete (new)
Description :  Deletes a Storage Mover resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}
{
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 ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Agents_List (new)
Description :  Lists all Agents in a Storage Mover.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/agents
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The Agent items on this page ,
Required: True ,
}
[
{
properties:
{
Required: True ,
}
{
description:
{
Description: A description for the Agent. ,
Required: False ,
}
string ,
agentVersion:
{
Description: The Agent version. ,
Required: False ,
}
string ,
arcResourceId:
{
Description: The fully qualified resource ID of the Hybrid Compute resource for the Agent. ,
Required: True ,
}
string ,
arcVmUuid:
{
Description: The VM UUID of the Hybrid Compute resource for the Agent. ,
Required: True ,
}
string ,
agentStatus:
{
Description: The Agent status. ,
Enum:
{
Registering: No description available. ,
Offline: No description available. ,
Online: No description available. ,
Executing: No description available. ,
RequiresAttention: No description available. ,
Unregistering: No description available. ,
}
,
Required: False ,
}
enum ,
lastStatusUpdate:
{
Description: The last updated time of the Agent status. ,
Format: date-time ,
Required: False ,
}
string ,
localIPAddress:
{
Description: Local IP address reported by the Agent. ,
Required: False ,
}
string ,
memoryInMB:
{
Description: Available memory reported by the Agent, in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfCores:
{
Description: Available compute cores reported by the Agent. ,
Format: int64 ,
Required: False ,
}
integer ,
uptimeInSeconds:
{
Description: Uptime of the Agent in seconds. ,
Format: int64 ,
Required: False ,
}
integer ,
timeZone:
{
Description: The agent's local time zone represented in Windows format. ,
Required: False ,
}
string ,
uploadLimitSchedule:
{
Description: The WAN-link upload limit schedule that applies to any Job Run the agent executes. Data plane operations (migrating files) are affected. Control plane operations ensure seamless migration functionality and are not limited by this schedule. The schedule is interpreted with the agent's local time. ,
Required: False ,
}
{
weeklyRecurrences:
{
Description: The set of weekly repeating recurrences of the WAN-link upload limit schedule. ,
Required: False ,
}
[
{
limitInMbps:
{
Description: The WAN-link upload bandwidth (maximum data transfer rate) in megabits per second. Value of 0 indicates no throughput is allowed and any running migration job is effectively paused for the duration of this recurrence. Only data plane operations are governed by this limit. Control plane operations ensure seamless functionality. The agent may exceed this limit with control messages, if necessary. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
errorDetails:
{
Required: False ,
}
{
code:
{
Description: Error code reported by Agent ,
Required: False ,
}
string ,
message:
{
Description: Expanded description of reported error code ,
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 ,
}
,
]
,
}
,
}
Agents_Get (new)
Description :  Gets an Agent resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/agents/{agentName}
{
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 ,
agentName:
{
Description: The name of the Agent resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: True ,
}
{
description:
{
Description: A description for the Agent. ,
Required: False ,
}
string ,
agentVersion:
{
Description: The Agent version. ,
Required: False ,
}
string ,
arcResourceId:
{
Description: The fully qualified resource ID of the Hybrid Compute resource for the Agent. ,
Required: True ,
}
string ,
arcVmUuid:
{
Description: The VM UUID of the Hybrid Compute resource for the Agent. ,
Required: True ,
}
string ,
agentStatus:
{
Description: The Agent status. ,
Enum:
{
Registering: No description available. ,
Offline: No description available. ,
Online: No description available. ,
Executing: No description available. ,
RequiresAttention: No description available. ,
Unregistering: No description available. ,
}
,
Required: False ,
}
enum ,
lastStatusUpdate:
{
Description: The last updated time of the Agent status. ,
Format: date-time ,
Required: False ,
}
string ,
localIPAddress:
{
Description: Local IP address reported by the Agent. ,
Required: False ,
}
string ,
memoryInMB:
{
Description: Available memory reported by the Agent, in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfCores:
{
Description: Available compute cores reported by the Agent. ,
Format: int64 ,
Required: False ,
}
integer ,
uptimeInSeconds:
{
Description: Uptime of the Agent in seconds. ,
Format: int64 ,
Required: False ,
}
integer ,
timeZone:
{
Description: The agent's local time zone represented in Windows format. ,
Required: False ,
}
string ,
uploadLimitSchedule:
{
Description: The WAN-link upload limit schedule that applies to any Job Run the agent executes. Data plane operations (migrating files) are affected. Control plane operations ensure seamless migration functionality and are not limited by this schedule. The schedule is interpreted with the agent's local time. ,
Required: False ,
}
{
weeklyRecurrences:
{
Description: The set of weekly repeating recurrences of the WAN-link upload limit schedule. ,
Required: False ,
}
[
{
limitInMbps:
{
Description: The WAN-link upload bandwidth (maximum data transfer rate) in megabits per second. Value of 0 indicates no throughput is allowed and any running migration job is effectively paused for the duration of this recurrence. Only data plane operations are governed by this limit. Control plane operations ensure seamless functionality. The agent may exceed this limit with control messages, if necessary. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
errorDetails:
{
Required: False ,
}
{
code:
{
Description: Error code reported by Agent ,
Required: False ,
}
string ,
message:
{
Description: Expanded description of reported error code ,
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 ,
}
,
]
,
}
,
}
Agents_CreateOrUpdate (new)
Description :  Creates or updates an Agent resource, which references a hybrid compute machine that can run jobs.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/agents/{agentName}
{
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 ,
agentName:
{
Description: The name of the Agent resource. ,
Required: True ,
}
string ,
agent:
{
Required: True ,
}
{
properties:
{
Required: True ,
}
{
description:
{
Description: A description for the Agent. ,
Required: False ,
}
string ,
agentVersion:
{
Description: The Agent version. ,
Required: False ,
}
string ,
arcResourceId:
{
Description: The fully qualified resource ID of the Hybrid Compute resource for the Agent. ,
Required: True ,
}
string ,
arcVmUuid:
{
Description: The VM UUID of the Hybrid Compute resource for the Agent. ,
Required: True ,
}
string ,
agentStatus:
{
Description: The Agent status. ,
Enum:
{
Registering: No description available. ,
Offline: No description available. ,
Online: No description available. ,
Executing: No description available. ,
RequiresAttention: No description available. ,
Unregistering: No description available. ,
}
,
Required: False ,
}
enum ,
lastStatusUpdate:
{
Description: The last updated time of the Agent status. ,
Format: date-time ,
Required: False ,
}
string ,
localIPAddress:
{
Description: Local IP address reported by the Agent. ,
Required: False ,
}
string ,
memoryInMB:
{
Description: Available memory reported by the Agent, in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfCores:
{
Description: Available compute cores reported by the Agent. ,
Format: int64 ,
Required: False ,
}
integer ,
uptimeInSeconds:
{
Description: Uptime of the Agent in seconds. ,
Format: int64 ,
Required: False ,
}
integer ,
timeZone:
{
Description: The agent's local time zone represented in Windows format. ,
Required: False ,
}
string ,
uploadLimitSchedule:
{
Description: The WAN-link upload limit schedule that applies to any Job Run the agent executes. Data plane operations (migrating files) are affected. Control plane operations ensure seamless migration functionality and are not limited by this schedule. The schedule is interpreted with the agent's local time. ,
Required: False ,
}
{
weeklyRecurrences:
{
Description: The set of weekly repeating recurrences of the WAN-link upload limit schedule. ,
Required: False ,
}
[
{
limitInMbps:
{
Description: The WAN-link upload bandwidth (maximum data transfer rate) in megabits per second. Value of 0 indicates no throughput is allowed and any running migration job is effectively paused for the duration of this recurrence. Only data plane operations are governed by this limit. Control plane operations ensure seamless functionality. The agent may exceed this limit with control messages, if necessary. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
errorDetails:
{
Required: False ,
}
{
code:
{
Description: Error code reported by Agent ,
Required: False ,
}
string ,
message:
{
Description: Expanded description of reported error code ,
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:
{
Required: True ,
}
{
description:
{
Description: A description for the Agent. ,
Required: False ,
}
string ,
agentVersion:
{
Description: The Agent version. ,
Required: False ,
}
string ,
arcResourceId:
{
Description: The fully qualified resource ID of the Hybrid Compute resource for the Agent. ,
Required: True ,
}
string ,
arcVmUuid:
{
Description: The VM UUID of the Hybrid Compute resource for the Agent. ,
Required: True ,
}
string ,
agentStatus:
{
Description: The Agent status. ,
Enum:
{
Registering: No description available. ,
Offline: No description available. ,
Online: No description available. ,
Executing: No description available. ,
RequiresAttention: No description available. ,
Unregistering: No description available. ,
}
,
Required: False ,
}
enum ,
lastStatusUpdate:
{
Description: The last updated time of the Agent status. ,
Format: date-time ,
Required: False ,
}
string ,
localIPAddress:
{
Description: Local IP address reported by the Agent. ,
Required: False ,
}
string ,
memoryInMB:
{
Description: Available memory reported by the Agent, in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfCores:
{
Description: Available compute cores reported by the Agent. ,
Format: int64 ,
Required: False ,
}
integer ,
uptimeInSeconds:
{
Description: Uptime of the Agent in seconds. ,
Format: int64 ,
Required: False ,
}
integer ,
timeZone:
{
Description: The agent's local time zone represented in Windows format. ,
Required: False ,
}
string ,
uploadLimitSchedule:
{
Description: The WAN-link upload limit schedule that applies to any Job Run the agent executes. Data plane operations (migrating files) are affected. Control plane operations ensure seamless migration functionality and are not limited by this schedule. The schedule is interpreted with the agent's local time. ,
Required: False ,
}
{
weeklyRecurrences:
{
Description: The set of weekly repeating recurrences of the WAN-link upload limit schedule. ,
Required: False ,
}
[
{
limitInMbps:
{
Description: The WAN-link upload bandwidth (maximum data transfer rate) in megabits per second. Value of 0 indicates no throughput is allowed and any running migration job is effectively paused for the duration of this recurrence. Only data plane operations are governed by this limit. Control plane operations ensure seamless functionality. The agent may exceed this limit with control messages, if necessary. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
errorDetails:
{
Required: False ,
}
{
code:
{
Description: Error code reported by Agent ,
Required: False ,
}
string ,
message:
{
Description: Expanded description of reported error code ,
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 ,
}
,
]
,
}
,
}
Agents_Update (new)
Description :  Creates or updates an Agent resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/agents/{agentName}
{
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 ,
agentName:
{
Description: The name of the Agent resource. ,
Required: True ,
}
string ,
agent:
{
Required: True ,
}
{
properties:
{
Required: False ,
}
{
description:
{
Description: A description for the Agent. ,
Required: False ,
}
string ,
uploadLimitSchedule:
{
Description: The WAN-link upload limit schedule that applies to any Job Run the agent executes. Data plane operations (migrating files) are affected. Control plane operations ensure seamless migration functionality and are not limited by this schedule. The schedule is interpreted with the agent's local time. ,
Required: False ,
}
{
weeklyRecurrences:
{
Description: The set of weekly repeating recurrences of the WAN-link upload limit schedule. ,
Required: False ,
}
[
{
limitInMbps:
{
Description: The WAN-link upload bandwidth (maximum data transfer rate) in megabits per second. Value of 0 indicates no throughput is allowed and any running migration job is effectively paused for the duration of this recurrence. Only data plane operations are governed by this limit. Control plane operations ensure seamless functionality. The agent may exceed this limit with control messages, if necessary. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Required: True ,
}
{
description:
{
Description: A description for the Agent. ,
Required: False ,
}
string ,
agentVersion:
{
Description: The Agent version. ,
Required: False ,
}
string ,
arcResourceId:
{
Description: The fully qualified resource ID of the Hybrid Compute resource for the Agent. ,
Required: True ,
}
string ,
arcVmUuid:
{
Description: The VM UUID of the Hybrid Compute resource for the Agent. ,
Required: True ,
}
string ,
agentStatus:
{
Description: The Agent status. ,
Enum:
{
Registering: No description available. ,
Offline: No description available. ,
Online: No description available. ,
Executing: No description available. ,
RequiresAttention: No description available. ,
Unregistering: No description available. ,
}
,
Required: False ,
}
enum ,
lastStatusUpdate:
{
Description: The last updated time of the Agent status. ,
Format: date-time ,
Required: False ,
}
string ,
localIPAddress:
{
Description: Local IP address reported by the Agent. ,
Required: False ,
}
string ,
memoryInMB:
{
Description: Available memory reported by the Agent, in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfCores:
{
Description: Available compute cores reported by the Agent. ,
Format: int64 ,
Required: False ,
}
integer ,
uptimeInSeconds:
{
Description: Uptime of the Agent in seconds. ,
Format: int64 ,
Required: False ,
}
integer ,
timeZone:
{
Description: The agent's local time zone represented in Windows format. ,
Required: False ,
}
string ,
uploadLimitSchedule:
{
Description: The WAN-link upload limit schedule that applies to any Job Run the agent executes. Data plane operations (migrating files) are affected. Control plane operations ensure seamless migration functionality and are not limited by this schedule. The schedule is interpreted with the agent's local time. ,
Required: False ,
}
{
weeklyRecurrences:
{
Description: The set of weekly repeating recurrences of the WAN-link upload limit schedule. ,
Required: False ,
}
[
{
limitInMbps:
{
Description: The WAN-link upload bandwidth (maximum data transfer rate) in megabits per second. Value of 0 indicates no throughput is allowed and any running migration job is effectively paused for the duration of this recurrence. Only data plane operations are governed by this limit. Control plane operations ensure seamless functionality. The agent may exceed this limit with control messages, if necessary. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
errorDetails:
{
Required: False ,
}
{
code:
{
Description: Error code reported by Agent ,
Required: False ,
}
string ,
message:
{
Description: Expanded description of reported error code ,
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 ,
}
,
]
,
}
,
}
Agents_Delete (new)
Description :  Deletes an Agent resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/agents/{agentName}
{
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 ,
agentName:
{
Description: The name of the Agent resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Endpoints_List (new)
Description :  Lists all Endpoints in a Storage Mover.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/endpoints
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The Endpoint items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource specific properties for the Storage Mover resource. ,
Required: True ,
}
{
endpointType:
{
Description: The Endpoint resource type. ,
Enum:
{
AzureStorageBlobContainer: No description available. ,
NfsMount: No description available. ,
AzureStorageSmbFileShare: No description available. ,
SmbMount: No description available. ,
AzureMultiCloudConnector: No description available. ,
AzureStorageNfsFileShare: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A description for the Endpoint. ,
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 ,
}
,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identity of the resource. This property is only available on the latest version. ,
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 ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Endpoints_Get (new)
Description :  Gets an Endpoint resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/endpoints/{endpointName}
{
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 ,
endpointName:
{
Description: The name of the Endpoint resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource specific properties for the Storage Mover resource. ,
Required: True ,
}
{
endpointType:
{
Description: The Endpoint resource type. ,
Enum:
{
AzureStorageBlobContainer: No description available. ,
NfsMount: No description available. ,
AzureStorageSmbFileShare: No description available. ,
SmbMount: No description available. ,
AzureMultiCloudConnector: No description available. ,
AzureStorageNfsFileShare: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A description for the Endpoint. ,
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 ,
}
,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identity of the resource. This property is only available on the latest version. ,
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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Endpoints_CreateOrUpdate (new)
Description :  Creates or updates an Endpoint resource, which represents a data transfer source or destination.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/endpoints/{endpointName}
{
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 ,
endpointName:
{
Description: The name of the Endpoint resource. ,
Required: True ,
}
string ,
endpoint:
{
Required: True ,
}
{
properties:
{
Description: The resource specific properties for the Storage Mover resource. ,
Required: True ,
}
{
endpointType:
{
Description: The Endpoint resource type. ,
Enum:
{
AzureStorageBlobContainer: No description available. ,
NfsMount: No description available. ,
AzureStorageSmbFileShare: No description available. ,
SmbMount: No description available. ,
AzureMultiCloudConnector: No description available. ,
AzureStorageNfsFileShare: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A description for the Endpoint. ,
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 ,
}
,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identity of the resource. This property is only available on the latest version. ,
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 ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource specific properties for the Storage Mover resource. ,
Required: True ,
}
{
endpointType:
{
Description: The Endpoint resource type. ,
Enum:
{
AzureStorageBlobContainer: No description available. ,
NfsMount: No description available. ,
AzureStorageSmbFileShare: No description available. ,
SmbMount: No description available. ,
AzureMultiCloudConnector: No description available. ,
AzureStorageNfsFileShare: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A description for the Endpoint. ,
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 ,
}
,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identity of the resource. This property is only available on the latest version. ,
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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Endpoints_Update (new)
Description :  Updates properties for an Endpoint resource. Properties not specified in the request body will be unchanged.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/endpoints/{endpointName}
{
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 ,
endpointName:
{
Description: The name of the Endpoint resource. ,
Required: True ,
}
string ,
endpoint:
{
Required: True ,
}
{
properties:
{
Description: The Endpoint resource, which contains information about file sources and targets. ,
Required: False ,
}
{
endpointType:
{
Description: The Endpoint resource type. ,
Enum:
{
AzureStorageBlobContainer: No description available. ,
NfsMount: No description available. ,
AzureStorageSmbFileShare: No description available. ,
SmbMount: No description available. ,
AzureMultiCloudConnector: No description available. ,
AzureStorageNfsFileShare: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A description for the Endpoint. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed system identity assigned to this 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 ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource specific properties for the Storage Mover resource. ,
Required: True ,
}
{
endpointType:
{
Description: The Endpoint resource type. ,
Enum:
{
AzureStorageBlobContainer: No description available. ,
NfsMount: No description available. ,
AzureStorageSmbFileShare: No description available. ,
SmbMount: No description available. ,
AzureMultiCloudConnector: No description available. ,
AzureStorageNfsFileShare: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A description for the Endpoint. ,
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 ,
}
,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identity of the resource. This property is only available on the latest version. ,
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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Endpoints_Delete (new)
Description :  Deletes an Endpoint resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/endpoints/{endpointName}
{
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 ,
endpointName:
{
Description: The name of the Endpoint resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Projects_List (new)
Description :  Lists all Projects in a Storage Mover.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/projects
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The Project items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Project properties. ,
Required: False ,
}
{
description:
{
Description: A description for the Project. ,
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 ,
}
,
]
,
}
,
}
Projects_Get (new)
Description :  Gets a Project resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/projects/{projectName}
{
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)

{
properties:
{
Description: Project properties. ,
Required: False ,
}
{
description:
{
Description: A description for the Project. ,
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 ,
}
,
]
,
}
,
}
Projects_CreateOrUpdate (new)
Description :  Creates or updates a Project resource, which is a logical grouping of related jobs.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/projects/{projectName}
{
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 ,
project:
{
Required: True ,
}
{
properties:
{
Description: Project properties. ,
Required: False ,
}
{
description:
{
Description: A description for the Project. ,
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: Project properties. ,
Required: False ,
}
{
description:
{
Description: A description for the Project. ,
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 ,
}
,
]
,
}
,
}
Projects_Update (new)
Description :  Updates properties for a Project resource. Properties not specified in the request body will be unchanged.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/projects/{projectName}
{
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 ,
project:
{
Required: True ,
}
{
properties:
{
Description: Project properties. ,
Required: False ,
}
{
description:
{
Description: A description for the Project. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Project properties. ,
Required: False ,
}
{
description:
{
Description: A description for the Project. ,
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 ,
}
,
]
,
}
,
}
Projects_Delete (new)
Description :  Deletes a Project resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/projects/{projectName}
{
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)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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_List (new)
Description :  Lists all Job Definitions in a Project.
Reference :  Link ¶

⚼ 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 ,
jobType:
{
Description: The type of the Job. ,
Enum:
{
OnPremToCloud: No description available. ,
CloudToCloud: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
sourceTargetMap:
{
Description: The list of cloud endpoints to migrate. ,
Required: False ,
}
{
value:
{
Required: False ,
}
[
{
sourceEndpoint:
{
Description: The source endpoint resource for source and target mapping. ,
Required: True ,
}
{
properties:
{
Description: The properties of the cloud source endpoint to migrate. ,
Required: False ,
}
{
name:
{
Description: The name of the cloud source endpoint to migrate. ,
Required: False ,
}
string ,
sourceEndpointResourceId:
{
Description: The fully qualified ARM resource ID of the cloud source endpoint to migrate. ,
Format: arm-id ,
Required: False ,
}
string ,
awsS3BucketId:
{
Description: The fully qualified ARM resource ID of the AWS S3 bucket to migrate. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
targetEndpoint:
{
Description: The target endpoint resource for source and target mapping. ,
Required: True ,
}
{
properties:
{
Description: The properties of the cloud target endpoint to migrate. ,
Required: False ,
}
{
name:
{
Description: The name of the cloud target endpoint to migrate. ,
Required: False ,
}
string ,
targetEndpointResourceId:
{
Description: The fully qualified ARM resource ID of the cloud target endpoint to migrate. ,
Format: arm-id ,
Required: False ,
}
string ,
azureStorageAccountResourceId:
{
Description: The fully qualified ARM resource ID of the Azure Storage account. ,
Format: arm-id ,
Required: False ,
}
string ,
azureStorageBlobContainerName:
{
Description: The name of the Azure Storage blob container. ,
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 (new)
Description :  Gets a Job Definition resource.
Reference :  Link ¶

⚼ 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 ,
jobType:
{
Description: The type of the Job. ,
Enum:
{
OnPremToCloud: No description available. ,
CloudToCloud: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
sourceTargetMap:
{
Description: The list of cloud endpoints to migrate. ,
Required: False ,
}
{
value:
{
Required: False ,
}
[
{
sourceEndpoint:
{
Description: The source endpoint resource for source and target mapping. ,
Required: True ,
}
{
properties:
{
Description: The properties of the cloud source endpoint to migrate. ,
Required: False ,
}
{
name:
{
Description: The name of the cloud source endpoint to migrate. ,
Required: False ,
}
string ,
sourceEndpointResourceId:
{
Description: The fully qualified ARM resource ID of the cloud source endpoint to migrate. ,
Format: arm-id ,
Required: False ,
}
string ,
awsS3BucketId:
{
Description: The fully qualified ARM resource ID of the AWS S3 bucket to migrate. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
targetEndpoint:
{
Description: The target endpoint resource for source and target mapping. ,
Required: True ,
}
{
properties:
{
Description: The properties of the cloud target endpoint to migrate. ,
Required: False ,
}
{
name:
{
Description: The name of the cloud target endpoint to migrate. ,
Required: False ,
}
string ,
targetEndpointResourceId:
{
Description: The fully qualified ARM resource ID of the cloud target endpoint to migrate. ,
Format: arm-id ,
Required: False ,
}
string ,
azureStorageAccountResourceId:
{
Description: The fully qualified ARM resource ID of the Azure Storage account. ,
Format: arm-id ,
Required: False ,
}
string ,
azureStorageBlobContainerName:
{
Description: The name of the Azure Storage blob container. ,
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 (new)
Description :  Creates or updates a Job Definition resource, which contains configuration for a single unit of managed data transfer.
Reference :  Link ¶

⚼ 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 ,
jobType:
{
Description: The type of the Job. ,
Enum:
{
OnPremToCloud: No description available. ,
CloudToCloud: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
sourceTargetMap:
{
Description: The list of cloud endpoints to migrate. ,
Required: False ,
}
{
value:
{
Required: False ,
}
[
{
sourceEndpoint:
{
Description: The source endpoint resource for source and target mapping. ,
Required: True ,
}
{
properties:
{
Description: The properties of the cloud source endpoint to migrate. ,
Required: False ,
}
{
name:
{
Description: The name of the cloud source endpoint to migrate. ,
Required: False ,
}
string ,
sourceEndpointResourceId:
{
Description: The fully qualified ARM resource ID of the cloud source endpoint to migrate. ,
Format: arm-id ,
Required: False ,
}
string ,
awsS3BucketId:
{
Description: The fully qualified ARM resource ID of the AWS S3 bucket to migrate. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
targetEndpoint:
{
Description: The target endpoint resource for source and target mapping. ,
Required: True ,
}
{
properties:
{
Description: The properties of the cloud target endpoint to migrate. ,
Required: False ,
}
{
name:
{
Description: The name of the cloud target endpoint to migrate. ,
Required: False ,
}
string ,
targetEndpointResourceId:
{
Description: The fully qualified ARM resource ID of the cloud target endpoint to migrate. ,
Format: arm-id ,
Required: False ,
}
string ,
azureStorageAccountResourceId:
{
Description: The fully qualified ARM resource ID of the Azure Storage account. ,
Format: arm-id ,
Required: False ,
}
string ,
azureStorageBlobContainerName:
{
Description: The name of the Azure Storage blob container. ,
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 ,
jobType:
{
Description: The type of the Job. ,
Enum:
{
OnPremToCloud: No description available. ,
CloudToCloud: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
sourceTargetMap:
{
Description: The list of cloud endpoints to migrate. ,
Required: False ,
}
{
value:
{
Required: False ,
}
[
{
sourceEndpoint:
{
Description: The source endpoint resource for source and target mapping. ,
Required: True ,
}
{
properties:
{
Description: The properties of the cloud source endpoint to migrate. ,
Required: False ,
}
{
name:
{
Description: The name of the cloud source endpoint to migrate. ,
Required: False ,
}
string ,
sourceEndpointResourceId:
{
Description: The fully qualified ARM resource ID of the cloud source endpoint to migrate. ,
Format: arm-id ,
Required: False ,
}
string ,
awsS3BucketId:
{
Description: The fully qualified ARM resource ID of the AWS S3 bucket to migrate. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
targetEndpoint:
{
Description: The target endpoint resource for source and target mapping. ,
Required: True ,
}
{
properties:
{
Description: The properties of the cloud target endpoint to migrate. ,
Required: False ,
}
{
name:
{
Description: The name of the cloud target endpoint to migrate. ,
Required: False ,
}
string ,
targetEndpointResourceId:
{
Description: The fully qualified ARM resource ID of the cloud target endpoint to migrate. ,
Format: arm-id ,
Required: False ,
}
string ,
azureStorageAccountResourceId:
{
Description: The fully qualified ARM resource ID of the Azure Storage account. ,
Format: arm-id ,
Required: False ,
}
string ,
azureStorageBlobContainerName:
{
Description: The name of the Azure Storage blob container. ,
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 (new)
Description :  Updates properties for a Job Definition resource. Properties not specified in the request body will be unchanged.
Reference :  Link ¶

⚼ 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 ,
jobType:
{
Description: The type of the Job. ,
Enum:
{
OnPremToCloud: No description available. ,
CloudToCloud: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
sourceTargetMap:
{
Description: The list of cloud endpoints to migrate. ,
Required: False ,
}
{
value:
{
Required: False ,
}
[
{
sourceEndpoint:
{
Description: The source endpoint resource for source and target mapping. ,
Required: True ,
}
{
properties:
{
Description: The properties of the cloud source endpoint to migrate. ,
Required: False ,
}
{
name:
{
Description: The name of the cloud source endpoint to migrate. ,
Required: False ,
}
string ,
sourceEndpointResourceId:
{
Description: The fully qualified ARM resource ID of the cloud source endpoint to migrate. ,
Format: arm-id ,
Required: False ,
}
string ,
awsS3BucketId:
{
Description: The fully qualified ARM resource ID of the AWS S3 bucket to migrate. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
targetEndpoint:
{
Description: The target endpoint resource for source and target mapping. ,
Required: True ,
}
{
properties:
{
Description: The properties of the cloud target endpoint to migrate. ,
Required: False ,
}
{
name:
{
Description: The name of the cloud target endpoint to migrate. ,
Required: False ,
}
string ,
targetEndpointResourceId:
{
Description: The fully qualified ARM resource ID of the cloud target endpoint to migrate. ,
Format: arm-id ,
Required: False ,
}
string ,
azureStorageAccountResourceId:
{
Description: The fully qualified ARM resource ID of the Azure Storage account. ,
Format: arm-id ,
Required: False ,
}
string ,
azureStorageBlobContainerName:
{
Description: The name of the Azure Storage blob container. ,
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_Delete (new)
Description :  Deletes a Job Definition resource.
Reference :  Link ¶

⚼ Request

DELETE:  /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)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
JobRuns_List (new)
Description :  Lists all Job Runs in a Job Definition.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/projects/{projectName}/jobDefinitions/{jobDefinitionName}/jobRuns
{
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)

{
value:
{
Description: The JobRun items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Job run properties. ,
Required: False ,
}
{
status:
{
Description: The state of the job execution. ,
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 ,
scanStatus:
{
Description: The status of Agent's scanning of source. ,
Enum:
{
NotStarted: No description available. ,
Scanning: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
agentName:
{
Description: Name of the Agent assigned to this run. ,
Required: False ,
}
string ,
agentResourceId:
{
Description: Fully qualified resource id of the Agent assigned to this run. ,
Required: False ,
}
string ,
executionStartTime:
{
Description: Start time of the run. Null if no Agent reported that the job has started. ,
Format: date-time ,
Required: False ,
}
string ,
executionEndTime:
{
Description: End time of the run. Null if Agent has not reported that the job has ended. ,
Format: date-time ,
Required: False ,
}
string ,
lastStatusUpdate:
{
Description: The last updated time of the Job Run. ,
Format: date-time ,
Required: False ,
}
string ,
itemsScanned:
{
Description: Number of items scanned so far in source. ,
Format: int64 ,
Required: False ,
}
integer ,
itemsExcluded:
{
Description: Number of items that will not be transferred, as they are excluded by user configuration. ,
Format: int64 ,
Required: False ,
}
integer ,
itemsUnsupported:
{
Description: Number of items that will not be transferred, as they are unsupported on target. ,
Format: int64 ,
Required: False ,
}
integer ,
itemsNoTransferNeeded:
{
Description: Number of items that will not be transferred, as they are already found on target (e.g. mirror mode). ,
Format: int64 ,
Required: False ,
}
integer ,
itemsFailed:
{
Description: Number of items that were attempted to transfer and failed. ,
Format: int64 ,
Required: False ,
}
integer ,
itemsTransferred:
{
Description: Number of items successfully transferred to target. ,
Format: int64 ,
Required: False ,
}
integer ,
bytesScanned:
{
Description: Bytes of data scanned so far in source. ,
Format: int64 ,
Required: False ,
}
integer ,
bytesExcluded:
{
Description: Bytes of data that will not be transferred, as they are excluded by user configuration. ,
Format: int64 ,
Required: False ,
}
integer ,
bytesUnsupported:
{
Description: Bytes of data that will not be transferred, as they are unsupported on target. ,
Format: int64 ,
Required: False ,
}
integer ,
bytesNoTransferNeeded:
{
Description: Bytes of data that will not be transferred, as they are already found on target (e.g. mirror mode). ,
Format: int64 ,
Required: False ,
}
integer ,
bytesFailed:
{
Description: Bytes of data that were attempted to transfer and failed. ,
Format: int64 ,
Required: False ,
}
integer ,
bytesTransferred:
{
Description: Bytes of data successfully transferred to target. ,
Format: int64 ,
Required: False ,
}
integer ,
sourceName:
{
Description: Name of source Endpoint resource. This resource may no longer exist. ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: Fully qualified resource id of source Endpoint. This id may no longer exist. ,
Required: False ,
}
string ,
sourceProperties:
{
Description: Copy of source Endpoint resource's properties at time of Job Run creation. ,
Required: False ,
}
string ,
targetName:
{
Description: Name of target Endpoint resource. This resource may no longer exist. ,
Required: False ,
}
string ,
targetResourceId:
{
Description: Fully qualified resource id of of Endpoint. This id may no longer exist. ,
Required: False ,
}
string ,
targetProperties:
{
Description: Copy of Endpoint resource's properties at time of Job Run creation. ,
Required: False ,
}
string ,
jobDefinitionProperties:
{
Description: Copy of parent Job Definition's properties at time of Job Run creation. ,
Required: False ,
}
string ,
error:
{
Description: Error details. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
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 ,
}
,
]
,
}
,
}
JobRuns_Get (new)
Description :  Gets a Job Run resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/projects/{projectName}/jobDefinitions/{jobDefinitionName}/jobRuns/{jobRunName}
{
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 ,
jobRunName:
{
Description: The name of the Job Run resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Job run properties. ,
Required: False ,
}
{
status:
{
Description: The state of the job execution. ,
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 ,
scanStatus:
{
Description: The status of Agent's scanning of source. ,
Enum:
{
NotStarted: No description available. ,
Scanning: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
agentName:
{
Description: Name of the Agent assigned to this run. ,
Required: False ,
}
string ,
agentResourceId:
{
Description: Fully qualified resource id of the Agent assigned to this run. ,
Required: False ,
}
string ,
executionStartTime:
{
Description: Start time of the run. Null if no Agent reported that the job has started. ,
Format: date-time ,
Required: False ,
}
string ,
executionEndTime:
{
Description: End time of the run. Null if Agent has not reported that the job has ended. ,
Format: date-time ,
Required: False ,
}
string ,
lastStatusUpdate:
{
Description: The last updated time of the Job Run. ,
Format: date-time ,
Required: False ,
}
string ,
itemsScanned:
{
Description: Number of items scanned so far in source. ,
Format: int64 ,
Required: False ,
}
integer ,
itemsExcluded:
{
Description: Number of items that will not be transferred, as they are excluded by user configuration. ,
Format: int64 ,
Required: False ,
}
integer ,
itemsUnsupported:
{
Description: Number of items that will not be transferred, as they are unsupported on target. ,
Format: int64 ,
Required: False ,
}
integer ,
itemsNoTransferNeeded:
{
Description: Number of items that will not be transferred, as they are already found on target (e.g. mirror mode). ,
Format: int64 ,
Required: False ,
}
integer ,
itemsFailed:
{
Description: Number of items that were attempted to transfer and failed. ,
Format: int64 ,
Required: False ,
}
integer ,
itemsTransferred:
{
Description: Number of items successfully transferred to target. ,
Format: int64 ,
Required: False ,
}
integer ,
bytesScanned:
{
Description: Bytes of data scanned so far in source. ,
Format: int64 ,
Required: False ,
}
integer ,
bytesExcluded:
{
Description: Bytes of data that will not be transferred, as they are excluded by user configuration. ,
Format: int64 ,
Required: False ,
}
integer ,
bytesUnsupported:
{
Description: Bytes of data that will not be transferred, as they are unsupported on target. ,
Format: int64 ,
Required: False ,
}
integer ,
bytesNoTransferNeeded:
{
Description: Bytes of data that will not be transferred, as they are already found on target (e.g. mirror mode). ,
Format: int64 ,
Required: False ,
}
integer ,
bytesFailed:
{
Description: Bytes of data that were attempted to transfer and failed. ,
Format: int64 ,
Required: False ,
}
integer ,
bytesTransferred:
{
Description: Bytes of data successfully transferred to target. ,
Format: int64 ,
Required: False ,
}
integer ,
sourceName:
{
Description: Name of source Endpoint resource. This resource may no longer exist. ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: Fully qualified resource id of source Endpoint. This id may no longer exist. ,
Required: False ,
}
string ,
sourceProperties:
{
Description: Copy of source Endpoint resource's properties at time of Job Run creation. ,
Required: False ,
}
string ,
targetName:
{
Description: Name of target Endpoint resource. This resource may no longer exist. ,
Required: False ,
}
string ,
targetResourceId:
{
Description: Fully qualified resource id of of Endpoint. This id may no longer exist. ,
Required: False ,
}
string ,
targetProperties:
{
Description: Copy of Endpoint resource's properties at time of Job Run creation. ,
Required: False ,
}
string ,
jobDefinitionProperties:
{
Description: Copy of parent Job Definition's properties at time of Job Run creation. ,
Required: False ,
}
string ,
error:
{
Description: Error details. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
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_StartJob (new)
Description :  Creates a new Job Run resource for the specified Job Definition and passes it to the Agent for execution.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/projects/{projectName}/jobDefinitions/{jobDefinitionName}/startJob
{
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)

{
jobRunResourceId:
{
Description: Fully qualified resource id of the Job Run. ,
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_StopJob (new)
Description :  Requests the Agent of any active instance of this Job Definition to stop.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/projects/{projectName}/jobDefinitions/{jobDefinitionName}/stopJob
{
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)

{
jobRunResourceId:
{
Description: Fully qualified resource id of the Job Run. ,
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 ,
}
,
]
,
}
,
}