crossTenantMigrationJob resource type

Namespace: microsoft.graph

Represents a cross-tenant migration batch job that migrates user data from a source tenant to a target tenant. After you create a job, call validate to verify tenant and resource configuration, then call migrate to begin the actual migration.

Inherits from entity.

Methods

Method	Return type	Description
List	crossTenantMigrationJob collection	Get a list of the crossTenantMigrationJob objects and their properties.
Create	crossTenantMigrationJob	Create a new crossTenantMigrationJob object.
Get	crossTenantMigrationJob	Read the properties and relationships of a crossTenantMigrationJob object.
Update	None	Update the completeAfterDateTime property of a crossTenantMigrationJob object.
Delete	None	Delete a crossTenantMigrationJob object.
List users	crossTenantMigrationTask collection	Get a list of the crossTenantMigrationTasks for users in a crossTenantMigrationJob.
Cancel	crossTenantMigrationCancelResponse	Cancel a cross-tenant migration job.
Migrate	crossTenantMigrationJob	Migrate a cross-tenant migration job asynchronously.
Validate	crossTenantMigrationJob	Validate a cross-tenant migration job asynchronously.

Properties

Property	Type	Description
completeAfterDateTime	DateTimeOffset	Date and time after which the migration should be performed. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2024, is 2024-01-01T00:00:00Z.
createdBy	String	User principal name (UPN) of the user who created the job. Read-only.
createdDateTime	DateTimeOffset	When the job was created. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2024, is 2024-01-01T00:00:00Z. Read-only.
displayName	String	Display name of the job. Must be unique per tenant.
exchangeSettings	exchangeOnlineCrossTenantMigrationSettings	Settings to use for migration of Exchange workload. Nullable.
id	String	Unique identifier for the migration job. Read-only. Inherited from entity.
jobType	crossTenantMigrationJobType	Type of the migration job. The possible values are: validate (only validation is performed, no migration), migrate (content is migrated), and unknownFutureValue.
lastUpdatedDateTime	DateTimeOffset	When this migration job was last updated. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2024, is 2024-01-01T00:00:00Z. Read-only.
message	String	Status message of the migration job. Nullable. Read-only.
resources	String collection	IDs (GUID) of the resources that are migrated with the migration job.
resourceType	String	Type of resource being migrated. Only Users is currently supported.
sourceTenantId	String	ID (GUID) of the source tenant for the content migration.
status	crossTenantMigrationJobStatus	Most recent status of the migration job. Read-only. The possible values are: submitted, approved, processing, cuttingOver, inProgress, completed, completedWithErrors, failed, cancelled, pendingCancel, adminActionRequired, validateSubmitted, validateProcessing, validateInProgress, validatePassed, validateFailed, pendingDelete, deleted, unknownFutureValue.
targetTenantId	String	ID of the target tenant for the content migration. Read-only.
workloads	String collection	Workloads to migrate. Supported workloads are Teams, Exchange, and ODSP (OneDrive/SharePoint).

Relationships

Relationship	Type	Description
users	crossTenantMigrationTask collection	Details and status of the users migrated in this migration job.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.crossTenantMigrationJob",
  "id": "String (identifier)",
  "displayName": "String",
  "jobType": "String",
  "sourceTenantId": "String",
  "targetTenantId": "String",
  "completeAfterDateTime": "String (timestamp)",
  "status": "String",
  "message": "String",
  "createdDateTime": "String (timestamp)",
  "createdBy": "String",
  "lastUpdatedDateTime": "String (timestamp)",
  "exchangeSettings": {
    "@odata.type": "microsoft.graph.exchangeOnlineCrossTenantMigrationSettings"
  },
  "workloads": [
    "String"
  ],
  "resourceType": "String",
  "resources": [
    "String"
  ]
}