Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Namespace: microsoft.graph
Important
APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Represents the migration task for migrating a specific source resource to a target organization and indicates the status of that migration operation. This entity captures a specific intent to perform a sharePointMigrationTask operation, has a unique ID, can exist independently, has a defined lifetime, and can be retrieved using the ID.
Inherits from entity.
Methods
| Method | Return type | Description |
|---|---|---|
| Get | sharePointMigrationTask | Get a sharePointMigrationTask that was previously created, using the task ID. |
| Create or update | sharePointMigrationTask | Create or update a sharePointMigrationTask to migrate a resource from the source organization to the target organization, using the sharePointMigrationTaskParameters. |
| Get by source user principal name | sharePointMigrationTask | Get a sharePointMigrationTask that was previously created for a user, using the source userPrincipalName. |
| Get by source site URL | sharePointMigrationTask | Get a sharePointMigrationTask that was previously created for a regular site, using the source site URL. |
| Get by source group mail nickname | sharePointMigrationTask | Get a sharePointMigrationTask that was previously created for a group, using the source group mail nickname. |
| Cancel | None | Cancel a sharePointMigrationTask that moves a specific object from a source organization to a target organization. |
Properties
| Property | Type | Description |
|---|---|---|
| error | publicError | The error information to provide context for failures. Optional. Read-only. Only on OneDrive and SharePoint. |
| finishedDateTime | DateTimeOffset | Date and time when the sharePointMigrationTask ended, if available. The task might complete successfully or fail, but it ends at that time. Read-only. Only on OneDrive and SharePoint. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. |
| id | String | The unique ID of the sharePointMigrationTask operation for the source organization and resource defined in the parameters. Omit this property during creation. The service returns it automatically. Inherited from entity. |
| lastUpdatedDateTime | DateTimeOffset | Date and time when the sharePointMigrationTask was last updated or processed, if available. Use this property to find tasks that stopped processing for a long time. Read-only. Optional. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. |
| parameters | sharePointMigrationTaskParameters | Identifies the source resource and organization, defines the target organization, and includes settings that control the migration process. These settings must be specified during task creation and are also returned in every query about this task for tracking and identification. |
| startedDateTime | DateTimeOffset | Date and time when the sharePointMigrationTask started, if available. Read-only. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. |
| status | sharePointMigrationTaskStatus | Indicates the status of the migration activity that this task represents. Omit this property during creation. The service returns it automatically. The possible values are: notStarted, inProgress, completed, cancelled, failed, unknownFutureValue. |
Relationships
None.
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.sharePointMigrationTask",
"error": {"@odata.type": "microsoft.graph.publicError"},
"finishedDateTime": "String (timestamp)",
"id": "String (identifier)",
"lastUpdatedDateTime": "String (timestamp)",
"parameters": {"@odata.type": "microsoft.graph.sharePointMigrationTaskParameters"},
"startedDateTime": "String (timestamp)",
"status": "String"
}