Skip to content

Commit a581a23

Browse files
NowinskiKNowinskiK
authored
Merge branch 'develop' into feature/136-write-message
2 parents eca1e10 + 790c4c2 commit a581a23

File tree

236 files changed

+29369
-22
lines changed

Some content is hidden

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

236 files changed

+29369
-22
lines changed

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
*.local.*
33
!**/README.md
44
.kitchen/
5+
*.code-workspace
56

67
~*.*
78
*.nupkg

‎CHANGELOG.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,30 +6,45 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
66
## [Unreleased]
77

88
### Added
9-
- added unit tests for `Get-FabricWorkspaceUser` function to ensure it works correctly with multiple workspaces both in the pipeline and passed to a parameter.
9+
10+
- Added unit tests for `Get-FabricWorkspaceUser` function to ensure it works correctly with multiple workspaces both in the pipeline and passed to a parameter.
1011
- Added unit tests for Aliases for `Get-FabricWorkspaceUser` function to ensure backward compatibility.
11-
- Added credits for authors to all functions and Unit tests to verify the existence of such tags #89
12+
- Added credits for authors to all functions and Unit tests to verify the existence of such tags (#89)
1213
- Added `NoWait` switch parameter to `New-FabricSQLDatabase` (#123)
14+
- Added functions related to Deployment Pipelines (#121):
15+
- `Add-FabricWorkspaceToStage`,
16+
- `Get-FabricDeploymentPipeline`,
17+
- `Get-FabricDeploymentPipelineOperation`,
18+
- `Get-FabricDeploymentPipelineRoleAssignments`,
19+
- `Get-FabricDeploymentPipelineStage`,
20+
- `Get-FabricDeploymentPipelineStageItem`,
21+
- `New-FabricDeploymentPipeline`,
22+
- `Remove-FabricDeploymentPipeline`,
23+
- `Remove-FabricWorkspaceFromStage`,
24+
- `Start-FabricDeploymentPipelineStage`
25+
- Added private function `Get-FabricContinuationToken` to facilitate pagination
1326

1427
### Changed
28+
1529
- `Write-Message` uses `Write-Warning` & `Write-Error` accordingly rather than `Write-Host` with colour (#136)
1630
- Updated `Get-FabricWorkspaceUser` to support pipeline input for `WorkspaceId` and `WorkspaceName` parameters.
1731
- Renamed `Get-FabricWorkspaceUsers` to match the singular form
18-
- Get-FabricSqlDatabase accepts Workspace as a pipeline, handles errors correctly and can filter by name (#117).
32+
- `Get-FabricSqlDatabase` accepts Workspace as a pipeline, handles errors correctly and can filter by name (#117).
1933
- Applied splatting for several parameters in `Invoke-FabricRestMethod` and output results in debug mode
2034
- `Remove-FabricSQLDatabase` uses unified function to handle API results
2135

2236
Updated the `WorkspaceId`, `CapacitiesIds`,`CapacityId`,`CopyJobId`,`datamartId`,`DataPipelineId`,`DataWarehouseGUID`,`DomainId`,`EnvironmentId`,`EventhouseId`,`EventstreamId`,`ExternalDataShareId`,`ItemId`,`KQLDashboardId`,`KQLDatabaseId`,`KQLQuerysetId`,`LakehouseId`,`MirroredDatabaseId`,`MirroredWarehouseId`,`MLExperimentId`,`MLModelId`,`NotebookId`,`operationId`,`PaginatedReportId`,`ParentDomainId`,`parentEventhouseId`,`PrincipalId`,`ReflexId`,`ReportId`,`SemanticModelId`,`SparkCustomPoolId`,`SparkJobDefinitionId`,`SQLDatabaseId`,`SQLEndpointId`,`subscriptionID`,`UserId`,`WarehouseId`,`WorkspaceGUID`,`WorkspaceId`,`WorkspaceIds`,and `WorkspaceRoleAssignmentId` parameters to the datatype GUID [#125](https://github.com/dataplat/FabricTools/issues/125)
2337

24-
25-
2638
### Fixed
39+
2740
- Enhanced logic in unified function `Test-FabricApiResponse` to handle API results and moved it to private functions
2841
- Fixed bug in `Get-FabricLongRunningOperation` - Uri was incorectly created (#131)
2942
- Fixed bug in `Get-FabricLongRunningOperationResult` - uses correct statusCode (#131)
3043

3144
### Deprecated
45+
3246
### Removed
47+
3348
- Removed Revision History from `Get-FabricSQLDatabase`, `Get-FabricSQLDatabase`
3449

3550
### Security

‎FabricTools.code-workspace

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

‎documentation/Add-FabricDomainWorkspaceAssignmentByCapacity.md

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
---
2+
external help file: FabricTools-help.xml
3+
Module Name: FabricTools
4+
online version:
5+
schema: 2.0.0
6+
---
7+
8+
# Add-FabricDomainWorkspaceAssignmentByCapacity
9+
10+
## SYNOPSIS
11+
Assigns workspaces to a Fabric domain based on specified capacities.
12+
13+
## SYNTAX
14+
15+
```
16+
Add-FabricDomainWorkspaceAssignmentByCapacity [-DomainId] <Guid> [-CapacitiesIds] <Guid[]>
17+
[-ProgressAction <ActionPreference>] [<CommonParameters>]
18+
```
19+
20+
## DESCRIPTION
21+
The \`Add-FabricDomainWorkspaceAssignmentByCapacity\` function assigns workspaces to a Fabric domain using a list of capacity IDs by making a POST request to the relevant API endpoint.
22+
23+
## EXAMPLES
24+
25+
### EXAMPLE 1
26+
```
27+
Add-FabricDomainWorkspaceAssignmentByCapacity -DomainId "12345" -CapacitiesIds @("capacity1", "capacity2")
28+
```
29+
30+
Assigns workspaces to the domain with ID "12345" based on the specified capacities.
31+
32+
## PARAMETERS
33+
34+
### -CapacitiesIds
35+
An array of capacity IDs used to assign workspaces to the domain.
36+
37+
```yaml
38+
Type: System.Guid[]
39+
Parameter Sets: (All)
40+
Aliases:
41+
42+
Required: True
43+
Position: 2
44+
Default value: None
45+
Accept pipeline input: False
46+
Accept wildcard characters: False
47+
```
48+
49+
### -DomainId
50+
The unique identifier of the Fabric domain to which the workspaces will be assigned.
51+
52+
```yaml
53+
Type: System.Guid
54+
Parameter Sets: (All)
55+
Aliases:
56+
57+
Required: True
58+
Position: 1
59+
Default value: None
60+
Accept pipeline input: False
61+
Accept wildcard characters: False
62+
```
63+
64+
### -ProgressAction
65+
{{ Fill ProgressAction Description }}
66+
67+
```yaml
68+
Type: System.Management.Automation.ActionPreference
69+
Parameter Sets: (All)
70+
Aliases: proga
71+
72+
Required: False
73+
Position: Named
74+
Default value: None
75+
Accept pipeline input: False
76+
Accept wildcard characters: False
77+
```
78+
79+
### CommonParameters
80+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
81+
82+
## INPUTS
83+
84+
## OUTPUTS
85+
86+
## NOTES
87+
- Requires \`$FabricConfig\` global configuration, including \`BaseUrl\` and \`FabricHeaders\`.
88+
- Calls \`Confirm-TokenState\` to ensure token validity before making the API request.
89+
90+
Author: Tiago Balabuch
91+
92+
## RELATED LINKS

‎documentation/Add-FabricDomainWorkspaceAssignmentById.md

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
---
2+
external help file: FabricTools-help.xml
3+
Module Name: FabricTools
4+
online version:
5+
schema: 2.0.0
6+
---
7+
8+
# Add-FabricDomainWorkspaceAssignmentById
9+
10+
## SYNOPSIS
11+
Assigns workspaces to a specified domain in Microsoft Fabric by their IDs.
12+
13+
## SYNTAX
14+
15+
```
16+
Add-FabricDomainWorkspaceAssignmentById [-DomainId] <Guid> [-WorkspaceIds] <Guid[]>
17+
[-ProgressAction <ActionPreference>] [<CommonParameters>]
18+
```
19+
20+
## DESCRIPTION
21+
The \`Add-FabricDomainWorkspaceAssignmentById\` function sends a request to assign multiple workspaces to a specified domain using the provided domain ID and an array of workspace IDs.
22+
23+
## EXAMPLES
24+
25+
### EXAMPLE 1
26+
```
27+
Add-FabricDomainWorkspaceAssignmentById -DomainId "12345" -WorkspaceIds @("ws1", "ws2", "ws3")
28+
```
29+
30+
Assigns the workspaces with IDs "ws1", "ws2", and "ws3" to the domain with ID "12345".
31+
32+
## PARAMETERS
33+
34+
### -DomainId
35+
The ID of the domain to which workspaces will be assigned.
36+
This parameter is mandatory.
37+
38+
```yaml
39+
Type: System.Guid
40+
Parameter Sets: (All)
41+
Aliases:
42+
43+
Required: True
44+
Position: 1
45+
Default value: None
46+
Accept pipeline input: False
47+
Accept wildcard characters: False
48+
```
49+
50+
### -ProgressAction
51+
{{ Fill ProgressAction Description }}
52+
53+
```yaml
54+
Type: System.Management.Automation.ActionPreference
55+
Parameter Sets: (All)
56+
Aliases: proga
57+
58+
Required: False
59+
Position: Named
60+
Default value: None
61+
Accept pipeline input: False
62+
Accept wildcard characters: False
63+
```
64+
65+
### -WorkspaceIds
66+
An array of workspace IDs to be assigned to the domain.
67+
This parameter is mandatory.
68+
69+
```yaml
70+
Type: System.Guid[]
71+
Parameter Sets: (All)
72+
Aliases:
73+
74+
Required: True
75+
Position: 2
76+
Default value: None
77+
Accept pipeline input: False
78+
Accept wildcard characters: False
79+
```
80+
81+
### CommonParameters
82+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
83+
84+
## INPUTS
85+
86+
## OUTPUTS
87+
88+
## NOTES
89+
- Requires \`$FabricConfig\` global configuration, including \`BaseUrl\` and \`FabricHeaders\`.
90+
- Calls \`Confirm-TokenState\` to ensure token validity before making the API request.
91+
92+
Author: Tiago Balabuch
93+
94+
## RELATED LINKS

‎documentation/Add-FabricDomainWorkspaceAssignmentByPrincipal.md

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
---
2+
external help file: FabricTools-help.xml
3+
Module Name: FabricTools
4+
online version:
5+
schema: 2.0.0
6+
---
7+
8+
# Add-FabricDomainWorkspaceAssignmentByPrincipal
9+
10+
## SYNOPSIS
11+
Assigns workspaces to a domain based on principal IDs in Microsoft Fabric.
12+
13+
## SYNTAX
14+
15+
```
16+
Add-FabricDomainWorkspaceAssignmentByPrincipal [-DomainId] <Guid> [-PrincipalIds] <Object>
17+
[-ProgressAction <ActionPreference>] [<CommonParameters>]
18+
```
19+
20+
## DESCRIPTION
21+
The \`Add-FabricDomainWorkspaceAssignmentByPrincipal\` function sends a request to assign workspaces to a specified domain using a JSON object of principal IDs and types.
22+
23+
## EXAMPLES
24+
25+
### EXAMPLE 1
26+
```
27+
$PrincipalIds = @(
28+
@{id = "813abb4a-414c-4ac0-9c2c-bd17036fd58c"; type = "User"},
29+
@{id = "b5b9495c-685a-447a-b4d3-2d8e963e6288"; type = "User"}
30+
)
31+
```
32+
33+
Add-FabricDomainWorkspaceAssignmentByPrincipal -DomainId "12345" -PrincipalIds $principals
34+
35+
Assigns the workspaces based on the provided principal IDs and types.
36+
37+
## PARAMETERS
38+
39+
### -DomainId
40+
The ID of the domain to which workspaces will be assigned.
41+
This parameter is mandatory.
42+
43+
```yaml
44+
Type: System.Guid
45+
Parameter Sets: (All)
46+
Aliases:
47+
48+
Required: True
49+
Position: 1
50+
Default value: None
51+
Accept pipeline input: False
52+
Accept wildcard characters: False
53+
```
54+
55+
### -PrincipalIds
56+
An array representing the principals with their \`id\` and \`type\` properties.
57+
Must contain a \`principals\` key with an array of objects.
58+
59+
```yaml
60+
Type: System.Object
61+
Parameter Sets: (All)
62+
Aliases:
63+
64+
Required: True
65+
Position: 2
66+
Default value: None
67+
Accept pipeline input: False
68+
Accept wildcard characters: False
69+
```
70+
71+
### -ProgressAction
72+
{{ Fill ProgressAction Description }}
73+
74+
```yaml
75+
Type: System.Management.Automation.ActionPreference
76+
Parameter Sets: (All)
77+
Aliases: proga
78+
79+
Required: False
80+
Position: Named
81+
Default value: None
82+
Accept pipeline input: False
83+
Accept wildcard characters: False
84+
```
85+
86+
### CommonParameters
87+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
88+
89+
## INPUTS
90+
91+
## OUTPUTS
92+
93+
## NOTES
94+
- Requires \`$FabricConfig\` global configuration, including \`BaseUrl\` and \`FabricHeaders\`.
95+
- Calls \`Confirm-TokenState\` to ensure token validity before making the API request.
96+
97+
Author: Tiago Balabuch
98+
99+
## RELATED LINKS

0 commit comments

Comments
 (0)