Skip to main content

Shortcut

Properties

PropertyTypeAttributesDescription
itemIdstringRequired, IdentifierThe item ID
namestringRequired, IdentifierThe name of the shortcut
pathstringRequired, IdentifierThe full path where the shortcut is created, including either 'Files' or 'Tables'
targetShortcutTargetRequiredThe target datasource. Must specify exactly one of the supported destinations
workspaceIdstringRequired, IdentifierThe Workspace ID
shortcutConflictPolicy'Abort' | 'CreateOrOverwrite' | 'OverwriteOnly' | 'GenerateUniqueName'The action to take when a shortcut with the same name and path already exists. Defaults to Abort

ShortcutTarget

PropertyTypeAttributesDescription
adlsGen2ShortcutAdlsGen2TargetAn object containing the properties of the target ADLS Gen2 data source
amazonS3ShortcutAmazonS3TargetAn object containing the properties of the target Amazon S3 data source
azureBlobStorageShortcutAzureBlobStorageTargetAn object containing the properties of the target Azure Blob Storage data source
dataverseShortcutDataverseTargetAn object containing the properties of the target Dataverse data source
externalDataShareShortcutExternalDataShareTargetRead-onlyAn object containing the properties of the target external data share
googleCloudStorageShortcutGoogleCloudStorageTargetAn object containing the properties of the target Google Cloud Storage data source
oneDriveSharePointShortcutOneDriveSharePointTargetAn object containing the properties of the target OneDrive for Business & SharePoint Online data source
oneLakeShortcutOneLakeTargetAn object containing the properties of the target OneLake data source
s3CompatibleShortcutS3CompatibleTargetAn object containing the properties of the target S3 compatible data source
typestringRead-onlyThe type of the target shortcut account

ShortcutAdlsGen2Target

PropertyTypeAttributesDescription
connectionIdstringRequiredThe ID of the connection bound with the shortcut
locationstringRequiredThe location of the target ADLS container, in the format https://[account-name].dfs.core.windows.net
subpathstringRequiredThe container and subfolder within the ADLS account where the target folder is located, in the format [container]/[subfolder]

ShortcutAmazonS3Target

PropertyTypeAttributesDescription
connectionIdstringRequiredThe ID of the connection bound with the shortcut
locationstringRequiredThe HTTP URL that points to the target bucket in S3, in the format https://[bucket-name].s3.[region-code].amazonaws.com
subpathstringRequiredThe target folder or subfolder within the S3 bucket

ShortcutAzureBlobStorageTarget

PropertyTypeAttributesDescription
connectionIdstringRequiredThe ID of the connection bound with the shortcut
locationstringRequiredThe location of the target Azure Blob Storage container, in the format https://[account-name].blob.core.windows.net
subpathstringRequiredThe container and subfolder within the Azure Blob Storage account where the target folder is located, in the format [container]/[subfolder]

ShortcutDataverseTarget

PropertyTypeAttributesDescription
connectionIdstringRequiredThe ID of the connection bound with the shortcut
deltalakeFolderstringRequiredThe DeltaLake folder path where the target data is stored
environmentDomainstringRequiredThe URI of the Dataverse target environment's domain, in the format https://[orgname].crm[xx].dynamics.com
tableNamestringRequiredThe name of the target table in Dataverse

ShortcutExternalDataShareTarget

PropertyTypeAttributesDescription
connectionIdstringRead-onlyThe ID of the connection bound with the shortcut

ShortcutGoogleCloudStorageTarget

PropertyTypeAttributesDescription
connectionIdstringRequiredThe ID of the connection bound with the shortcut
locationstringRequiredThe HTTP URL that points to the target bucket in GCS, in the format https://[bucket-name].storage.googleapis.com
subpathstringRequiredThe target folder or subfolder within the GCS bucket

ShortcutOneDriveSharePointTarget

PropertyTypeAttributesDescription
connectionIdstringRequiredThe ID of the connection bound with the shortcut
locationstringRequiredThe location of the target OneDrive SharePoint container, in the format https://microsoft.sharepoint.com
subpathstringRequiredThe container and subfolder within the OneDrive SharePoint account where the target folder is located, in the format [container]/[subfolder]
updateFabricItemSensitivityboolWhether the Fabric item sensitivity label should be kept consistent with the SharePoint site level label. Defaults to false

ShortcutOneLakeTarget

PropertyTypeAttributesDescription
itemIdstringRequiredThe ID of the target item in OneLake. The target can be an item of Lakehouse, KQLDatabase, or Warehouse
pathstringRequiredThe full path to the target folder within the item, relative to the root of the OneLake directory structure
workspaceIdstringRequiredThe ID of the target workspace

ShortcutS3CompatibleTarget

PropertyTypeAttributesDescription
bucketstringRequiredThe target bucket within the S3 compatible location
connectionIdstringRequiredThe ID of the connection bound with the shortcut
locationstringRequiredThe HTTP URL of the S3 compatible endpoint, without a bucket specified
subpathstringRequiredThe target folder or subfolder within the S3 compatible bucket