Skip to content

Commit 1169725

Browse files
author
aviat cohen
committed
merge
2 parents 005d911 + 0a03d3b commit 1169725

124 files changed

Lines changed: 21414 additions & 9437 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.changes/unreleased/added-20251111-144602.yaml

Lines changed: 0 additions & 3 deletions
This file was deleted.

.changes/unreleased/fixed-20251111-053940.yaml

Lines changed: 0 additions & 3 deletions
This file was deleted.

.changes/unreleased/fixed-20251111-134254.yaml

Lines changed: 0 additions & 3 deletions
This file was deleted.

.changes/unreleased/fixed-20251112-081104.yaml

Lines changed: 0 additions & 3 deletions
This file was deleted.

.changes/v1.3.1.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
## [v1.3.1](https://pypi.org/project/ms-fabric-cli/v1.3.1) - December 15, 2025
2+
3+
### ✨ New Functionality
4+
5+
* Add support of mv, cp, export and import for SQLDatabase item type
6+
* Add new 'job run-rm' command for remove a scheduled job
7+
* Enhance `set` command for items to support any settable property path within the item's definition and metadata structure
8+
* Add support in `ls` commmand using `-q` flag for filtering based on JMESPath expressions
9+
10+
### 🔧 Bug Fix
11+
12+
* Fix `--output_format` argument for command `fab auth status`
13+
* Fix context persistence in virtual environment
14+
* Fix create connection with onPremGateway and encryptedCredentials
15+
16+
### ⚡ Additional Optimizations
17+
18+
* Add support for print in key-value list style
19+
* Optimize LRO polling by calling GetOperationResult API only when a Location header is present
20+
* Enforce CLI parameter values must be wrapped in single (') or double (") quotes in interactive mode
21+
22+
### 📝 Documentation Update
23+
24+
* Documentation updates
25+

MANIFEST.in

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
include src/fabric_cli/core/fab_config/command_support.yaml
2+
recursive-include src/fabric_cli/commands/fs/payloads *

docs/commands/acls/index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,20 +28,22 @@ List access control entries for a workspace, item, or OneLake resource.
2828
**Usage:**
2929

3030
```
31-
fab acl ls <path> [-l]
31+
fab acl ls <path> [-l] [-q <query>]
3232
```
3333

3434
**Parameters:**
3535

3636
- `<path>`: Path to the resource.
3737
- `-l, --long`: Show detailed output. Optional.
38+
- `-q, --query`: JMESPath query to filter results. Optional.
3839

3940
**Examples:**
4041

4142
```
4243
fab acl ls workspace1.workspace
4344
fab acl ls lh1.lakehouse -l
4445
fab acl ls /Files/data -l
46+
fab acl ls workspace1.workspace -q [].[?role=='Admin']
4547
```
4648

4749
---

docs/commands/fs/ls.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,24 @@ List workspaces, items, and files.
77
**Usage:**
88

99
```
10-
fab ls <path> [-l] [-a]
10+
fab ls <path> [-l] [-a] [-q <query>]
1111
```
1212

1313
**Parameters:**
1414

1515
- `<path>`: Path to list. Optional.
1616
- `-l, --long`: Show detailed output. Optional.
1717
- `-a, --all`: Show hidden entities. Optional.
18+
- `-q, --query`: JMESPath query to filter results. Optional.
1819

19-
**Example:**
20+
**Examples:**
2021

2122
```
2223
fab ls ws1.Workspace
24+
fab ls -l
25+
26+
# Using JEMSPath to filter items within ws1 workspace
27+
fab ls -l -q [].{name:name}
28+
fab ls ws1.Workspace -q [?contains(name, 'report')]
29+
fab ls -l -q [?id=='123456']
2330
```

docs/commands/fs/set.md

Lines changed: 64 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,18 @@
11
# `set` Command
22

3-
Set a workspace or item property.
3+
Set a resource property.
4+
5+
**Supported Resource Types:**
6+
7+
- Workspace
8+
- Item
9+
- Capacity
10+
- Domain
11+
- Connection
12+
- Gateway
13+
- Spark Pool
14+
- Folder
15+
- Shortcut
416

517
!!! info "Setting domain properties requires tenant-level Fabric Administrator privileges"
618

@@ -9,18 +21,64 @@ Set a workspace or item property.
921
**Usage:**
1022

1123
```
12-
fab set <path> -q <jmespath_query> -i <input_to_replace> [-f]
24+
fab set <path> -q <jmespath_query> -i <input_value> [-f]
1325
```
1426

1527
**Parameters:**
1628

1729
- `<path>`: Path to the resource.
18-
- `-q, --query <jmespath_query>`: JMESPath query.
19-
- `-i, --input <input_to_replace>`: Input value to replace.
30+
- `-q, --query <jmespath_query>`: JMESPath query to the property.
31+
- `-i, --input <input_value>`: Input value to set.
32+
33+
!!! tip "Working with JSON input"
34+
For guidance on providing JSON input values across different shells, see [JSON Input Handling](../../essentials/input.md#json-input-handling).
35+
2036
- `-f, --force`: Force set without confirmation. Optional.
2137

2238
**Example:**
2339

40+
```bash
41+
fab set ws1.Workspace -q displayName -i "New Name" -f
2442
```
25-
fab set ws1.Workspace/nb1.Notebook -q .property -i value
26-
```
43+
44+
## Limitations
45+
46+
- Only one property path can be specified per `--query` argument
47+
- Paths must map directly to JSON paths **without** filters or wildcards
48+
- If the property path doesn't exist on the item definition, it will be added, provided it's valid according to the item's schema. The `set` command supports creation of 1 level at a time (e.g., to set `a.b.c`, first set `a.b`, then set `a.b.c`)
49+
- Properties that expect a JSON string value are not supported - JSON input is always parsed as an object
50+
51+
## Query Support
52+
53+
The following table shows supported queries per resource type:
54+
55+
| Resource | Supported Queries |
56+
|----------------|-------------------|
57+
| **Item** | `displayName`, `description`, `properties` (`.VariableLibrary` only), [`definition.<path>`](#definition-paths) |
58+
| **Workspace** | `displayName`, `description`, `sparkSettings` |
59+
| **Capacity** | `sku.name` |
60+
| **Domain** | `displayName`, `description`, `contributorsScope` |
61+
| **Connection** | `displayName`, `privacyLevel`, `credentialDetails` |
62+
| **Gateway** | `displayName`, `allowCloudConnectionRefresh`, `allowCustomConnectors`, `capacityId`, `inactivityMinutesBeforeSleep`, `numberOfMemberGateways` |
63+
| **Spark Pool** | `name`, `nodeSize`, `autoScale.enabled`, `autoScale.minNodeCount`, `autoScale.maxNodeCount` |
64+
| **Folder** | `displayName` |
65+
| **Shortcut** | `name`, `target` |
66+
67+
<a id="definition-paths"></a>
68+
!!! note "Setting Item Definition Properties"
69+
For **Items**, you can set any explicit path within the `definition` structure using dot notation for nested properties (e.g. `definition.parts[0].property`).
70+
Paths must map directly to JSON paths **without** filters or wildcards. Refer to the [Microsoft Fabric item definitions](https://learn.microsoft.com/en-us/rest/api/fabric/articles/item-management/definitions) for the complete definition structure.
71+
72+
#### Item-Specific Definition Path Aliasing
73+
74+
!!! warning "Note on definition path aliases"
75+
76+
These definition path aliases may be deprecated in a future release. We strongly recommend using explicit JSON paths within the item's definition structure rather than aliases.
77+
78+
These are definition path aliases that map to specific paths in the item's definition structure. When using the `set` command, you can use these aliases directly (as the `-query` / `--q` argument value) as they map to the correct definition paths:
79+
80+
| Item Type | Definition Path Alias | Notes |
81+
|-----------|----------------|-------|
82+
| **Notebook** | `lakehouse`, `environment`, `warehouse` | |
83+
| **Report** | `semanticModelId` | Applies only to [Report definition.pbir version 1](https://learn.microsoft.com/en-us/power-bi/developer/projects/projects-report?tabs=v1%2Cdesktop#definitionpbir). For other versions, check the correct property path in the Report definition documentation |
84+
| **SparkJobDefinition** | `payload` | |

docs/commands/jobs/index.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ The `job` commands provide tools for starting, running, monitoring, and scheduli
2020
| `job run-status`| Get job run details | `job run-status <path> [--id <id>] [--schedule]` |
2121
| `job run-sch` | Schedule a job | `job run-sch <path> [-i <json_inline_or_path>*] [--type <type>] [--interval <interval>] [--days <days>]` |
2222
| `job run-update`| Update a scheduled job | `job run-update <path> [--id <id>] [-i <json_inline_or_path>] [--type <type>] [--enable/--disable]` |
23+
| `job run-rm` | Delete a scheduled job | `job run-rm <path> [--id <scheduled-id>] [--force]` |
2324

2425
---
2526

@@ -161,4 +162,22 @@ fab job run-cancel <path> --id <job_id> [--wait]
161162

162163
---
163164

165+
### run-rm
166+
167+
Remove a scheduled job.
168+
169+
**Usage:**
170+
171+
```
172+
fab job run-rm <path> --id <scheduled-id> [-f]
173+
```
174+
175+
**Parameters:**
176+
177+
- `<path>`: Path to the resource.
178+
- `--id`: Schedule ID to remove.
179+
- `-f, --force`: Bypass confirmation prompt. Optional.
180+
181+
---
182+
164183
For more examples and detailed scenarios, see [Job Management Examples](../../examples/job_examples.md).

0 commit comments

Comments
 (0)