Microsoft Fabric CLI

https://microsoft.github.io/fabric-cli
Admin
The Microsoft Fabric CLI provides command-line access to Microsoft Fabric, allowing developers and...
Tokens:83,069
Snippets:1,124
Trust Score:8.3
Update:1 week ago
Show doc for...
Tokens:
Raw
### job start examples

Source: https://microsoft.github.io/fabric-cli/commands/jobs

Examples of starting a pipeline and a notebook with parameters and configuration.

```bash
fab job start pipeline1.datapipeline
fab job start notebook1.notebook -P param1:string=value1,param2:int=42
fab job start notebook1.notebook -C '{"spark.executor.memory": "4g"}'

```

--------------------------------

### Example: fab start ws1.Workspace/nb1.Notebook

Source: https://microsoft.github.io/fabric-cli/commands/fs/start

Example of starting a notebook resource using the `fab start` command.

```bash
fab start ws1.Workspace/nb1.Notebook

```

--------------------------------

### Configuration Examples: Get and Set Output Format

Source: https://microsoft.github.io/fabric-cli/essentials/output_format

Shows how to check the current output format with `fab config get output_format`, change it to JSON with `fab config set output_format json`, and then verify that subsequent commands (like `fab auth status`) use JSON. Also demonstrates overriding the default for a single command with `--output_format text`.

```bash
# Check current output format
$ fab config get output_format
text

# Change to JSON as default
$ fab config set output_format json
* Configuration 'output_format' set to 'json'

# All subsequent commands use JSON
$ fab auth status
{
    "timestamp": "2026-01-06T08:00:00.000Z",
    "status": "Success",
    "command": "auth",
    "result": {
        "data": [
            {
                "logged_in": "true",
                "account": "user@example.com",
                "tenant_id": "12345678-1234-1234-1234-123456789012"
            }
        ]
    }
}

# Override for single command
$ fab auth status --output_format text
Logged In: true
Account: user@example.com
Tenant ID: 12345678-1234-1234-1234-123456789012
```

--------------------------------

### Get ACL - Examples

Source: https://microsoft.github.io/fabric-cli/commands/acls

Examples of getting ACL details for a workspace and an item.

```bash
# Get workspace acl
fab acl get ws1.Workspace

# Get item acl
fab acl get ws1.Workspace/lh1.Lakehouse

```

--------------------------------

### job run examples

Source: https://microsoft.github.io/fabric-cli/commands/jobs

Examples of running a notebook with a timeout and with parameters.

```bash
fab job run notebook1.notebook --timeout 3600
fab job run notebook1.notebook -P input_date:string=2024-01-01

```

--------------------------------

### Example: fab open ws1.Workspace/nb1.Notebook

Source: https://microsoft.github.io/fabric-cli/commands/fs/open

Example command that opens the specified workspace or item in the browser.

```bash
fab open ws1.Workspace/nb1.Notebook

```

--------------------------------

### Run pipelines and start notebooks with fab run and fab start

Source: https://microsoft.github.io/fabric-cli

Runs a pipeline with an optional input and starts a notebook. Replace the placeholders with actual workspace, pipeline, and notebook names.

```bash
# Run a pipeline
fab run <name of the workspace>.Workspace/<name of the pipeline>.DataPipeline -i <optional input>

# Start a notebook
fab start <name of the workspace>.Workspace/<name of the notebook>.Notebook

```

--------------------------------

### job start usage

Source: https://microsoft.github.io/fabric-cli/commands/jobs

Shows the syntax for the `fab job start` command, which starts an item asynchronously and returns a job ID.

```bash
fab job start <path> [-P <params>] [-C <config>] [-i <json_inline_or_path>]

```

--------------------------------

### Usage: fab start <path> [-f]

Source: https://microsoft.github.io/fabric-cli/commands/fs/start

Shows the command syntax for starting a resource. The `<path>` parameter specifies the resource, and the optional `-f` or `--force` flag forces the start without confirmation.

```bash
fab start <path> [-f]

```

--------------------------------

### fab start

Source: https://microsoft.github.io/fabric-cli/examples/item_examples

Start data synchronization for a mirrored database. Optionally force start without confirmation.

```APIDOC
## fab start

### Description
Start data synchronization for a mirrored database. Optionally force start without confirmation.

### Method
CLI

### Command
`fab start <item> [-f]`

### Parameters
- **item** (string) - Required - Mirrored database item path in the format `workspace/item.MirroredDatabase`.
- **-f, --force** (boolean) - Optional - Force start without confirmation.

### Examples
#### Start Mirrored Database
```
fab start ws1.Workspace/mir1.MirroredDatabase
```

#### Force Start Mirrored Database
```
fab start ws1.Workspace/mir1.MirroredDatabase -f
```

```

--------------------------------

### Example: Create a workspace with fab mkdir ws1.Workspace

Source: https://microsoft.github.io/fabric-cli/commands/fs/mkdir

Creates a new workspace named `ws1` using the `mkdir` command. This is the only concrete example provided on the page.

```bash
fab mkdir ws1.Workspace

```

--------------------------------

### table load examples

Source: https://microsoft.github.io/fabric-cli/commands/tables

Examples of loading data with different formats and modes, including CSV and Parquet.

```bash
fab table load Tables/employees --file employees.csv
fab table load Tables/sales --file sales_data --format format=parquet --mode append
fab table load Tables/data --file data.csv --format format=csv,delimiter=';',header=true

```

--------------------------------

### Start Mirrored Database

Source: https://microsoft.github.io/fabric-cli/examples/item_examples

Starts data synchronization for a mirrored database.

```bash
fab start ws1.Workspace/mir1.MirroredDatabase

```

--------------------------------

### Example: fab get ws1.Workspace -q .

Source: https://microsoft.github.io/fabric-cli/commands/fs/get

Retrieves the complete object for the workspace `ws1.Workspace` using the JMESPath query `.`.

```text
fab get ws1.Workspace -q .

```

--------------------------------

### cd command example

Source: https://microsoft.github.io/fabric-cli/commands/fs/cd

Example of changing to the directory named ws1.Workspace using the cd command.

```bash
fab cd ws1.Workspace

```

--------------------------------

### table schema example

Source: https://microsoft.github.io/fabric-cli/commands/tables

Example of displaying the schema of a table.

```bash
fab table schema Tables/employees

```

--------------------------------

### Examples: fab ls with flags and JMESPath queries

Source: https://microsoft.github.io/fabric-cli/commands/fs/ls

Demonstrates common usages: listing a workspace, long format, and filtering with JMESPath queries. The last example filters items by id.

```bash
fab ls ws1.Workspace
fab ls -l

# Using JEMSPath to filter items within ws1 workspace
fab ls -l -q [].{name:name}
fab ls ws1.Workspace -q [?contains(name, 'report')]
fab ls -l -q [?id=='123456']

```

--------------------------------

### table optimize examples

Source: https://microsoft.github.io/fabric-cli/commands/tables

Examples of optimizing tables with V-Order and Z-Order techniques.

```bash
fab table optimize Tables/sales --vorder
fab table optimize Tables/customers --zorder customer_id,region
fab table optimize Tables/transactions --vorder --zorder date,product_id

```

--------------------------------

### Start capacity with interactive confirmation using fab start .capacities/capac1.Capacity

Source: https://microsoft.github.io/fabric-cli/examples/capacity_examples

Starts a stopped capacity with interactive confirmation.

```bash
fab start .capacities/capac1.Capacity

```

--------------------------------

### Start capacity without confirmation using fab start .capacities/capac1.Capacity -f

Source: https://microsoft.github.io/fabric-cli/examples/capacity_examples

Starts a capacity without confirmation prompts.

```bash
fab start .capacities/capac1.Capacity -f

```

--------------------------------

### Bulk-export workspace and folder examples

Source: https://microsoft.github.io/fabric-cli/commands/fs/bulk_export

Two examples: one exports an entire workspace, the other exports a specific folder. Both use --recursive and --force to skip prompts.

```bash
# Bulk-export an entire workspace to a local directory
fab bulk-export ws1.Workspace -o /tmp --recursive --force
```

```bash
# Bulk-export a specific folder
fab bulk-export ws1.Workspace/folder1.Folder -o /tmp --recursive --force
```

--------------------------------

### Examples: fab api commands

Source: https://microsoft.github.io/fabric-cli/commands/api

Four example invocations of the `api` command: listing workspaces, showing headers for a specific workspace, filtering with a JMESPath query, and creating an item with a POST request.

```bash
fab api workspaces

```

```bash
fab api workspaces/11111111-2222-3333-4444-555555555555 --show_headers

```

```bash
fab api workspaces -q "value[?type=='Workspace']"

```

```bash
fab api workspaces/11111111-2222-3333-4444-555555555555/items -X post -H "content-type=application/json" -i '{"displayName": "Item Name", "type": "Report"}'

```

--------------------------------

### job run-sch examples

Source: https://microsoft.github.io/fabric-cli/commands/jobs

Examples of scheduling a notebook daily, a pipeline weekly, and using a JSON configuration file.

```bash
fab job run-sch notebook1.notebook --type daily --interval "09:00,15:00"
fab job run-sch pipeline1.datapipeline --type weekly --interval "19:00" --days "Monday,Wednesday"
fab job run-sch notebook1.notebook -i schedule_config.json

```

--------------------------------

### GitHub Actions example for Fabric CLI

Source: https://microsoft.github.io/fabric-cli

GitHub Actions workflow step that installs the Fabric CLI, authenticates with service principal secrets, and imports a lakehouse artifact.

```yaml
- name: Deploy to Fabric
  run: |
    pip install ms-fabric-cli
    fab auth login -u ${{ secrets.CLIENT_ID }} -p ${{ secrets.CLIENT_SECRET }} --tenant ${{ secrets.TENANT_ID }}
    fab import Production.Workspace/Data.Lakehouse -i ./artifacts/DataToImport.Lakehouse

```

--------------------------------

### Azure Pipelines example for Fabric CLI

Source: https://microsoft.github.io/fabric-cli

Azure Pipelines script step that installs the Fabric CLI, authenticates with pipeline variables, and runs a data pipeline.

```yaml
- script: |
    pip install ms-fabric-cli
    fab auth login -u $(CLIENT_ID) -p $(CLIENT_SECRET) --tenant $(TENANT_ID)
    fab run ETL.Workspace/DailyRefresh.DataPipeline
  displayName: 'Run Fabric pipeline'

```

--------------------------------

### Example: fab stop ws1.Workspace/nb1.Notebook

Source: https://microsoft.github.io/fabric-cli/commands/fs/stop

Stops the notebook resource at the given path. This example uses the default confirmation prompt.

```bash
fab stop ws1.Workspace/nb1.Notebook

```

--------------------------------

### Get folder details with fab get

Source: https://microsoft.github.io/fabric-cli/examples/folder_examples

Retrieves full folder details.

```bash
fab get ws1.Workspace/fd1.Folder
```

--------------------------------

### Force Start Mirrored Database

Source: https://microsoft.github.io/fabric-cli/examples/item_examples

Starts a mirrored database without confirmation.

```bash
fab start ws1.Workspace/mir1.MirroredDatabase -f

```

--------------------------------

### Example: fab assign .capacities/cap.Capacity -W ws1.Workspace

Source: https://microsoft.github.io/fabric-cli/commands/fs/assign

Assigns the capacity resource at `.capacities/cap.Capacity` to the workspace `ws1.Workspace`.

```bash
fab assign .capacities/cap.Capacity -W ws1.Workspace

```

--------------------------------

### Examples: fab desc .Capacity and fab desc .capacities/capac1.Capacity

Source: https://microsoft.github.io/fabric-cli/commands/desc

Two example invocations of the `desc` command. The first checks support for the `.Capacity` resource type. The second checks support for a specific resource path `.capacities/capac1.Capacity`.

```bash
fab desc .Capacity
```

```bash
fab desc .capacities/capac1.Capacity
```

--------------------------------

### table vacuum examples

Source: https://microsoft.github.io/fabric-cli/commands/tables

Examples of vacuuming tables with and without a custom retention period.

```bash
fab table vacuum Tables/logs
fab table vacuum Tables/temp_data --retain_n_hours 24

```

--------------------------------

### Output summary example

Source: https://microsoft.github.io/fabric-cli/commands/fs/bulk_export

Example of the success output printed by the command, showing the number of exported and skipped items.

```text
Exported 15 items to '/tmp'. Skipped 1 items due to unsupported item types: Dashboard (1)
```

--------------------------------

### Examples for label set

Source: https://microsoft.github.io/fabric-cli/commands/labels

Examples of applying sensitivity labels to different resource types. The `-f` flag skips the confirmation prompt.

```bash
fab label set notebook1.notebook -n Confidential
fab label set lh1.lakehouse -n "Highly Confidential" -f
fab label set workspace1.workspace -n Internal
```

--------------------------------

### Output directory structure example

Source: https://microsoft.github.io/fabric-cli/commands/fs/bulk_export

Shows the folder structure of the exported output, mirroring the workspace hierarchy.

```text
<output_path>/
├── notebook1.Notebook/
│   ├── .platform
│   └── notebook-content.ipynb
├── Folder1/
│   ├── notebook2.Notebook/
│   │   ├── .platform
│   │   └── notebook-content.ipynb
│   └── report1.Report/
│       ├── .platform
│       ├── definition.pbir
│       └── StaticResources/
│           └── ...
└── Folder2/
    └── model1.SemanticModel/
        ├── .platform
        └── definition/
            ├── model.tmdl
            └── ...
```

--------------------------------

### Get capacity details with fab get .capacities/capac1.Capacity

Source: https://microsoft.github.io/fabric-cli/examples/capacity_examples

Retrieves capacity details.

```bash
fab get .capacities/capac1.Capacity

```

--------------------------------

### Example: fab ln ws1.Workspace/shortcut --type lakehouse --target ws2.Workspace/lh.Lakehouse

Source: https://microsoft.github.io/fabric-cli/commands/fs/ln

Creates a shortcut using the `--type` and `--target` parameters. This example uses `--type lakehouse` and `--target` for an internal OneLake shortcut.

```bash
fab ln ws1.Workspace/shortcut --type lakehouse --target ws2.Workspace/lh.Lakehouse

```

--------------------------------

### Example: fab exists ws1.Workspace/nb1.Notebook

Source: https://microsoft.github.io/fabric-cli/commands/fs/exists

Checks if the specified workspace or notebook exists.

```bash
fab exists ws1.Workspace/nb1.Notebook

```

--------------------------------

### Usage: fab get

Source: https://microsoft.github.io/fabric-cli/commands/fs/get

Shows the command syntax for `fab get`, including optional flags for JMESPath query, output path, verbose, and force.

```text
fab get <path> [-q <jmespath_query>] [-o <output_path>] [-v] [-f]

```

--------------------------------

### Example: fab set ws1.Workspace -q displayName -i "New Name" -f

Source: https://microsoft.github.io/fabric-cli/commands/fs/set

Example command that sets the display name of a workspace to 'New Name' using the force flag.

```bash
fab set ws1.Workspace -q displayName -i "New Name" -f

```

--------------------------------

### Install ms-fabric-cli with pip

Source: https://microsoft.github.io/fabric-cli

Install the latest version of the Fabric CLI (fab) on Windows, macOS, or Linux using pip.

```bash
pip install ms-fabric-cli
```

--------------------------------

### Get a configuration value with fab config get

Source: https://microsoft.github.io/fabric-cli/commands/config

Retrieves the value of a specific configuration setting. Usage: `fab config get <key>`. Examples show retrieving `mode`, `local_definition_labels`, and `encryption_fallback_enabled`.

```bash
fab config get <key>

```

```bash
fab config get mode
fab config get local_definition_labels
fab config get encryption_fallback_enabled

```

--------------------------------

### fab find command examples

Source: https://microsoft.github.io/fabric-cli/commands/find

Examples of the find command with various filters and options. The -P parameter supports type filtering with = and != operators, and bracket syntax for multiple values. The -l flag shows detailed output, and -q applies a JMESPath query client-side.

```bash
# search for items by name or description
fab find 'sales report'

# search for lakehouses only
fab find 'data' -P type=Lakehouse

# search for multiple item types (bracket syntax)
fab find 'dashboard' -P type=[Report,SemanticModel]

# exclude a type
fab find 'data' -P type!=Dashboard

# show detailed output with IDs
fab find 'sales' -l

# combine filters
fab find 'finance' -P type=[Warehouse,Lakehouse] -l

# project specific fields
fab find 'data' -q "[].{name: name, workspace: workspace}"

```

--------------------------------

### Show configuration help

Source: https://microsoft.github.io/fabric-cli/examples/config_examples

Displays help for the `fab config` command, listing all available configuration commands and parameters.

```bash
fab config -h
```

--------------------------------

### View authentication help

Source: https://microsoft.github.io/fabric-cli/examples/auth_examples

Run this command to explore all authentication commands and their parameters.

```bash
fab auth -h

```

--------------------------------

### End-to-End Example: Run Refresh and Poll for Completion (PowerShell)

Source: https://microsoft.github.io/fabric-cli/examples/refresh_semantic_model_example

PowerShell script that runs a refresh, extracts the polling endpoint from the `Location` or `RequestId` header, and polls until completion. Expects a 202 status on POST and 200/202 on GET. Replace placeholders `{WORKSPACE_ID}`, `{SEMANTIC_MODEL_ID}`, and `{POLLING_INTERVAL}` before running.

```powershell
# Configuration
$WorkspaceId = "{WORKSPACE_ID}"
$SemanticModelId = "{SEMANTIC_MODEL_ID}"
$PollingInterval = {POLLING_INTERVAL}  # seconds

# Customize the request body according to your needs
$requestBody = '{"retryCount":"1"}'

$refreshResponse = fab api -A powerbi -X post "groups/$WorkspaceId/datasets/$SemanticModelId/refreshes" --show_headers -i $requestBody

# Parse the response as JSON and check status code

$refreshJson = $refreshResponse | ConvertFrom-Json
$statusCode = $refreshJson.status_code

# Check POST response status (expecting 202 Accepted)
if ($statusCode -ne 202) {
    exit 1
}

$pollingEndpoint = $null

# Try to extract Location header first (preferred method)
if ($refreshJson.headers.Location) {
    $locationUrl = $refreshJson.headers.Location
    if ($locationUrl -match 'https?://[^/]+/v1\.0/myorg/(.+)') {
        $pollingEndpoint = $Matches[1].Trim()
    }
}

# Fallback to RequestId header if Location not present
if (-not $pollingEndpoint) {
    if ($refreshJson.headers.RequestId) {
        $refreshId = $refreshJson.headers.RequestId
        $pollingEndpoint = "groups/$WorkspaceId/datasets/$SemanticModelId/refreshes/$refreshId"
    }
}

if (-not $pollingEndpoint) {
    exit 1
}

$status = ""

while ($true) {
    Start-Sleep -Seconds $PollingInterval

    $statusResponse = fab api -A powerbi $pollingEndpoint --show_headers

    $statusResponseJson = $statusResponse | ConvertFrom-Json
    $getStatusCode = $statusResponseJson.status_code

    # Check GET response status (expecting 200 or 202)
    if ($getStatusCode -ne 200 -and $getStatusCode -ne 202) {
        Write-Host $statusResponse
    }

    $statusJson = $statusResponseJson.text

    $status = if ($statusJson.extendedStatus) { $statusJson.extendedStatus } else { $statusJson.status }

    Write-Host "  Refresh Status: $status" -ForegroundColor Cyan

    # Then handle completion states
    switch -Regex ($status) {
        "^Completed$" {
            exit 0
        }
        "^(Failed|Cancelled|Disabled|TimedOut)$" {
            Write-Host $statusResponse
            exit 1
        }
        "^(NotStarted|InProgress|Unknown)$" {
            # Continue polling
        }
        default {
            Write-Host $statusResponse
            exit 1
        }
    }
}

```

--------------------------------

### Describe Connection Resource Type

Source: https://microsoft.github.io/fabric-cli/examples/connection_examples

Run `fab desc .Connection` to explore all connection commands and their parameters.

```bash
fab desc .Connection
```

--------------------------------

### Example: Move notebook between workspaces

Source: https://microsoft.github.io/fabric-cli/commands/fs/mv

Moves a notebook item from one workspace to another. The item definition is moved without its sensitivity label.

```bash
fab mv ws1.Workspace/nb1.Notebook ws2.Workspace

```

--------------------------------

### Export capacity details to local directory with fab get .capacities/capac1.Capacity -q . -o /tmp

Source: https://microsoft.github.io/fabric-cli/examples/capacity_examples

Exports capacity details to a local directory.

```bash
fab get .capacities/capac1.Capacity -q . -o /tmp

```

--------------------------------

### Get workspace permissions with fab acl get

Source: https://microsoft.github.io/fabric-cli/examples/acl_examples

Gets complete workspace permissions in JSON format, can query principals, and export to a local directory.

```bash
# Get complete workspace permissions (JSON format)
fab acl get ws1.Workspace

# Query workspace permission principals
fab acl get ws1.Workspace -q "[*].principal"

# Export workspace permissions to local directory
fab acl get ws1.Workspace -q "[*].principal" -o /tmp

```

--------------------------------

### Get OneLake RBAC permissions with fab acl get

Source: https://microsoft.github.io/fabric-cli/examples/acl_examples

Gets complete OneLake permissions in JSON format, can query members, and export to local directory.

```bash
# Get complete OneLake permissions (JSON format)
fab acl get ws1.Workspace/lh1.Lakehouse/Files

# Query OneLake permission members
fab acl get ws1.Workspace/lh1.Lakehouse/Files -q "[].members"

# Export OneLake permissions to local directory
fab acl get ws1.Workspace/lh1.Lakehouse/Files -q "[].members" -o /tmp

```

--------------------------------

### View all available parameters with fab --help

Source: https://microsoft.github.io/fabric-cli/essentials/parameters

Use this command to display all available parameters and their descriptions for the Fabric CLI.

```bash
fab --help

```

--------------------------------

### Get item permissions with fab acl get

Source: https://microsoft.github.io/fabric-cli/examples/acl_examples

Gets complete item permissions in JSON format, can query principals, and export to local directory or Lakehouse Files.

```bash
# Get complete item permissions (JSON format)
fab acl get ws1.Workspace/lh1.Lakehouse

# Query item permission principals
fab acl get ws1.Workspace/lh1.Lakehouse -q "[*].principal"

# Export to local directory
fab acl get ws1.Workspace/lh1.Lakehouse -o /tmp

# Export to Lakehouse Files
fab acl get ws1.Workspace/lh1.Lakehouse -o /ws1.Workspace/lh1.Lakehouse/Files

```

--------------------------------

### Show job command help

Source: https://microsoft.github.io/fabric-cli/examples/job_examples

Run `fab job -h` to explore all job commands and their parameters.

```bash
fab job -h
```

--------------------------------

### Run Notebook with Configuration and Parameters

Source: https://microsoft.github.io/fabric-cli/examples/job_examples

Combines configuration and parameters in a single notebook job execution using `-P` and `-C` flags.

```bash
fab job run ws1.Workspace/nb1.Notebook -P string_param:string=new_value -C '{"environment": {"id": "<environment_id>", "name": "<environment_name>"}}'

```

--------------------------------

### job start

Source: https://microsoft.github.io/fabric-cli/commands/jobs

Start an item asynchronously and return immediately with a job ID.

```APIDOC
## job start

### Description
Start an item asynchronously and return immediately with a job ID.

### Usage
```
fab job start <path> [-P <params>] [-C <config>] [-i <json_inline_or_path>]
```

### Parameters
- `<path>` (string) - Required - Path to the resource.
- `-P, --params` (string) - Optional - Parameters in name:type=value format, comma-separated.
- `-C, --config` (string) - Optional - JSON configuration for notebooks.
- `-i, --input` (string) - Optional - JSON payload for additional configuration.

### Examples
```
fab job start pipeline1.datapipeline
fab job start notebook1.notebook -P param1:string=value1,param2:int=42
fab job start notebook1.notebook -C '{"spark.executor.memory": "4g"}'
```
```

--------------------------------

### List Gateways in Simple Format

Source: https://microsoft.github.io/fabric-cli/examples/gateway_examples

Display existing gateways in a simple format.

```bash
fab ls .gateways

```

--------------------------------

### Show help for desc command

Source: https://microsoft.github.io/fabric-cli/examples/desc_examples

Run `fab desc -h` to explore all describe commands and their parameters.

```bash
fab desc -h

```

--------------------------------

### Open Item in Web Interface

Source: https://microsoft.github.io/fabric-cli/examples/item_examples

Launches an item in the default web browser.

```bash
fab open ws1.Workspace/lh1.Lakehouse

```

--------------------------------

### Remove ACL - Example

Source: https://microsoft.github.io/fabric-cli/commands/acls

Example of removing access for a specific identity from a workspace.

```bash
fab acl rm ws1.Workspace -I 11111111-2222-3333-4444-555555555555

```

--------------------------------

### Get domain details with fab get .domains/finance.Domain

Source: https://microsoft.github.io/fabric-cli/examples/domain_examples

Retrieves the details of the specified domain.

```bash
fab get .domains/finance.Domain

```

--------------------------------

### Set ACL - Example

Source: https://microsoft.github.io/fabric-cli/commands/acls

Example of setting a viewer role for a specific identity on a workspace.

```bash
fab acl set ws1.Workspace -I 11111111-2222-3333-4444-555555555555 -R viewer

```

--------------------------------

### List Connections with Details

Source: https://microsoft.github.io/fabric-cli/examples/connection_examples

Show connections with detailed information including connection type, parameters, and configuration.

```bash
fab ls .connections -l
```

--------------------------------

### fab open

Source: https://microsoft.github.io/fabric-cli/examples/item_examples

Launch an item in the default web browser.

```APIDOC
## fab open

### Description
Launch an item in the default web browser.

### Method
CLI

### Command
`fab open <item>`

### Parameters
- **item** (string) - Required - Item path in the format `workspace/item.ItemType`.

### Example
```
fab open ws1.Workspace/lh1.Lakehouse
```

```

--------------------------------

### Create Connection with All Parameters

Source: https://microsoft.github.io/fabric-cli/examples/connection_examples

Create a connection with comprehensive configuration including privacy level and encryption settings.

```bash
fab create .connections/conn.Connection -P privacyLevel=Private,connectionDetails.creationMethod=SQL,gatewayId=852aee7c-d056-48dc-891f-9d7110a01b88,connectionDetails.type=SQL,connectionDetails.parameters.server=<server>,connectionDetails.parameters.database=sales,credentialDetails.type=Basic,credentialDetails.username=<username>,credentialDetails.password=<password>,credentialDetails.connectionEncryption=NotEncrypted,credentialDetails.skipTestConnection=False
```

--------------------------------

### Examples for label rm

Source: https://microsoft.github.io/fabric-cli/commands/labels

Examples of removing sensitivity labels from resources. The `-f` flag skips the confirmation prompt.

```bash
fab label rm notebook1.notebook
fab label rm lh1.lakehouse -f
```

--------------------------------

### Explore API commands with `fab api -h`

Source: https://microsoft.github.io/fabric-cli/examples/api_examples

Run this command to see all API commands and their parameters.

```bash
fab api -h

```

--------------------------------

### List ACLs - Examples

Source: https://microsoft.github.io/fabric-cli/commands/acls

Examples of listing ACLs for a workspace, filtering workspace admins, and listing lakehouse item ACLs.

```bash
# List workspace acls
fab acl ls ws1.workspace

# List workspace admins acls
fab acl ls ws1.workspace -q [].[?role=='Admin']

# List lakehouse item acls
fab acl ls ws1.workspace/lh1.lakehouse
fab acl ls ws1.workspace/lh1.lakehouse/Files/data

```

--------------------------------

### Usage: fab ln <path> --type <type> [--target <target>] [-i <input>] [-f]

Source: https://microsoft.github.io/fabric-cli/commands/fs/ln

Shows the command syntax for creating a shortcut. The `<path>` is required, `--type` is required, and `--target`, `-i`, and `-f` are optional.

```bash
fab ln <path> --type <type> [--target <target>] [-i <input>] [-f]

```

--------------------------------

### Run Notebook with Configuration File

Source: https://microsoft.github.io/fabric-cli/examples/job_examples

Executes a notebook job with configuration loaded from a JSON file using the `-C` flag.

```bash
fab job start ws1.Workspace/nb1.Notebook -C ./config_file.json

```

--------------------------------

### List Connections

Source: https://microsoft.github.io/fabric-cli/examples/connection_examples

Display all available connections in simple format.

```bash
fab ls .connections
```

--------------------------------

### Get files using parameters

Source: https://microsoft.github.io/fabric-cli/examples/api_examples

Alternative method to get files using parameters instead of a query string, with headers shown.

```bash
fab api -A storage ws1/lh1.Lakehouse/Files -P resource=filesystem,recursive=false --show_headers

```

--------------------------------

### Enter REPL mode by running fab without arguments

Source: https://microsoft.github.io/fabric-cli/essentials/modes

Run `fab` with no arguments to enter REPL mode, which provides a shell-like interactive environment.

```bash
fab

```

--------------------------------

### Create a domain with fab create .domains/marketing.Domain

Source: https://microsoft.github.io/fabric-cli/examples/domain_examples

Creates a new domain named 'marketing'.

```bash
fab create .domains/marketing.Domain

```

--------------------------------

### Explore Gateway Commands with fab desc

Source: https://microsoft.github.io/fabric-cli/examples/gateway_examples

Run this command to see all gateway commands and their parameters.

```bash
fab desc .Gateway

```

--------------------------------

### fab job run-status

Source: https://microsoft.github.io/fabric-cli/examples/job_examples

Gets detailed status information for a specific job run. Use the --schedule flag to get status for a scheduled job.

```APIDOC
## fab job run-status

### Description
Gets detailed status information for a specific job run. Use the --schedule flag to get status for a scheduled job.

### Method
CLI Command

### Endpoint
fab job run-status <item> --id <schedule_id>

### Parameters
#### Path Parameters
- **item** (string) - Required - The item path in the format `workspace/item` (e.g., `ws1.Workspace/nb1.Notebook`).

#### Query Parameters
- **--id** (string) - Required - The schedule ID or job run ID.
- **--schedule** (flag) - Optional - When present, gets status for a scheduled job.

### Request Example
```
fab job run-status ws1.Workspace/nb1.Notebook --id <schedule_id>
```

### Response
#### Success Response
Displays detailed status information for the job run.

#### Response Example
```
<status details>
```
```

--------------------------------

### List domains in simple format with fab ls .domains

Source: https://microsoft.github.io/fabric-cli/examples/domain_examples

Displays existing domains in a simple format.

```bash
fab ls .domains

```

--------------------------------

### Get ACL - Usage

Source: https://microsoft.github.io/fabric-cli/commands/acls

Shows the basic syntax for the `fab acl get` command. Use `-q` for JMESPath filtering and `-o` to specify an output path.

```bash
fab acl get <path> [-q <query>] [-o <output_path>]

```

--------------------------------

### Tenant-level resources description commands

Source: https://microsoft.github.io/fabric-cli/examples/desc_examples

Commands to describe tenant-level resources: Capacity, Gateway, Connection, and Domain.

```bash
# Capacity management
fab desc .Capacity

# Data gateway management  
fab desc .Gateway

# Connection management
fab desc .Connection

# Domain management
fab desc .Domain

```

--------------------------------

### Query specific properties using JMESPath

Source: https://microsoft.github.io/fabric-cli/examples/onelake_examples

Extracts specific properties using JMESPath queries. The first command gets the first path item, the second gets the complete object.

```bash
# Get first path item
fab get ws1.Workspace/lh1.Lakehouse/Files/datasets -q paths[0]

# Get complete object
fab get ws1.Workspace/lh1.Lakehouse/Files/datasets -q .

```

--------------------------------

### fab acl get

Source: https://microsoft.github.io/fabric-cli/commands/acls

Get detailed ACL information with optional filtering for workspace, item, gateway, connection or OneLake resource. Retrieving ACLs for an item requires tenant-level Fabric Administrator.

```APIDOC
## fab acl get

### Description
Get detailed ACL information with optional filtering for workspace, item, gateway, connection or OneLake resource. Retrieving ACLs for an item requires tenant-level Fabric Administrator.

### Usage
```
fab acl get <path> [-q <query>] [-o <output_path>]
```

### Parameters
- `<path>` (string) - Required - Path to the resource.
- `-q, --query` (string) - Optional - JMESPath query to filter results.
- `-o, --output` (string) - Optional - Output path for results.

### Examples
```
# Get workspace acl
fab acl get ws1.Workspace

# Get item acl
fab acl get ws1.Workspace/lh1.Lakehouse
```
```

--------------------------------

### List OneLake content for supported items

Source: https://microsoft.github.io/fabric-cli/examples/onelake_examples

Displays content for an item. The examples show listing the Files section in a Lakehouse, the dbo Tables section in a Warehouse, and Tables in a SemanticModel.

```bash
# List Files section in Lakehouse
fab ls ws1.Workspace/lh1.Lakehouse/Files

# List dbo Tables section in Warehouse
fab ls ws1.Workspace/wh1.Warehouse/Tables/dbo

# List Tables in SemanticModel
fab ls ws1.Workspace/sem1.SemanticModel/Tables

```

--------------------------------

### List configuration settings

Source: https://microsoft.github.io/fabric-cli/examples/config_examples

Retrieves a list of all configuration keys and their values.

```bash
fab config ls
```

--------------------------------

### List all configurations with fab config ls

Source: https://microsoft.github.io/fabric-cli/commands/config

Lists all configuration settings and their current values. Usage: `fab config ls`.

```bash
fab config ls

```

--------------------------------

### Get workspace details

Source: https://microsoft.github.io/fabric-cli/examples/workspace_examples

Retrieve full workspace details.

```bash
fab get ws1.Workspace

```

--------------------------------

### Get Gateway Details

Source: https://microsoft.github.io/fabric-cli/examples/gateway_examples

Retrieve full gateway details.

```bash
fab get .gateways/prod-gateway.Gateway

```

--------------------------------

### Create folder with fab create

Source: https://microsoft.github.io/fabric-cli/examples/folder_examples

Creates a new folder within a workspace.

```bash
fab create ws1.Workspace/fd1.Folder
```

--------------------------------

### Get Connection Details

Source: https://microsoft.github.io/fabric-cli/examples/connection_examples

Retrieve full connection details.

```bash
fab get .connections/conn1.Connection
```

--------------------------------

### job run-status

Source: https://microsoft.github.io/fabric-cli/commands/jobs

Get detailed status of a job run.

```APIDOC
## job run-status

### Description
Get detailed status of a job run.

### Usage
```
fab job run-status <path> --id <job_id> [--schedule]
```

### Parameters
- `<path>` (string) - Required - Path to the resource.
- `--id` (string) - Required - Job or schedule ID.
- `--schedule` (boolean) - Optional - Check scheduled job status.
```

--------------------------------

### Create Basic SQL Connection

Source: https://microsoft.github.io/fabric-cli/examples/connection_examples

Create a connection to SQL database with required parameters only.

```bash
fab create .connections/conn.Connection -P connectionDetails.type=SQL,connectionDetails.parameters.server=<server>,connectionDetails.parameters.database=sales,credentialDetails.type=Basic,credentialDetails.username=<username>,credentialDetails.password=<password>
```

--------------------------------

### Create workspace with default capacity

Source: https://microsoft.github.io/fabric-cli/examples/workspace_examples

Create a workspace using the CLI-configured default capacity.

```bash
fab create ws1.Workspace

```

--------------------------------

### Get a Workspace details

Source: https://microsoft.github.io/fabric-cli/examples/api_examples

Retrieve Power BI workspace details.

```APIDOC
## [GET] /groups/{groupId}

### Description
Retrieve Power BI workspace details.

### Method
GET

### Endpoint
/groups/{groupId}

### Parameters
#### Path Parameters
- **groupId** (string) - Required - The Power BI group (workspace) ID.

### Request Example
```
fab api -A powerbi groups/00000000-0000-0000-0000-000000000000
```

### Response
No response schema provided.
```

--------------------------------

### Get Gateway Permission Details

Source: https://microsoft.github.io/fabric-cli/examples/gateway_examples

Retrieve gateway permission details.

```bash
fab acl get .gateways/prod-gateway.Gateway

```

--------------------------------

### Usage: fab open <path>

Source: https://microsoft.github.io/fabric-cli/commands/fs/open

Shows the command syntax for opening a workspace or item in the browser. The path parameter is required.

```bash
fab open <path>

```

--------------------------------

### List all workspaces and folders

Source: https://microsoft.github.io/fabric-cli/examples/workspace_examples

Display available workspaces with different detail levels: simple, detailed, and including hidden elements.

```bash
# Simple list
fab ls

# Detailed list
fab ls -l

# Include hidden elements
fab ls -l -a

```

--------------------------------

### Get Connection Permissions

Source: https://microsoft.github.io/fabric-cli/examples/connection_examples

Retrieve full connection permission details.

```bash
fab acl get .connections/conn.Connection
```

--------------------------------

### Get Spark Pool Details

Source: https://microsoft.github.io/fabric-cli/examples/sparkpool_examples

Retrieve full Spark pool details.

```bash
fab get ws1.Workspace/.sparkpools/analytics-pool.SparkPool

```

--------------------------------

### Get Complete Shortcut Object

Source: https://microsoft.github.io/fabric-cli/examples/shortcut_examples

Retrieves all shortcut properties for detailed analysis.

```bash
fab get ws1.Workspace/lh1.Lakehouse/Tables/external_table.Shortcut -q .
```

--------------------------------

### Usage: fab mkdir <path>/<name>.<type> [-P <params>]

Source: https://microsoft.github.io/fabric-cli/commands/fs/mkdir

Shows the general syntax for the `fab mkdir` command. The path is optional; if omitted, the current context is used. Parameters are passed as comma-separated key=value pairs.

```bash
fab mkdir <path>/<name>.<type> [-P <params>]

```

--------------------------------

### Upgrade ms-fabric-cli

Source: https://microsoft.github.io/fabric-cli

Upgrade an existing installation of the Fabric CLI to the latest version.

```bash
pip install --upgrade ms-fabric-cli
```

--------------------------------

### Navigate to Connections Collection

Source: https://microsoft.github.io/fabric-cli/examples/connection_examples

Use `fab cd /.connections` to navigate to the connections collection using absolute path.

```bash
fab cd /.connections
```

--------------------------------

### Get Available Fabric SKUs

Source: https://microsoft.github.io/fabric-cli/examples/api_examples

List all available Fabric capacity SKUs for a subscription.

```APIDOC
## [GET] /subscriptions/{subscriptionId}/providers/Microsoft.Fabric/skus

### Description
List all available Fabric capacity SKUs for a subscription.

### Method
GET

### Endpoint
/subscriptions/{subscriptionId}/providers/Microsoft.Fabric/skus

### Parameters
#### Path Parameters
- **subscriptionId** (string) - Required - The Azure subscription ID.

#### Query Parameters
- **api-version** (string) - Required - The API version, e.g., 2023-11-01.

### Request Example
```
fab api -A azure subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Fabric/skus?api-version=2023-11-01
```

### Response
No response schema provided.
```
Tokens:
Raw