Validate migration from Azure Synapse Data Explorer to Eventhouse - REST API (preview)

2025-03-26

Validates if a source Azure Synapse Data Explorer cluster qualifies for migration to Eventhouse. The endpoint invokes a validation flow that performs various checks on the specified cluster URL to determine whether the provided cluster meets the criteria for migration to an eventhouse.

Permissions

The caller must have contributor or higher workspace role.

Required Delegated Scopes

Workspace.ReadWrite.All

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity	Support
User	Yes
Service principal	Yes
Managed identities	Yes

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/eventhouses/validateMigrationFromAzure

URI Parameters

Name	In	Required	Type	Description
workspaceId	path	True	string uuid	The workspace ID.

Request Body

Name	Required	Type	Description
clusterUrl	True	string	The URL of the Azure Synapse Data Explorer cluster to validate for migration.

Response

Name	Type	Description
200 OK	Response details	The specified cluster qualifies for migration.
401 Unauthorized	Response details	The user is unauthorized on the source cluster.
412 PreconditionFailed	Response details	The cluster failed at least one validation condition and doesn't qualify for migration.
Other Status Codes	Error response	Common error codes: InvalidItemType - Item type is invalid. ItemDisplayNameAlreadyInUse - Item display name is already used. CorruptedPayload - The provided payload is corrupted.

Response details

Name	Type	Description
validationType	string	The type of validation response. Valid values: Success: Indicates that the specified cluster qualifies for migration. Warning: Indicates that the specified cluster qualifies for migration. However, there are warnings, such as the cluster has a feature in Azure that isn't supported Fabric and won't transition as part of the migration. Error: Indicates that the specified cluster doesn't qualify for migration.
statusCode	string	The HTTP status code, such as OK (200), Unauthorized (401), and PreconditionFailed (412).
messageCode	string	For errors and warnings, a code that indicates the specific reason for why the cluster doesn't qualify for migration. For example: UserIsUnauthorizedOnSourceCluster, EntityNotFoundException
message	string	The message that provides additional information about the validation result.
CustomParameters	object	For errors and warnings, a JSON object that provides more details with specific custom information about the validation result.

Examples

Sample request

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/eventhouses/validateMigrationFromAzure

{
  "clusterUrl": "https://{PoolName}.{WorkspaceName}.kusto.azuresynapse.net"
}

Sample responses

Success

{
  "ValidationType": "Success",
  "StatusCode": "OK",
  "MessageCode": null,
  "Message": null,
  "CustomParameters":  ""
}

Warning

{
  "ValidationType": "Warning",
  "StatusCode": "OK",
  "MessageCode": "ClusterValidForMigrationWithWarnings",
  "Message": "Cluster 'PoolName' is valid for Fabric migration, but has warnings.",
  "CustomParameters": "{\"PrivateEndpointsWarning\": \"Cluster has Private Endpoints. Private Endpoints are not supported in Fabric.\", \"FirewallRulesWarning\": \"Cluster has Firewall rules. Firewall rules are not supported in Fabric.\"}"
}

Error

{
  "ValidationType": "Error",
  "StatusCode": "Unauthorized",
  "MessageCode": "UserUnauthorizedOnSourceCluster",
  "Message": "User is unauthorized on the source cluster",
  "CustomParameters": "{}"
}

Share via