Refactored API functions to enhance error handling and pagination. Adjusted "Deployment Pipeline" functions to new version of Invoke-FabricRestMethod #143

NowinskiK · NowinskiK · commit 03d567f20023 · 2025-07-12T18:13:49.000+01:00
diff --git a/source/Private/Get-FabricContinuationToken.ps1 b/source/Private/Get-FabricContinuationToken.ps1
@@ -30,7 +30,7 @@ function Get-FabricContinuationToken {
     $continuationToken = $null
     if ($null -ne $Response) {
         # Update the continuation token if present
-        if ($Response.PSObject.Properties.Match("continuationToken")) {
+        if ($Response.PSObject.Properties.Match("continuationToken") -and $Response.continuationToken -ne $null) {
             $continuationToken = $Response.continuationToken
             Write-Message -Message "New continuation token: $continuationToken" -Level Debug
         } else {
diff --git a/source/Private/Test-FabricApiResponse.ps1 b/source/Private/Test-FabricApiResponse.ps1
@@ -10,15 +10,26 @@ function Test-FabricApiResponse {
 .PARAMETER Response
     The response body from the API call.
 
+.PARAMETER ResponseHeader
+    The response headers from the API call. This is used to retrieve operation IDs and other metadata.
+
+.PARAMETER StatusCode
+    The HTTP status code returned by the API call. This is used to determine how to handle the response.
+
 .PARAMETER Operation
     The operation being performed by parent function (e.g., 'New', 'Update', 'Remove', 'Get'). It helps in logging appropriate messages.
+    This parameter is optional and can be used to customize the logging message based on the operation type.
 
 .PARAMETER ObjectIdOrName
     The name or ID of the resource being operated.
 
 .PARAMETER TypeName
     The type of resource being operated (default: 'Fabric Item').
 
+.PARAMETER SuccessMessage
+    A custom success message to log upon successful completion of the operation. This overrides the default message based on Operation, TypeName, ObjectIdOrName.
+    This parameter is optional and can be used to provide a specific success message for the operation.
+
 .PARAMETER NoWait
     If specified, the function will not wait for the operation to complete and will return immediately.
 
@@ -36,6 +47,7 @@ function Test-FabricApiResponse {
     - 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.
+    - Supports handling of API rate limiting (HTTP 429) by waiting for the specified retry duration before returning a command to repeat the request.
 
     Author: Kamil Nowinski
 
@@ -65,10 +77,7 @@ function Test-FabricApiResponse {
         [string] $SuccessMessage,
 
         [Parameter(Mandatory = $false)]
-        [switch] $NoWait = $false,
-
-        [Parameter(Mandatory = $false)]
-        [switch] $ExtractValue = $false
+        [switch] $NoWait = $false
     )
 
     Write-Message -Message "::Begin" -Level Debug
@@ -166,17 +175,5 @@ function Test-FabricApiResponse {
 
     Write-Message -Message "::End" -Level Debug
 
-    # Return the "value" object if exists, otherwise return the response directly
-    if ($result -and $ExtractValue) {
-        Write-Message -Message "Extracting 'value' property from the response as requested." -Level Debug
-        if (-not $result.value) {
-            Write-Message -Message "No 'value' property found in the response." -Level Warning
-            return $result
-        }
-        $result | ForEach-Object { $result.value }
-    }
-    else {
-        $result
-    }
-
+    $result
 }
diff --git a/source/Public/Deployment Pipeline/Get-FabricDeploymentPipeline.ps1 b/source/Public/Deployment Pipeline/Get-FabricDeploymentPipeline.ps1
@@ -58,73 +58,28 @@ function Get-FabricDeploymentPipeline {
         if ($DeploymentPipelineId) {
             Write-Message -Message "Retrieving specific deployment pipeline with ID: $DeploymentPipelineId" -Level Debug
             $apiEndpointUrl = "deploymentPipelines/$DeploymentPipelineId"
-
-            $response = Invoke-FabricRestMethod -Uri $apiEndpointUrl -Method Get -HandleResponse -TypeName "deployment pipeline"
-            return $response
-
-            # Validate response
-            #Test-FabricApiResponse -response $response -ObjectIdOrName $DeploymentPipelineId -typeName "deployment pipeline"
-
-            # if ($response) {
-            #     Write-Message -Message "Successfully retrieved deployment pipeline." -Level Debug
-            #     return $response
-            # } else {
-            #     Write-Message -Message "No deployment pipeline found with the specified ID." -Level Warning
-            #     return $null
-            # }
+        } else {
+            $apiEndpointUrl = "deploymentPipelines"
         }
 
-        # Step 2: Initialize variables for listing all pipelines
-        $continuationToken = $null
-        $pipelines = @()
-
-        if (-not ([AppDomain]::CurrentDomain.GetAssemblies() | Where-Object { $_.GetName().Name -eq "System.Web" })) {
-            Add-Type -AssemblyName System.Web
+        # Step 5: Make the API request
+        $apiParameters = @{
+            Uri = $apiEndpointUrl
+            Method = 'GET'
+            HandleResponse = $true
+            TypeName = "deployment pipeline"
         }
-
-        # Step 3: Loop to retrieve all pipelines with continuation token
-        Write-Message -Message "Loop started to get continuation token" -Level Debug
-        $baseApiEndpointUrl = "deploymentPipelines"
-
-        do {
-            # Step 4: Construct the API URL
-            $apiEndpointUrl = $baseApiEndpointUrl
-
-            if ($null -ne $continuationToken) {
-                # URL-encode the continuation token
-                $encodedToken = [System.Web.HttpUtility]::UrlEncode($continuationToken)
-                $apiEndpointUrl = "{0}?continuationToken={1}" -f $apiEndpointUrl, $encodedToken
-            }
-            Write-Message -Message "API Endpoint: $apiEndpointUrl" -Level Debug
-
-            # Step 5: Make the API request
-            $apiParameters = @{
-                Uri = $apiEndpointUrl
-                Method = 'GET'
-                HandleResponse = $true
-                TypeName = "deployment pipeline"
-            }
-            $response = Invoke-FabricRestMethod @apiParameters
-
-            # Step 6: Process response and update continuation token
-            if ($null -ne $response) {
-                $pipelines += $response.value
-            }
-            $continuationToken = Get-FabricContinuationToken -Response $response
-
-        } while ($null -ne $continuationToken)
-
-        Write-Message -Message "Loop finished and all data added to the list" -Level Debug
+        $response = Invoke-FabricRestMethod @apiParameters
 
         if ($DeploymentPipelineName)
         {
             # Filter the list by name
             Write-Message -Message "Filtering deployment pipelines by name: $DeploymentPipelineName" -Level Debug
-            $pipelines = $pipelines | Where-Object { $_.displayName -eq $DeploymentPipelineName }
+            $response = $response | Where-Object { $_.displayName -eq $DeploymentPipelineName }
         }
 
         # Step 7: Handle results
-        $pipelines
+        $response
 
     } catch {
         # Step 8: Error handling
diff --git a/source/Public/Deployment Pipeline/Get-FabricDeploymentPipelineOperation.ps1 b/source/Public/Deployment Pipeline/Get-FabricDeploymentPipelineOperation.ps1
@@ -49,7 +49,6 @@ function Get-FabricDeploymentPipelineOperation {
 
         # Step 2: Construct the API URL
         $apiEndpointUrl = "deploymentPipelines/$DeploymentPipelineId/operations/$OperationId"
-        Write-Message -Message "API Endpoint: $apiEndpointUrl" -Level Debug
 
         # Step 3: Make the API request
         $apiParameters = @{
@@ -60,6 +59,7 @@ function Get-FabricDeploymentPipelineOperation {
             ObjectIdOrName = $DeploymentPipelineId
         }
         $response = Invoke-FabricRestMethod @apiParameters
+
         $response
 
     } catch {
diff --git a/source/Public/Deployment Pipeline/Get-FabricDeploymentPipelineRoleAssignments.ps1 b/source/Public/Deployment Pipeline/Get-FabricDeploymentPipelineRoleAssignments.ps1
@@ -35,40 +35,21 @@ function Get-FabricDeploymentPipelineRoleAssignments {
         # Step 1: Ensure token validity
         Confirm-TokenState
 
-        # Step 2: Initialize variables
-        $continuationToken = $null
-        $roleAssignments = @()
-
-        do {
-            # Step 3: Construct the API URL
-            $apiEndpointUrl = "deploymentPipelines/$DeploymentPipelineId/roleAssignments"
-            if ($continuationToken) {
-                $apiEndpointUrl += "?continuationToken=$continuationToken"
-            }
-            Write-Message -Message "API Endpoint: $apiEndpointUrl" -Level Debug
-
-            # Step 4: Make the API request and validate response
-            $apiParameters = @{
-                Uri = $apiEndpointUrl
-                Method = 'GET'
-                HandleResponse = $true
-                TypeName = "deployment pipeline role assignments"
-                ObjectIdOrName = $DeploymentPipelineId
-            }
-            $response = Invoke-FabricRestMethod @apiParameters
-
-            # Step 5: Process response and update continuation token
-            if ($response.value) {
-                $roleAssignments += $response.value
-                Write-Message -Message "Added $($response.value.Count) role assignments to the result set." -Level Debug
-            }
-            $continuationToken = Get-FabricContinuationToken -Response $response
-
-        } while ($continuationToken)
+        # Step 3: Construct the API URL
+        $apiEndpointUrl = "deploymentPipelines/$DeploymentPipelineId/roleAssignments"
+
+        # Step 4: Make the API request and validate response
+        $apiParameters = @{
+            Uri = $apiEndpointUrl
+            Method = 'GET'
+            HandleResponse = $true
+            TypeName = "deployment pipeline role assignments"
+            ObjectIdOrName = $DeploymentPipelineId
+        }
+        $response = Invoke-FabricRestMethod @apiParameters
 
         # Step 7: Return results
-        Write-Message -Message "??? Successfully retrieved $($roleAssignments.Count) role assignments." -Level Info
-        $roleAssignments
+        $response
 
     } catch {
         # Step 8: Error handling
diff --git a/source/Public/Deployment Pipeline/Get-FabricDeploymentPipelineStage.ps1 b/source/Public/Deployment Pipeline/Get-FabricDeploymentPipelineStage.ps1
@@ -65,11 +65,13 @@ function Get-FabricDeploymentPipelineStage {
             Uri = $apiEndpointUrl
             Method = 'GET'
             HandleResponse = $true
+            ExtractValue = $true
             TypeName = "deployment pipeline stage"
             ObjectIdOrName = $StageId ? $StageId : $DeploymentPipelineId
         }
         $response = Invoke-FabricRestMethod @apiParameters
-        $response.value
+
+        $response
 
     } catch {
         # Step 6: Error handling
diff --git a/source/Public/Deployment Pipeline/Get-FabricDeploymentPipelineStageItem.ps1 b/source/Public/Deployment Pipeline/Get-FabricDeploymentPipelineStageItem.ps1
@@ -48,39 +48,20 @@ function Get-FabricDeploymentPipelineStageItem {
         # Step 1: Ensure token validity
         Confirm-TokenState
 
-        # Step 2: Initialize variables for pagination
-        $continuationToken = $null
-        $allItems = @()
-
-        do {
-            # Step 3: Construct the API URL
-            $apiEndpointUrl = "deploymentPipelines/$DeploymentPipelineId/stages/$StageId/items"
-            if ($continuationToken) {
-                # URL-encode the continuation token
-                $encodedToken = [System.Web.HttpUtility]::UrlEncode($continuationToken)
-                $apiEndpointUrl = "{0}?continuationToken={1}" -f $apiEndpointUrl, $encodedToken
-            }
-            Write-Message -Message "API Endpoint: $apiEndpointUrl" -Level Debug
-
-            # Step 4: Make the API request
-            $apiParameters = @{
-                Uri = $apiEndpointUrl
-                Method = 'GET'
-                HandleResponse = $true
-                TypeName = "deployment pipeline stage items"
-                ObjectIdOrName = $StageId
-            }
-            $response = Invoke-FabricRestMethod @apiParameters
-
-            # Step 6: Process results
-            if ($response.value) {
-                $allItems += $response.value
-                Write-Message -Message "Retrieved $($response.value.Count) items." -Level Debug
-            }
-            $continuationToken = Get-FabricContinuationToken -Response $response
-        } while ($continuationToken)
-
-        $allItems
+        # Step 3: Construct the API URL
+        $apiEndpointUrl = "deploymentPipelines/$DeploymentPipelineId/stages/$StageId/items"
+
+        # Step 4: Make the API request
+        $apiParameters = @{
+            Uri = $apiEndpointUrl
+            Method = 'GET'
+            HandleResponse = $true
+            TypeName = "deployment pipeline stage items"
+            ObjectIdOrName = $StageId
+        }
+        $response = Invoke-FabricRestMethod @apiParameters
+
+        $response
 
     } catch {
         # Step 8: Error handling
diff --git a/source/Public/Invoke-FabricRestMethod.ps1 b/source/Public/Invoke-FabricRestMethod.ps1
