Share via

Job Runs - List

Service:
Storage Mover
API Version:
2024-07-01

Lists all Job Runs in a Job Definition.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/projects/{projectName}/jobDefinitions/{jobDefinitionName}/jobRuns?api-version=2024-07-01

URI Parameters

Name In Required Type Description
jobDefinitionName
 path True

string

The name of the Job Definition resource.
projectName
 path True

string

The name of the Project resource.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

The name of the resource group. The name is case insensitive.
storageMoverName
 path True

string

The name of the Storage Mover resource.
subscriptionId
 path True

string

minLength: 1

The ID of the target subscription.
api-version
 query True

string

minLength: 1

The API version to use for this operation.

Responses

Name Type Description
200 OK

JobRunList

The list of Job Runs.
Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

JobRuns_List

Sample request

GET https://management.azure.com/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/projects/examples-projectName/jobDefinitions/examples-jobDefinitionName/jobRuns?api-version=2024-07-01

Sample response

Status code:
200 
{
  "value": [
    {
      "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/projectName/examples-projectName/jobDefinitions/examples-jobDefinitionName1/jobRuns/examples-jobRunName1",
      "name": "examples-jobRunName1",
      "type": "Microsoft.StorageMover/storageMovers/projects/jobDefinitions/jobRuns",
      "properties": {
        "status": "Running",
        "scanStatus": "Scanning",
        "agentName": "migration-agent",
        "agentResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/migration-agent",
        "executionStartTime": "2023-07-01T02:11:01.1075056Z",
        "executionEndTime": null,
        "lastStatusUpdate": "2023-07-01T02:21:01.1075056Z",
        "sourceName": "sourceEndpoint",
        "sourceResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/sourceEndpoint",
        "sourceProperties": {},
        "targetName": "targetEndpoint",
        "targetResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/targetEndpoint",
        "targetProperties": {},
        "jobDefinitionProperties": {},
        "itemsScanned": 351,
        "itemsExcluded": 50,
        "itemsUnsupported": 27,
        "itemsNoTransferNeeded": 150,
        "itemsFailed": 3,
        "itemsTransferred": 100,
        "bytesScanned": 49951162777600,
        "bytesExcluded": 995116277760,
        "bytesUnsupported": 495116277760,
        "bytesNoTransferNeeded": 2995116277760,
        "bytesFailed": 5116277760,
        "bytesTransferred": 1995116277760
      }
    },
    {
      "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/projectName/examples-projectName/jobDefinitions/examples-jobDefinitionName1/jobRuns/examples-jobRunName2",
      "name": "examples-jobRunName2",
      "type": "Microsoft.StorageMover/storageMovers/projects/jobDefinitions/jobRuns",
      "properties": {
        "status": "Failed",
        "scanStatus": "Scanning",
        "agentName": "migration-agent",
        "agentResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/migration-agent",
        "executionStartTime": "2023-07-01T02:11:01.1075056Z",
        "executionEndTime": null,
        "lastStatusUpdate": "2023-07-01T02:21:01.1075056Z",
        "sourceName": "sourceEndpoint",
        "sourceResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/sourceEndpoint",
        "sourceProperties": {},
        "targetName": "targetEndpoint",
        "targetResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/targetEndpoint",
        "targetProperties": {},
        "jobDefinitionProperties": {},
        "itemsScanned": 351,
        "itemsExcluded": 50,
        "itemsUnsupported": 27,
        "itemsNoTransferNeeded": 150,
        "itemsFailed": 3,
        "itemsTransferred": 100,
        "bytesScanned": 49951162777600,
        "bytesExcluded": 995116277760,
        "bytesUnsupported": 495116277760,
        "bytesNoTransferNeeded": 2995116277760,
        "bytesFailed": 5116277760,
        "bytesTransferred": 1995116277760
      }
    },
    {
      "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/projectName/examples-projectName/jobDefinitions/examples-jobDefinitionName1/jobRuns/examples-jobRunName3",
      "name": "examples-jobRunName3",
      "type": "Microsoft.StorageMover/storageMovers/projects/jobDefinitions/jobRuns",
      "properties": {
        "status": "Failed",
        "scanStatus": "Scanning",
        "agentName": "migration-agent",
        "agentResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/migration-agent",
        "executionStartTime": "2023-07-01T02:11:01.1075056Z",
        "executionEndTime": null,
        "lastStatusUpdate": "2023-07-01T02:21:01.1075056Z",
        "sourceName": "sourceEndpoint",
        "sourceResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/sourceEndpoint",
        "sourceProperties": {},
        "targetName": "targetEndpoint",
        "targetResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/targetEndpoint",
        "targetProperties": {},
        "jobDefinitionProperties": {},
        "itemsScanned": 351,
        "itemsExcluded": 50,
        "itemsUnsupported": 27,
        "itemsNoTransferNeeded": 150,
        "itemsFailed": 3,
        "itemsTransferred": 100,
        "bytesScanned": 49951162777600,
        "bytesExcluded": 995116277760,
        "bytesUnsupported": 495116277760,
        "bytesNoTransferNeeded": 2995116277760,
        "bytesFailed": 5116277760,
        "bytesTransferred": 1995116277760
      }
    }
  ],
  "nextLink": "https://management.azure.com/providers/Microsoft.StorageMover/storageMovers/projects/jobDefinitions/jobRuns?$skiptoken={token}"
}

Definitions

Name Description
createdByType

The type of identity that created the resource.
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response
JobRun

The Job Run resource.
JobRunError

Error type
JobRunList

List of Job Runs.
JobRunScanStatus

The status of Agent's scanning of source.
JobRunStatus

The current status of the Job Run in a non-terminal state, if exists.
ProvisioningState

The provisioning state of a resource.
systemData

Metadata pertaining to creation and last modification of the resource.

createdByType

Enumeration

The type of identity that created the resource.

Value Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

Object

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorDetail[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorResponse

Object

Error response

Name Type Description
error

ErrorDetail

The error object.

JobRun

Object

The Job Run resource.

Name Type Description
id

string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

The name of the resource
properties.agentName

string

Name of the Agent assigned to this run.
properties.agentResourceId

string

Fully qualified resource id of the Agent assigned to this run.
properties.bytesExcluded

integer (int64)

Bytes of data that will not be transferred, as they are excluded by user configuration.
properties.bytesFailed

integer (int64)

Bytes of data that were attempted to transfer and failed.
properties.bytesNoTransferNeeded

integer (int64)

Bytes of data that will not be transferred, as they are already found on target (e.g. mirror mode).
properties.bytesScanned

integer (int64)

Bytes of data scanned so far in source.
properties.bytesTransferred

integer (int64)

Bytes of data successfully transferred to target.
properties.bytesUnsupported

integer (int64)

Bytes of data that will not be transferred, as they are unsupported on target.
properties.error

JobRunError

Error details.
properties.executionEndTime

string (date-time)

End time of the run. Null if Agent has not reported that the job has ended.
properties.executionStartTime

string (date-time)

Start time of the run. Null if no Agent reported that the job has started.
properties.itemsExcluded

integer (int64)

Number of items that will not be transferred, as they are excluded by user configuration.
properties.itemsFailed

integer (int64)

Number of items that were attempted to transfer and failed.
properties.itemsNoTransferNeeded

integer (int64)

Number of items that will not be transferred, as they are already found on target (e.g. mirror mode).
properties.itemsScanned

integer (int64)

Number of items scanned so far in source.
properties.itemsTransferred

integer (int64)

Number of items successfully transferred to target.
properties.itemsUnsupported

integer (int64)

Number of items that will not be transferred, as they are unsupported on target.
properties.jobDefinitionProperties

object

Copy of parent Job Definition's properties at time of Job Run creation.
properties.lastStatusUpdate

string (date-time)

The last updated time of the Job Run.
properties.provisioningState

ProvisioningState

The provisioning state of this resource.
properties.scanStatus

JobRunScanStatus

The status of Agent's scanning of source.
properties.sourceName

string

Name of source Endpoint resource. This resource may no longer exist.
properties.sourceProperties

object

Copy of source Endpoint resource's properties at time of Job Run creation.
properties.sourceResourceId

string

Fully qualified resource id of source Endpoint. This id may no longer exist.
properties.status

JobRunStatus

The state of the job execution.
properties.targetName

string

Name of target Endpoint resource. This resource may no longer exist.
properties.targetProperties

object

Copy of Endpoint resource's properties at time of Job Run creation.
properties.targetResourceId

string

Fully qualified resource id of of Endpoint. This id may no longer exist.
systemData

systemData

Resource system metadata.
type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

JobRunError

Object

Error type

Name Type Description
code

string

Error code of the given entry.
message

string

Error message of the given entry.
target

string

Target of the given error entry.

JobRunList

Object

List of Job Runs.

Name Type Description
nextLink

string

Request URL that can be used to query next page of containers. Returned when total number of requested containers exceed maximum page size.
value

JobRun[]

The Job Run resource.

JobRunScanStatus

Enumeration

The status of Agent's scanning of source.

Value Description
Completed
NotStarted
Scanning

JobRunStatus

Enumeration

The current status of the Job Run in a non-terminal state, if exists.

Value Description
CancelRequested
Canceled
Canceling
Failed
Queued
Running
Started
Succeeded

ProvisioningState

Enumeration

The provisioning state of a resource.

Value Description
Canceled
Deleting
Failed
Succeeded

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string (date-time)

The timestamp of resource creation (UTC).
createdBy

string

The identity that created the resource.
createdByType

createdByType

The type of identity that created the resource.
lastModifiedAt

string (date-time)

The timestamp of resource last modification (UTC)
lastModifiedBy

string

The identity that last modified the resource.
lastModifiedByType

createdByType

The type of identity that last modified the resource.