Items - Get Sql Endpoint Metadata Sync Migration Status
Gets the metadata sync migration status of the specified SQL analytics endpoint.
Note
Metadata sync migration is currently in Preview (learn more).
Returns the current synchronization architecture version, the direction of any migration in progress, and the results of the most recent completed migration attempt.
Permissions
The caller must have read permissions for the SQL analytics endpoint item.
Required Delegated Scopes
Item.Read.All or Item.ReadWrite.All or SQLEndpoint.Read.All or SQLEndpoint.ReadWrite.All
Microsoft Entra supported identities
This API supports the Microsoft identities listed in this section.
| Identity | Support |
|---|---|
| User | Yes |
| Service principal and Managed identities | Yes |
Interface
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sqlEndpoints/{itemId}/metadataSyncMigrationStatus
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
item
|
path | True |
string (uuid) |
The SQL analytics endpoint ID. |
|
workspace
|
path | True |
string (uuid) |
The workspace ID. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
Request completed successfully. |
|
| 429 Too Many Requests |
The service rate limit was exceeded. The server returns a Headers Retry-After: integer |
|
| Other Status Codes |
Common error codes:
|
Examples
Get metadata sync migration status example
Sample request
GET https://api.fabric.microsoft.com/v1/workspaces/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/sqlEndpoints/9b1e77c2-6a4e-4f0b-bd3a-1f2c0d4e5a6b/metadataSyncMigrationStatus
Sample response
{
"syncArchitectureVersion": "V2",
"itemMigrationDirection": "MigratingToV2",
"tableFailures": [
{
"schema": "dbo",
"tableName": "OrderDetails",
"error": {
"errorCode": "DeltaTableNotFound",
"message": "Delta table 'Tables\\OrderDetails\\_delta_log' was not found."
}
}
],
"lastMigrationAttempt": {
"sourceSyncArchitectureVersion": "V1",
"targetSyncArchitectureVersion": "V2",
"itemMigrationStatus": "PartiallySucceeded",
"completedDateTime": "2026-06-09T14:31:25Z"
}
}
Definitions
| Name | Description |
|---|---|
|
Error |
A structured parameter providing additional machine-readable context about an error. |
|
Error |
The error related resource details object. |
|
Error |
The error response. |
|
Error |
The error response details. |
|
Item |
The direction of an active metadata sync migration. Additional ItemMigrationDirection types may be added over time. |
|
Item |
The overall outcome of a metadata sync migration. Additional ItemMigrationStatus types may be added over time. |
|
Metadata |
A summary of a completed metadata sync migration attempt. |
|
Metadata |
The metadata sync migration status of a SQL analytics endpoint. |
|
Metadata |
A table that failed in a completed metadata sync migration attempt. |
|
Sync |
The synchronization architecture version. Additional SyncArchitectureVersion types may be added over time. |
ErrorParameter
A structured parameter providing additional machine-readable context about an error.
| Name | Type | Description |
|---|---|---|
| message |
string |
A human-readable description of the parameter's meaning. |
| name |
string |
The parameter identifier. |
| value |
string |
The parameter value. |
ErrorRelatedResource
The error related resource details object.
| Name | Type | Description |
|---|---|---|
| resourceId |
string |
The resource ID that's involved in the error. |
| resourceType |
string |
The type of the resource that's involved in the error. |
ErrorResponse
The error response.
| Name | Type | Description |
|---|---|---|
| errorCode |
string |
A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users. |
| isRetriable |
boolean |
When true, the request can be retried. Use the |
| message |
string |
A human readable representation of the error. |
| moreDetails |
List of additional error details. |
|
| parameters |
Structured parameters providing additional machine-readable context about the error. |
|
| relatedResource |
The error related resource details. |
|
| requestId |
string (uuid) |
ID of the request associated with the error. |
ErrorResponseDetails
The error response details.
| Name | Type | Description |
|---|---|---|
| errorCode |
string |
A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users. |
| message |
string |
A human readable representation of the error. |
| parameters |
Structured parameters providing additional machine-readable context about the error. |
|
| relatedResource |
The error related resource details. |
ItemMigrationDirection
The direction of an active metadata sync migration. Additional ItemMigrationDirection types may be added over time.
| Value | Description |
|---|---|
| MigratingToV2 |
A migration from the v1 regular-table architecture to the v2 external-table architecture is in progress. |
| MigratingToV1 |
A migration from the v2 external-table architecture to the v1 regular-table architecture is in progress. |
ItemMigrationStatus
The overall outcome of a metadata sync migration. Additional ItemMigrationStatus types may be added over time.
| Value | Description |
|---|---|
| Succeeded |
The migration completed with no table failing to convert. |
| PartiallySucceeded |
At least one table reached the target architecture and at least one table failed to convert. |
| Failed |
Every table that needed conversion failed, and the endpoint remains on its prior architecture. |
MetadataSyncMigrationAttempt
A summary of a completed metadata sync migration attempt.
| Name | Type | Description |
|---|---|---|
| completedDateTime |
string (date-time) |
The date and time when the migration attempt completed in UTC, using the YYYY-MM-DDTHH:mm:ssZ format. |
| itemMigrationStatus |
The overall outcome of the migration attempt. |
|
| sourceSyncArchitectureVersion |
The synchronization architecture version from which the attempt migrated. |
|
| targetSyncArchitectureVersion |
The synchronization architecture version to which the attempt migrated. |
MetadataSyncMigrationStatus
The metadata sync migration status of a SQL analytics endpoint.
| Name | Type | Description |
|---|---|---|
| itemMigrationDirection |
The direction in which the endpoint is currently migrating. This property is omitted when no migration is in progress. |
|
| lastMigrationAttempt |
A summary of the most recent completed migration attempt. This property is omitted when no migration has been attempted. |
|
| syncArchitectureVersion |
The current synchronization architecture version of the endpoint. While a migration is in progress, this property remains at the source version and changes to the target version only when the migration reaches a terminal state. |
|
| tableFailures |
The tables that failed in the most recent completed migration attempt. |
MetadataSyncTableFailure
A table that failed in a completed metadata sync migration attempt.
| Name | Type | Description |
|---|---|---|
| error |
The error that caused the table migration to fail. |
|
| schema |
string |
The schema name of the failed table. |
| tableName |
string |
The unqualified name of the failed table. |
SyncArchitectureVersion
The synchronization architecture version. Additional SyncArchitectureVersion types may be added over time.
| Value | Description |
|---|---|
| V1 |
The v1 regular-table synchronization architecture. |
| V2 |
The v2 external-table synchronization architecture. |