Merge branch 'develop' into bug-131-and-nowait

Signed-off-by: Kamil Nowinski <[email protected]>

Author: NowinskiK

.github/PULL_REQUEST_TEMPLATE.md

@@ -5,13 +5,15 @@
     Your contribution to this project is greatly appreciated!
 
     TITLE: Please be descriptive not sensationalist.
-    Prepend the title with the [DscResourceName] if your PR is specific to a DSC resource.
     Also prepend with [BREAKING CHANGE] if relevant.
     i.e. [BREAKING CHANGE][xFile] Add security descriptor property
 
     You may remove this comment block, and the other comment blocks, but please
     keep the headers and the task list.
     Try to keep your PRs atomic: changes grouped in smallest batch affecting a single logical unit.
+    
+    PLEASE DO NOT submit PRs that contain multiple unrelated changes.
+    If you have multiple changes, please submit them in separate PRs.
 -->
 
 ## Pull Request (PR) description
@@ -59,4 +61,4 @@
 - [ ] Unit tests added/updated..
 - [ ] Integration tests added/updated (where possible).
 - [ ] Documentation added/updated (where applicable).
-- [ ] Code follows the [contribution guidelines](../CONTRIBUTING.md).
+- [ ] Code follows the [contribution guidelines](https://github.com/dataplat/FabricTools/blob/develop/CONTRIBUTING.md).

CHANGELOG.md

@@ -6,14 +6,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 ### Added
+- added unit tests for `Get-FabricWorkspaceUser` function to ensure it works correctly with multiple workspaces both in the pipeline and passed to a parameter.
+- Added unit tests for Aliases for `Get-FabricWorkspaceUser` function to ensure backward compatibility.
 - Added credits for authors to all functions and Unit tests to verify the existence of such tags #89
 - Added `NoWait` switch parameter to `New-FabricSQLDatabase` (#123)
 
 ### Changed
+- Updated `Get-FabricWorkspaceUser` to support pipeline input for `WorkspaceId` and `WorkspaceName` parameters.
+- Renamed `Get-FabricWorkspaceUsers` to match the singular form
 - Get-FabricSqlDatabase accepts Workspace as a pipeline, handles errors correctly and can filter by name (#117).
 - Applied splatting for several parameters in `Invoke-FabricRestMethod` and output results in debug mode
 - `Remove-FabricSQLDatabase` uses unified function to handle API results
 
+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)
+
+
+
 ### Fixed
 - Enhanced logic in unified function `Test-FabricApiResponse` to handle API results and moved it to private functions
 - Fixed bug in `Get-FabricLongRunningOperation` - Uri was incorectly created (#131)

CONTRIBUTING.md

@@ -6,8 +6,10 @@ Before we go any further, thanks for being here. Thanks for using the module and
 
 ## Important resources
 
-- docs TODO: link to docs
-- bugs TODO: link to issues issue template
+- Documentation such as coding guidelines can be found in the [wiki](https://github.com/dataplat/FabricTools/wiki)
+- Bugs can be reported as [issues](https://github.com/dataplat/FabricTools/issues) via the bug issue template.
+- Feature requests can be submitted in the issues via the feature request issue template.
+- Discussions can be started in the [Discussions](https://github.com/dataplat/FabricTools/discussions) section of the repository.
 - communicate via issues, PRs, and discussions as well as the project
 
 ## Develop & Build
@@ -113,23 +115,19 @@ If you have any questions or need help, please feel free to reach out to us on t
 
 ## How to submit changes
 
-TODO:
-Pull Request protocol etc. You might also include what response they'll get back from the team on submission, or any caveats about the speed of response.
+We use a Pull Request (PR) workflow to manage changes to the module. This means that you will need to create a new branch in your fork of the repository, make your changes, and then create a PR against the main repository. You can find full details in the [wiki](https://github.com/dataplat/FabricTools/wiki)
 
 ## How to report a bug
 
-TODO:
-Bugs are problems in code, in the functionality of an application or in its UI design; you can submit them through "bug trackers" and most projects invite you to do so, so that they may "debug" with more efficiency and the input of a contributor. Take a look at Atom's example for how to teach people to report bugs to your project.
+If you find a bug in the module, please report it using the [issue template](https://github.com/dataplat/FabricTools/issues). This will help us track the issue and ensure that it is fixed in a timely manner.
 
 ## Templates
 
-TODO:
-in this section of your file, you might also want to link to a bug report "template" like this one here which contributors can copy and add context to; this will keep your bugs tidy and relevant.
+There are a number of templates available in the `.github` folder of the repository. These include issue templates for bugs, feature requests, and discussions. You can use these templates to help you create a new issue or discussion.
 
 ## Style Guide
 
-TODO:
-include extensions and vscode settings we use to keep things neat
+The Style Guide is a set of rules and guidelines that we follow to ensure that our code is consistent, readable, and maintainable. It is located in the [wiki](https://github.com/dataplat/FabricTools/wiki).
 
 ## Code of Conduct
 

FabricTools.code-workspace

@@ -0,0 +1,7 @@
+{
+    "folders": [
+        {
+            "path": "."
+        }
+    ]
+}

source/Private/Get-FabricUri.ps1

@@ -34,11 +34,11 @@ function Get-FabricUri {
     param (
         $BaseUrl = 'api.powerbi.com',
         [parameter(Mandatory)]
-        [String]$WorkspaceGUID,
+        [guid]$WorkspaceGUID,
         [parameter(Mandatory)]
-        [String]$DataWarehouseGUID,
+        [guid]$DataWarehouseGUID,
 
-        [String]$BatchId
+        [guid]$BatchId
     )
 
     try {

source/Public/Capacity/Get-FabricCapacities.ps1

@@ -30,7 +30,7 @@ function Get-FabricCapacities {
     Param (
         # Optional parameter for subscription ID
         [Parameter(Mandatory = $false)]
-        [string]$subscriptionID
+        [guid]$subscriptionID
     )
 
     # Initialize an array to store the results

source/Public/Capacity/Get-FabricCapacity.ps1

@@ -32,7 +32,7 @@ function Get-FabricCapacity {
     param (
         [Parameter(Mandatory = $false)]
         [ValidateNotNullOrEmpty()]
-        [string]$capacityId,
+        [guid]$capacityId,
 
         [Parameter(Mandatory = $false)]
         [ValidateNotNullOrEmpty()]

source/Public/Capacity/Get-FabricCapacitySkus.ps1

@@ -28,7 +28,7 @@ Author: Kamil Nowinski
 
     Param(
         [Parameter(Mandatory = $true)]
-        [string]$subscriptionID,
+        [guid]$subscriptionID,
         [Parameter(Mandatory = $true)]
         [string]$ResourceGroupName,
         [Parameter(Mandatory = $true)]

source/Public/Capacity/Get-FabricCapacityState.ps1

@@ -34,7 +34,7 @@ Author: Ioana Bouariu
     # Define mandatory parameters for the subscription ID, resource group, and capacity.
     Param (
         [Parameter(Mandatory = $true)]
-        [string]$subscriptionID,
+        [guid]$subscriptionID,
         [Parameter(Mandatory = $true)]
         [string]$resourcegroup,
         [Parameter(Mandatory = $true)]

source/Public/Capacity/Get-FabricCapacityWorkload.ps1

@@ -28,7 +28,7 @@ Author: Ioana Bouariu
     # Define a mandatory parameter for the capacity ID.
     Param (
         [Parameter(Mandatory = $true)]
-        [string]$capacityID
+        [guid]$CapacityId
     )
 
     Confirm-TokenState