fabric-cli

external data share examples

Type: .ExternalDataShare

Supported commands: fab desc .ExternalDataShare

Navigate to an external data share using cd command. External data shares for all supporting items are included in .externaldatashares within a workspace. You can use relative and absolute paths based on current context.

# use absolute path
fab:/ws1.Workspace$ cd .externaldatashares
* Switched to '.externaldatashares'

# use relative path
fab:/ws1.Workspace$ cd .externaldatashares/eds1.ExternalDataShare
* Switched to 'eds1.ExternalDataShare'

Checking if an external data share exists

Verify if an external data share exists. Using exists on .externaldatashares has no effect.

fab:/ws1.Workspace$ exists .externaldatashares/lh1.Lakehouse_f9e2dd00.ExternalDataShare
* true

fab:/ws1.Workspace$ exists .externaldatashares/lh1.Lakehouse_f9e2dd00_.ExternalDataShare
* false

Getting and querying external data share details

Retrieve and query external data share details with -q (JMESPath query). Output the result to a local path or Lakehouse/Files with -o.

# query using JMESPath
fab:/ws1.Workspace$ get .externaldatashares/lh1.Lakehouse_f9e2dd00.ExternalDataShare -q .

# export result
fab:/ws1.Workspace$ get .externaldatashares/lh1.Lakehouse_f9e2dd00.ExternalDataShare -q . -o /tmp

Listing external data shares

List existing external data shares and their details using -l.

fab:/ws1.Workspace$ ls .externaldatashares
fab:/ws1.Workspace$ ls .externaldatashares -l

Creating an external data share

Create an external data share with required parameters. Note that “External data sharing” tenant setting must be enabled.

# create an external data share
fab:/ws1.Workspace$ create .externaldatashares/eds1.ExternalDataShare -P item=lh1.lakehouse,paths=[Files/csv],recipient.tenantId=00000000-0000-0000-0000-000000000000,recipient.userPrincipalName=fabcli@microsoft.com
! Ensure tenant setting is enabled for External data sharing
! External Data Share will use the Item name and the ExternalDataShare id - provided name is ignored
Creating a new External Data Share...
* 'lh1.Lakehouse_dbf43094.ExternalDataShare' created

Revoking an external data share

Revoking an external data share. Use -f to force.

fab:/ws1.Workspace$ rm .externaldatashares/lh1.Lakehouse_f9e2dd00.ExternalDataShare
fab:/ws1.Workspace$ rm .externaldatashares/lh1.Lakehouse_f9e2dd00.ExternalDataShare -f

See all examples