lakehouse_create_shortcut
Create a shortcut in a lakehouse to unify external data sources like ADLS Gen2, S3, or Dataverse under Files or Tables, enabling direct access as files, tables, or schemas.
Instructions
Create a OneLake shortcut in a lakehouse at any level (file, folder, table, or schema). For schema-enabled lakehouses (preview): set path='Tables' and name to the desired schema name to create a schema shortcut that imports all Delta tables from the target as a new schema. For table-level shortcuts within a schema: set path='Tables/'. Supports targets: OneLake, ADLS Gen2, Amazon S3, Google Cloud Storage, S3 Compatible, Dataverse, Azure Blob Storage, OneDrive/SharePoint.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Name of the shortcut. For schema shortcuts, this becomes the schema name. | |
| path | Yes | Full path where the shortcut is created. Must start with 'Files' or 'Tables'. Examples: 'Files' (file at root), 'Files/landingZone' (file in subfolder), 'Tables' (schema shortcut — name becomes the schema, target should be a schema or folder of Delta tables), 'Tables/dbo' (table shortcut within the dbo schema), 'Tables/mySchema' (table shortcut within a custom schema) | |
| target | Yes | Target datasource — specify exactly one: oneLake, adlsGen2, amazonS3, googleCloudStorage, s3Compatible, dataverse, azureBlobStorage, or oneDriveSharePoint | |
| lakehouseId | Yes | The lakehouse ID (item ID) where the shortcut will be created | |
| workspaceId | Yes | The workspace ID where the lakehouse resides | |
| shortcutConflictPolicy | No | Action when a shortcut with the same name and path already exists (default: Abort) |