Merge pull request #132 from dataplat/bug-131-and-nowait

Enhanced unified function to handle errors, added `NoWait` and fix endless loop for LRO

Author: NowinskiK

CHANGELOG.md

@@ -9,19 +9,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - 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)
+- Fixed bug in `Get-FabricLongRunningOperationResult` - uses correct statusCode (#131)
+
 ### Deprecated
 ### Removed
+- Removed Revision History from `Get-FabricSQLDatabase`, `Get-FabricSQLDatabase`
+
 ### Security
 
 ## 0.22.0 - 20250609

source/Private/Test-FabricApiResponse.ps1

@@ -0,0 +1,129 @@
+function Test-FabricApiResponse {
+
+    <#
+.SYNOPSIS
+    Tests the response from a Fabric API call and handles long-running operations.
+
+.DESCRIPTION
+    Tests the response from a Fabric API call and handles long-running operations. It checks the status code and processes the response accordingly.
+
+.PARAMETER Response
+    The response body from the API call.
+
+.PARAMETER ObjectIdOrName
+    The name or ID of the resource being operated.
+
+.PARAMETER TypeName
+    The type of resource being operated (default: 'Fabric Item').
+
+.PARAMETER NoWait
+    If specified, the function will not wait for the operation to complete and will return immediately.
+
+.EXAMPLE
+    Test-FabricApiResponse -statusCode 201 -response $response -responseHeader $header -Name "MyResource" -typeName "Fabric Item"
+
+    Handles the response from a Fabric API call with a 201 status code, indicating successful creation of a resource.
+
+.EXAMPLE
+    Test-FabricApiResponse -statusCode 202 -response $response -responseHeader $header -Name "MyResource" -typeName "Fabric Item"
+
+    Handles the response from a Fabric API call with a 202 status code, indicating that the request has been accepted for processing.
+
+.NOTES
+    - This function is designed to be used within the context of a Fabric API client.
+    - It requires the `Write-Message` function to log messages at different levels (Info, Debug, Error).
+    - The function handles long-running operations by checking the status of the operation and retrieving the result if it has succeeded.
+
+    Author: Kamil Nowinski
+
+#>
+
+    [CmdletBinding()]
+    param (
+        [Parameter(Mandatory = $false)]
+        $Response,
+
+        [Parameter(Mandatory = $false)]
+        [string] $ObjectIdOrName,
+
+        [Parameter(Mandatory = $false)]
+        [string] $TypeName = 'Fabric Item',
+
+        [Parameter(Mandatory = $false)]
+        [switch] $NoWait = $false
+    )
+
+    $responseHeader = $script:responseHeader
+    $statusCode = $script:statusCode
+    $result = $null
+
+    $verb = (Get-PSCallStack)[1].Command.Split('-')[0]
+    Write-Message -Message "Testing API response for '$verb' operation. StatusCode: $statusCode." -Level Debug
+
+    switch ($statusCode) {
+        200 {
+            $result = $null
+        }
+        201 {
+            $result = $Response
+        }
+        202 {
+            Write-Message -Message "$verb Request for $TypeName '$ObjectIdOrName' accepted. Provisioning in progress!" -Level Info
+            [string]$operationId = $responseHeader["x-ms-operation-id"]
+
+            if ($NoWait) {
+                Write-Message -Message "NoWait parameter is set. Operation ID: $operationId" -Level Info
+                Write-Message -Message "Run to check the progress: Get-FabricLongRunningOperationResult -operationId '$operationId'" -Level Verbose
+                return [PSCustomObject]@{
+                    Location     = $responseHeader["Location"]
+                    RetryAfter   = $responseHeader["Retry-After"]
+                    OperationId  = $responseHeader["x-ms-operation-id"]
+                }
+            }
+
+            Write-Message -Message "[Test-FabricApiResponse] Operation ID: '$operationId'" -Level Debug
+            Write-Message -Message "[Test-FabricApiResponse] Getting Long Running Operation status" -Level Debug
+
+            $operationStatus = Get-FabricLongRunningOperation -operationId $operationId
+            Write-Message -Message "[Test-FabricApiResponse] Long Running Operation status: $operationStatus" -Level Debug
+            # Handle operation result
+            if ($operationStatus.status -eq "Succeeded") {
+                Write-Message -Message "Operation Succeeded" -Level Debug
+                Write-Message -Message "Getting Long Running Operation result" -Level Debug
+
+                $operationResult = Get-FabricLongRunningOperationResult -operationId $operationId
+                Write-Message -Message "Long Running Operation status: $operationResult" -Level Debug
+
+                return $operationResult
+            } else {
+                Write-Message -Message "Operation failed. Status: $($operationStatus)" -Level Debug
+                Write-Message -Message "Operation failed. Status: $($operationStatus)" -Level Error
+                return $operationStatus
+            }
+        }
+        default {
+            Write-Message -Message "Test-FabricApiResponse::default" -Level Debug
+            Write-Message -Message "Unexpected response code: $statusCode from the API." -Level Error
+            Write-Message -Message "Error: $($response.message)" -Level Error
+            if ($response.moreDetails) {
+                Write-Message -Message "More Details: $($response.moreDetails)" -Level Error
+            }
+            Write-Message "Error Code: $($response.errorCode)" -Level Error
+            throw "API request failed with status code $statusCode."
+        }
+    }
+
+    switch ($verb) {
+        'New'    { $msg = "$TypeName '$ObjectIdOrName' created successfully!" }
+        'Update' { $msg = "$TypeName '$ObjectIdOrName' updated successfully!" }
+        'Remove' { $msg = "$TypeName '$ObjectIdOrName' deleted successfully!" }
+        'Get'    { $msg = "" }
+        default  { $msg = "Received $statusCode status code for $verb operation on $TypeName '$ObjectIdOrName'." }
+    }
+    if ($msg) {
+        Write-Message -Message $msg -Level Info
+    }
+
+    $result
+
+}

source/Public/Invoke-FabricRestMethod.ps1

@@ -55,6 +55,8 @@ Function Invoke-FabricRestMethod {
         [switch] $PowerBIApi
     )
 
+    Write-Message -Message "[Invoke-FabricRestMethod]::Begin" -Level Debug
+
     if ($TestTokenExpired) {
         Confirm-TokenState
     }
@@ -73,26 +75,31 @@ Function Invoke-FabricRestMethod {
 
     if ($Body -is [hashtable]) {
         $Body = $Body | ConvertTo-Json -Depth 10
-        Write-Message -Message "Request Body: $Body" -Level Debug
+        Write-Message -Message "[Invoke-FabricRestMethod] Request Body: $Body" -Level Debug
     } elseif ($Body -is [string]) {
-        Write-Message -Message "Request Body: $Body" -Level Debug
+        Write-Message -Message "[Invoke-FabricRestMethod] Request Body: $Body" -Level Debug
     } else {
-        Write-Message -Message "No request body provided." -Level Debug
+        Write-Message -Message "[Invoke-FabricRestMethod] No request body provided." -Level Debug
     }
 
-    $response = Invoke-RestMethod `
-        -Headers $FabricSession.HeaderParams `
-        -Uri $Uri `
-        -Method $Method `
-        -Body $Body `
-        -ContentType "application/json" `
-        -ErrorAction 'Stop' `
-        -SkipHttpErrorCheck `
-        -ResponseHeadersVariable "responseHeader" `
-        -StatusCodeVariable "statusCode"
+    $request = @{
+        Headers = $FabricSession.HeaderParams
+        Uri = $Uri
+        Method = $Method
+        Body = $Body
+        ContentType = "application/json"
+        ErrorAction = 'Stop'
+        SkipHttpErrorCheck = $true
+        ResponseHeadersVariable = "responseHeader"
+        StatusCodeVariable = "statusCode"
+    }
+    $response = Invoke-RestMethod @request
 
+    Write-Message -Message "[Invoke-FabricRestMethod] Result response code: $statusCode" -Level Debug
+    Write-Message -Message "[Invoke-FabricRestMethod] Result return: $response" -Level Debug
     $script:statusCode = $statusCode
     $script:responseHeader = $responseHeader
 
+    Write-Message -Message "[Invoke-FabricRestMethod]::End" -Level Debug
     return $response
 }

source/Public/SQL Database/Get-FabricSQLDatabase.ps1

@@ -54,10 +54,6 @@ function Get-FabricSQLDatabase
     Returns the details of the Fabric SQL Databases in the MsLearn-dev workspace.
 
 .NOTES
-    Revision History:
-        - 2025-03-06 - KNO: Init version of the function
-        - 2025-06-14 - Update the examples to remove backticks
-
     Author: Kamil Nowinski
 
     #>
@@ -89,7 +85,6 @@ function Get-FabricSQLDatabase
             return
         }
 
-
     }
 
     process
@@ -101,23 +96,15 @@ function Get-FabricSQLDatabase
         }
 
         # Create SQLDatabase API
-        $uri = "$($FabricSession.BaseApiUrl)/workspaces/$WorkspaceId/sqlDatabases"
+        $uri = "workspaces/$WorkspaceId/sqlDatabases"
         if ($SQLDatabaseId)
         {
             $uri = "$uri/$SQLDatabaseId"
         }
         $response = Invoke-FabricRestMethod -Uri $uri
-        ##$databases.Where({$_.displayName -eq $body.displayName}).id
 
         # Step: Validate the response code
-        if ($statusCode -ne 200)
-        {
-            Write-Message -Message "Unexpected response code: $statusCode from the API." -Level Error
-            Write-Message -Message "Error: $($response.message)" -Level Error
-            Write-Message -Message "Error Details: $($response.moreDetails)" -Level Error
-            Write-Message "Error Code: $($response.errorCode)" -Level Error
-            return $null
-        }
+        Test-FabricApiResponse -Response $response -ObjectIdOrName $SQLDatabaseId -TypeName "SQL Database"
 
         $response = $response.value
         if ($SQLDatabaseName)

source/Public/SQL Database/New-FabricSQLDatabase.ps1

@@ -1,27 +1,28 @@
 <#
 .SYNOPSIS
-Creates a new SQL Database in a specified Microsoft Fabric workspace.
+    Creates a new SQL Database in a specified Microsoft Fabric workspace.
 
 .DESCRIPTION
-This function sends a POST request to the Microsoft Fabric API to create a new SQL Database
-in the specified workspace. It supports optional parameters for SQL Database description
-and path definitions for the SQL Database content.
+    This function sends a POST request to the Microsoft Fabric API to create a new SQL Database
+    in the specified workspace. It supports optional parameters for SQL Database description
+    and path definitions for the SQL Database content.
 
 .PARAMETER WorkspaceId
-The unique identifier of the workspace where the SQL Database will be created.
+    The unique identifier of the workspace where the SQL Database will be created.
 
 .PARAMETER Name
-The name of the SQL Database to be created.
+    The name of the SQL Database to be created.
 
 .PARAMETER Description
-An optional description for the SQL Database.
+    An optional description for the SQL Database.
 
+.PARAMETER NoWait
+    If specified, the function will not wait for the operation to complete and will return immediately.
 
 .EXAMPLE
- New-FabricSQLDatabase -WorkspaceId "workspace-12345" -Name "NewDatabase"
+    New-FabricSQLDatabase -WorkspaceId "workspace-12345" -Name "NewDatabase"
 
- .NOTES
-- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`.
+.NOTES
 - Calls `Confirm-TokenState` to ensure token validity before making the API request.
 
 Author: Kamil Nowinski
@@ -42,7 +43,9 @@ function New-FabricSQLDatabase
 
         [Parameter(Mandatory = $false)]
         [ValidateNotNullOrEmpty()]
-        [string]$Description
+        [string]$Description,
+
+        [switch]$NoWait = $false
     )
 
     try
@@ -51,7 +54,7 @@ function New-FabricSQLDatabase
         Confirm-TokenState
 
         # Step 2: Construct the API URL
-        $apiEndpointUrl = "{0}/workspaces/{1}/sqldatabases" -f $FabricConfig.BaseUrl, $WorkspaceId
+        $apiEndpointUrl = "workspaces/{0}/sqldatabases" -f $WorkspaceId
         Write-Message -Message "API Endpoint: $apiEndpointUrl" -Level Debug
 
         # Step 3: Construct the request body
@@ -67,18 +70,13 @@ function New-FabricSQLDatabase
         $bodyJson = $body | ConvertTo-Json -Depth 10
         Write-Message -Message "Request Body: $bodyJson" -Level Debug
 
+        # Step 4: Make the API request
         if ($PSCmdlet.ShouldProcess($apiEndpointUrl, "Create SQL Database"))
         {
-
-            # Step 4: Make the API request
-            $response = Invoke-FabricRestMethod `
-                -Uri $apiEndpointUrl `
-                -Method Post `
-                -Body $bodyJson
+            $response = Invoke-FabricRestMethod -Uri $apiEndpointUrl -Method Post -Body $bodyJson
         }
         # Step 5: Handle and log the response
-        Write-Message "RESPONSE: $response" -Level Debug
-        Test-FabricApiResponse -response $response -responseHeader $responseHeader -statusCode $statusCode -Name $Name -TypeName 'SQL Database'
+        Test-FabricApiResponse -Response $response -ObjectIdOrName $Name -TypeName 'SQL Database' -NoWait:$NoWait
     }
     catch
     {

source/Public/SQL Database/Remove-FabricSQLDatabase.ps1

@@ -17,7 +17,6 @@ Remove-FabricSQLDatabas -WorkspaceId "12345" -SQLDatabaseId "67890"
 Deletes the SQL Database with ID "67890" from workspace "12345".
 
 .NOTES
-- Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`.
 - Validates token expiration before making the API request.
 
 Author: Kamil Nowinski
@@ -43,28 +42,17 @@ function Remove-FabricSQLDatabase
         Confirm-TokenState
 
         # Step 2: Construct the API URL
-        $apiEndpointUrl = "{0}/workspaces/{1}/sqldatabases/{2}" -f $FabricConfig.BaseUrl, $WorkspaceId, $SQLDatabaseId
+        $apiEndpointUrl = "workspaces/{0}/sqldatabases/{1}" -f $WorkspaceId, $SQLDatabaseId
         Write-Message -Message "API Endpoint: $apiEndpointUrl" -Level Debug
 
         if ($PSCmdlet.ShouldProcess($apiEndpointUrl, "Delete SQL Database"))
         {
-
             # Step 3: Make the API request
-            $response = Invoke-FabricRestMethod `
-                -Uri $apiEndpointUrl `
-                -Method Delete
+            $response = Invoke-FabricRestMethod -Uri $apiEndpointUrl -Method Delete
         }
 
         # Step 4: Validate the response code
-        if ($statusCode -ne 200)
-        {
-            Write-Message -Message "Unexpected response code: $statusCode from the API." -Level Error
-            Write-Message -Message "Error: $($response.message)" -Level Error
-            Write-Message "Error Code: $($response.errorCode)" -Level Error
-            return $null
-        }
-        Write-Message -Message "SQL Database '$SQLDatabaseId' deleted successfully from workspace '$WorkspaceId'." -Level Info
-
+        Test-FabricApiResponse -Response $response -ObjectIdOrName $SQLDatabaseId -TypeName "SQL Database"
     }
     catch
     {