Fix for New-FabricDataPipeline - issue with call to Invoke-FabricAPIRequest #39 (#45)

jpomfret · web-flow · commit a0ea5b8bb089 · 2025-05-20T08:38:58.000+01:00
* fix for #39 * contenttype not used so post commands were failign * correct comment wording * update api call to fix for New-FabricDataPipeline - issue with call to Invoke-FabricAPIRequest #39 * fix for New-FabricDataPipeline - issue with call to Invoke-FabricAPIRequest #39 * fix for New-FabricDataPipeline - issue with call to Invoke-FabricAPIRequest #39 * fix for New-FabricDataPipeline - issue with call to Invoke-FabricAPIRequest #39 * formatting & spelling * whitespace changes * lets have a copyJob when we ask for one not a warehouse * fix for New-FabricDataPipeline - issue with call to Invoke-FabricAPIRequest #39 * fix for New-FabricDataPipeline - issue with call to Invoke-FabricAPIRequest #39 * change confirmImpact to high so confirm works cc. @SQLDBAWithABeard * fix for New-FabricDataPipeline - issue with call to Invoke-FabricAPIRequest #39 * fix for #39 * Removed leading slash from $apiEndpointURI #39 * Removed leading slash #39 ---------
diff --git a/source/Public/Capacity/Get-FabricCapacity.ps1 b/source/Public/Capacity/Get-FabricCapacity.ps1
@@ -14,11 +14,11 @@
     The name of the capacity to retrieve. This parameter is optional.
 
 .EXAMPLE
-     Get-FabricCapacity -capacityId "capacity-12345"
+    Get-FabricCapacity -capacityId "capacity-12345"
     This example retrieves the capacity details for the capacity with ID "capacity-12345".
 
 .EXAMPLE
-     Get-FabricCapacity -capacityName "MyCapacity"
+    Get-FabricCapacity -capacityName "MyCapacity"
     This example retrieves the capacity details for the capacity named "MyCapacity".
 
 .NOTES
@@ -51,14 +51,14 @@ function Get-FabricCapacity {
         Write-Message -Message "Token validation completed." -Level Debug
 
         # Construct the API endpoint URL
-        $apiEndpointURI = "{0}/capacities" -f $FabricConfig.BaseUrl
+        $apiEndpointURI = "capacities"
 
         # Invoke the Fabric API to retrieve capacity details
-        $capacities = Invoke-FabricAPIRequest `
-            -BaseURI $apiEndpointURI `
-            -Headers $FabricConfig.FabricHeaders `
-            -Method Get
-
+        $apiParams = @{
+            Uri    = $apiEndpointURI
+            Method = 'Get'
+        }
+        $capacities = (Invoke-FabricAPIRequest @apiParams).Value
 
         # Filter results based on provided parameters
         $response = if ($capacityId) {
@@ -85,4 +85,4 @@ function Get-FabricCapacity {
         Write-Message -Message "Failed to retrieve capacity. Error: $errorDetails" -Level Error
         return $null
     }
-}
+}
diff --git a/source/Public/Confirm-FabricAuthToken.ps1 b/source/Public/Confirm-FabricAuthToken.ps1
@@ -1,20 +1,20 @@
 <#
 .SYNOPSIS
-   Check whether the Fabric API authentication token is set and not expired and reset it if necessary.
+    Check whether the Fabric API authentication token is set and not expired and reset it if necessary.
 
 .DESCRIPTION
-   The Confirm-FabricAuthToken function retrieves the Fabric API authentication token. If the token is not already set, it calls the Set-FabricAuthToken function to set it. It then outputs the token.
+    The Confirm-FabricAuthToken function retrieves the Fabric API authentication token. If the token is not already set, it calls the Set-FabricAuthToken function to set it. It then outputs the token.
 
 .EXAMPLE
-   Confirm-FabricAuthToken
+    Confirm-FabricAuthToken
 
-   This command retrieves the Fabric API authentication token.
+    This command retrieves the Fabric API authentication token.
 
 .INPUTS
-   None. You cannot pipe inputs to this function.
+    None. You cannot pipe inputs to this function.
 
 .OUTPUTS
-   Returns object as Get-FabricDebugInfo function
+    Returns object as Get-FabricDebugInfo function
 
 .NOTES
 
@@ -47,4 +47,4 @@ function Confirm-FabricAuthToken {
     $s = Get-FabricDebugInfo
     return $s
 
-}
+}
diff --git a/source/Public/Copy Job/Get-FabricCopyJob.ps1 b/source/Public/Copy Job/Get-FabricCopyJob.ps1
@@ -60,13 +60,14 @@ function Get-FabricCopyJob {
 
 
         # Construct the API endpoint URL
-        $apiEndpointURI = "{0}/workspaces/{1}/copyJobs" -f $FabricConfig.BaseUrl, $WorkspaceId
+        $apiEndpointURI = "workspaces/{0}/copyJobs" -f $WorkspaceId
 
         # Invoke the Fabric API to retrieve capacity details
-        $copyJobs = Invoke-FabricAPIRequest `
-            -BaseURI $apiEndpointURI `
-            -Headers $FabricConfig.FabricHeaders `
-            -Method Get
+        $apiParams = @{
+            Uri    = $apiEndpointURI
+            Method = 'Get'
+        }
+        $copyJobs = Invoke-FabricAPIRequest @apiParams
 
         #  Filter results based on provided parameters
         $response = if ($CopyJobId) {
diff --git a/source/Public/Copy Job/Get-FabricCopyJobDefinition.ps1 b/source/Public/Copy Job/Get-FabricCopyJobDefinition.ps1
@@ -50,7 +50,7 @@ function Get-FabricCopyJobDefinition {
         Write-Message -Message "Authentication token is valid." -Level Debug
 
         # Step 2: Construct the API endpoint URL for retrieving the Copy Job definition.
-        $apiEndpointUrl = "{0}/workspaces/{1}/copyJobs/{2}/getDefinition" -f $FabricConfig.BaseUrl, $WorkspaceId, $CopyJobId
+        $apiEndpointUrl = "workspaces/{0}/copyJobs/{1}/getDefinition" -f $WorkspaceId, $CopyJobId
 
         # Step 3: Append the format query parameter if specified by the user.
         if ($CopyJobFormat) {
@@ -59,10 +59,11 @@ function Get-FabricCopyJobDefinition {
         Write-Message -Message "Constructed API Endpoint URL: $apiEndpointUrl" -Level Debug
 
         # Step 4: Execute the API request to retrieve the Copy Job definition.
-        $response = Invoke-FabricAPIRequest `
-            -BaseURI $apiEndpointUrl `
-            -Headers $FabricConfig.FabricHeaders `
-            -Method Post
+        $apiParams = @{
+            Uri     = $apiEndpointUrl
+            Method  = 'POST'
+        }
+        $response = Invoke-FabricAPIRequest @apiParams
 
         # Step 5: Return the API response containing the Copy Job definition.
         return $response
@@ -71,4 +72,4 @@ function Get-FabricCopyJobDefinition {
         $errorDetails = $_.Exception.Message
         Write-Message -Message "Failed to retrieve Copy Job definition. Error: $errorDetails" -Level Error
     }
-}
+}
diff --git a/source/Public/Copy Job/New-FabricCopyJob.ps1 b/source/Public/Copy Job/New-FabricCopyJob.ps1
@@ -62,7 +62,7 @@ function New-FabricCopyJob {
         Write-Message -Message "Token validation completed." -Level Debug
 
         # Step 2: Construct the API URL
-        $apiEndpointURI = "{0}/workspaces/{1}/warehouses" -f $FabricConfig.BaseUrl, $WorkspaceId
+        $apiEndpointURI = "workspaces/{0}/copyJobs" -f $WorkspaceId
         Write-Message -Message "API Endpoint: $apiEndpointURI" -Level Debug
 
         # Step 3: Construct the request body
@@ -127,15 +127,16 @@ function New-FabricCopyJob {
         if($PSCmdlet.ShouldProcess($apiEndpointURI, "Create Copy Job")) {
 
         # Step 6: Make the API request
-        $response = Invoke-FabricAPIRequest `
-            -BaseURI $apiEndpointURI `
-            -Headers $FabricConfig.FabricHeaders `
-            -Method Post `
-            -Body $bodyJson
+        $apiParams = @{
+            Uri    = $apiEndpointURI
+            Method = 'Post'
+            Body   = $bodyJson
         }
+        $response = Invoke-FabricAPIRequest @apiParams
+    }
 
-        Write-Message -Message "Copy Job created successfully!" -Level Info
-        return $response
+    Write-Message -Message "Copy Job created successfully!" -Level Info
+    return $response
 
     } catch {
         # Step 7: Handle and log errors
diff --git a/source/Public/Copy Job/Remove-FabricCopyJob.ps1 b/source/Public/Copy Job/Remove-FabricCopyJob.ps1
@@ -23,7 +23,7 @@
     Author: Tiago Balabuch
 #>
 function Remove-FabricCopyJob {
-    [CmdletBinding(SupportsShouldProcess)]
+    [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')]
     param (
         [Parameter(Mandatory = $true)]
         [ValidateNotNullOrEmpty()]
@@ -40,22 +40,23 @@ function Remove-FabricCopyJob {
         Write-Message -Message "Token validation completed." -Level Debug
 
         # Construct the API endpoint URI
-        $apiEndpointURI = "{0}/workspaces/{1}/copyJobs/{2}" -f $FabricConfig.BaseUrl, $WorkspaceId, $CopyJobId
+        $apiEndpointURI = "workspaces/{0}/copyJobs/{1}" -f $WorkspaceId, $CopyJobId
         Write-Message -Message "API Endpoint: $apiEndpointURI" -Level Debug
 
         if($PSCmdlet.ShouldProcess($apiEndpointURI, "Delete Copy Job")) {
 
         # Make the API request
-        $response = Invoke-FabricAPIRequest `
-            -Headers $FabricConfig.FabricHeaders `
-            -BaseURI $apiEndpointURI `
-            -Method Delete
+        $apiParams = @{
+            Uri = $apiEndpointURI
+            Method = 'DELETE'
         }
-        Write-Message -Message "Copy Job '$CopyJobId' deleted successfully from workspace '$WorkspaceId'." -Level Info
-        return $response
+        $response = Invoke-FabricAPIRequest @apiParams
+    }
+    Write-Message -Message "Copy Job '$CopyJobId' deleted successfully from workspace '$WorkspaceId'." -Level Info
+    return $response
 
-    } catch {
-        # Log and handle errors
+} catch {
+    # Log and handle errors
         $errorDetails = $_.Exception.Message
         Write-Message -Message "Failed to delete Copy Job '$CopyJobId' from workspace '$WorkspaceId'. Error: $errorDetails" -Level Error
     }
diff --git a/source/Public/Dashboard/Get-FabricDashboard.ps1 b/source/Public/Dashboard/Get-FabricDashboard.ps1
@@ -35,13 +35,14 @@ function Get-FabricDashboard {
         Write-Message -Message "Token validation completed." -Level Debug
 
         # Construct the API endpoint URL
-        $apiEndpointURI = "{0}/workspaces/{1}/dashboards" -f $FabricConfig.BaseUrl, $WorkspaceId
+        $apiEndpointURI = "workspaces/{0}/dashboards" -f $WorkspaceId
 
         # Invoke the Fabric API to retrieve capacity details
-        $Dashboards = Invoke-FabricAPIRequest `
-            -BaseURI $apiEndpointURI `
-            -Headers $FabricConfig.FabricHeaders `
-            -Method Get
+        $apiParams = @{
+            Uri    = $apiEndpointURI
+            Method = 'Get'
+        }
+        $Dashboards = Invoke-FabricAPIRequest @apiParams
 
         return $Dashboards
 
@@ -50,4 +51,4 @@ function Get-FabricDashboard {
         $errorDetails = $_.Exception.Message
         Write-Message -Message "Failed to retrieve Dashboard. Error: $errorDetails" -Level Error
     }
-}
+}
diff --git a/source/Public/Data Pipeline/Get-FabricDataPipeline.ps1 b/source/Public/Data Pipeline/Get-FabricDataPipeline.ps1
@@ -17,11 +17,11 @@ function Get-FabricDataPipeline {
     The name of the Data Pipeline to retrieve. This parameter is optional.
 
 .EXAMPLE
-     Get-FabricData Pipeline -WorkspaceId "workspace-12345" -Data PipelineId "Data Pipeline-67890"
+    Get-FabricData Pipeline -WorkspaceId "workspace-12345" -Data PipelineId "Data Pipeline-67890"
     This example retrieves the Data Pipeline details for the Data Pipeline with ID "Data Pipeline-67890" in the workspace with ID "workspace-12345".
 
 .EXAMPLE
-     Get-FabricData Pipeline -WorkspaceId "workspace-12345" -Data PipelineName "My Data Pipeline"
+    Get-FabricData Pipeline -WorkspaceId "workspace-12345" -Data PipelineName "My Data Pipeline"
     This example retrieves the Data Pipeline details for the Data Pipeline named "My Data Pipeline" in the workspace with ID "workspace-12345".
 
 .NOTES
@@ -59,13 +59,10 @@ function Get-FabricDataPipeline {
         Write-Message -Message "Token validation completed." -Level Debug
 
         # Construct the API endpoint URL
-        $apiEndpointURI = "{0}/workspaces/{1}/dataPipelines" -f $FabricConfig.BaseUrl, $WorkspaceId
+        $apiEndpointURI = ("workspaces/{0}/dataPipelines" -f $WorkspaceId)
 
-        # Invoke the Fabric API to retrieve capacity details
-        $DataPipelines = Invoke-FabricAPIRequest `
-            -BaseURI $apiEndpointURI `
-            -Headers $FabricConfig.FabricHeaders `
-            -Method Get
+        # Invoke the Fabric API to retrieve data pipeline details
+        $DataPipelines = (Invoke-FabricAPIRequest -uri $apiEndpointURI -Method Get).Value
 
         # Filter results based on provided parameters
         $response = if ($DataPipelineId) {
@@ -92,4 +89,4 @@ function Get-FabricDataPipeline {
         Write-Message -Message "Failed to retrieve DataPipeline. Error: $errorDetails" -Level Error
     }
 
-}
+}
diff --git a/source/Public/Data Pipeline/New-FabricDataPipeline.ps1 b/source/Public/Data Pipeline/New-FabricDataPipeline.ps1
@@ -17,7 +17,7 @@
     An optional description for the DataPipeline.
 
 .EXAMPLE
-     New-FabricDataPipeline -WorkspaceId "workspace-12345" -DataPipelineName "New DataPipeline"
+    New-FabricDataPipeline -WorkspaceId "workspace-12345" -DataPipelineName "New DataPipeline"
     This example creates a new DataPipeline named "New DataPipeline" in the workspace with ID "workspace-12345" and uploads the definition file from the specified path.
 
 .NOTES
@@ -53,7 +53,7 @@ function New-FabricDataPipeline
         Write-Message -Message "Token validation completed." -Level Debug
 
         # Step 2: Construct the API URL
-        $apiEndpointURI = "{0}/workspaces/{1}/dataPipelines" -f $FabricConfig.BaseUrl, $WorkspaceId
+        $apiEndpointURI = ("workspaces/{0}/dataPipelines" -f $WorkspaceId)
         Write-Message -Message "API Endpoint: $apiEndpointURI" -Level Debug
 
         # Step 3: Construct the request body
@@ -67,16 +67,18 @@ function New-FabricDataPipeline
         }
 
         $bodyJson = $body | ConvertTo-Json -Depth 10
+
         Write-Message -Message "Request Body: $bodyJson" -Level Debug
 
         if ($PSCmdlet.ShouldProcess($apiEndpointURI, "Create DataPipeline"))
         {
             # Step 4: Make the API request
-            $response = Invoke-FabricAPIRequest `
-                -BaseURI $apiEndpointURI `
-                -Headers $FabricConfig.FabricHeaders `
-                -method Post `
-                -body $bodyJson
+            $apiParams = @{
+                Uri    = $apiEndpointURI
+                method = 'Post'
+                body   = $bodyJson
+            }
+            $response = Invoke-FabricAPIRequest @apiParams
         }
         Write-Message -Message "Data Pipeline created successfully!" -Level Info
         return $response
diff --git a/source/Public/Datamart/Get-FabricDatamart.ps1 b/source/Public/Datamart/Get-FabricDatamart.ps1
@@ -48,12 +48,14 @@ function Get-FabricDatamart {
         Write-Message -Message "Token validation completed." -Level Debug
         # Step 3: Initialize variables
 
-        $apiEndpointURI = "{0}/workspaces/{1}/Datamarts" -f $FabricConfig.BaseUrl, $WorkspaceId
+        $apiEndpointURI = "workspaces/{0}/Datamarts" -f $WorkspaceId
+
+        $apiParams = @{
+            Uri    = $apiEndpointURI
+            method = 'Get'
+        }
+        $Datamarts = Invoke-FabricAPIRequest @apiParams
 
-        $Datamarts = = Invoke-FabricAPIRequest `
-            -BaseURI $apiEndpointURI `
-            -Headers $FabricConfig.FabricHeaders `
-            -Method Get
         # Step 9: Filter results based on provided parameters
 
         $response = if ($datamartId) {
diff --git a/source/Public/Invoke-FabricAPIRequest.ps1 b/source/Public/Invoke-FabricAPIRequest.ps1
@@ -49,13 +49,27 @@ Function Invoke-FabricAPIRequest {
     #>
     [CmdletBinding()]
     param(
-        [Parameter(Mandatory = $false)] [string] $authToken,
-        [Parameter(Mandatory = $true)] [string] $uri,
-        [Parameter(Mandatory = $false)] [ValidateSet('Get', 'Post', 'Delete', 'Put', 'Patch')] [string] $method = "Get",
-        [Parameter(Mandatory = $false)] $body,
-        [Parameter(Mandatory = $false)] [string] $contentType = "application/json; charset=utf-8",
-        [Parameter(Mandatory = $false)] [int] $timeoutSec = 240,
-        [Parameter(Mandatory = $false)] [int] $retryCount = 0
+        [Parameter(Mandatory = $false)]
+        [string] $authToken,
+
+        [Parameter(Mandatory = $true)]
+        [string] $uri,
+
+        [Parameter(Mandatory = $false)]
+        [ValidateSet('Get', 'Post', 'Delete', 'Put', 'Patch')]
+        [string] $method = "Get",
+
+        [Parameter(Mandatory = $false)]
+        $body,
+
+        [Parameter(Mandatory = $false)]
+        [string] $contentType = "application/json; charset=utf-8",
+
+        [Parameter(Mandatory = $false)]
+        [int] $timeoutSec = 240,
+
+        [Parameter(Mandatory = $false)]
+        [int] $retryCount = 0
     )
 
     Confirm-FabricAuthToken | Out-Null
@@ -65,7 +79,7 @@ Function Invoke-FabricAPIRequest {
 
         $requestUrl = "$($FabricSession.BaseApiUrl)/$uri"
         Write-Verbose "Calling $requestUrl"
-        $response = Invoke-WebRequest -Headers $fabricHeaders -Method $method -Uri $requestUrl -Body $body -TimeoutSec $timeoutSec
+        $response = Invoke-WebRequest -Headers $fabricHeaders -ContentType $contentType -Method $method -Uri $requestUrl -Body $body -TimeoutSec $timeoutSec
 
         if ($response.StatusCode -eq 202) {
             if ($uri -match "jobType=Pipeline") {
@@ -156,4 +170,4 @@ Function Invoke-FabricAPIRequest {
             throw $message
         }
     }
-}
+}
diff --git a/source/Public/Lakehouse/New-FabricLakehouse.ps1 b/source/Public/Lakehouse/New-FabricLakehouse.ps1
@@ -20,9 +20,9 @@ An optional description for the Lakehouse.
 An optional path to enable schemas in the Lakehouse
 
 .EXAMPLE
- Add-FabricLakehouse -WorkspaceId "workspace-12345" -LakehouseName "New Lakehouse" -LakehouseEnableSchemas $true
+Add-FabricLakehouse -WorkspaceId "workspace-12345" -LakehouseName "New Lakehouse" -LakehouseEnableSchemas $true
 
- .NOTES
+.NOTES
 - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`.
 - Calls `Test-TokenExpired` to ensure token validity before making the API request.
 
diff --git a/source/Public/Set-FabricAuthToken.ps1 b/source/Public/Set-FabricAuthToken.ps1
diff --git a/source/Public/Utils/Set-FabricApiHeaders.ps1 b/source/Public/Utils/Set-FabricApiHeaders.ps1
diff --git a/source/Public/Warehouse/Get-FabricWarehouse.ps1 b/source/Public/Warehouse/Get-FabricWarehouse.ps1
diff --git a/source/Public/Warehouse/New-FabricWarehouse.ps1 b/source/Public/Warehouse/New-FabricWarehouse.ps1
