Get-SqlDatabase accepts Workspace as a pipeline and handles errors correctly

Get-SqlDatabase accepts Workspace as a pipeline and handles errors correctly

Author: NowinskiK

CHANGELOG.md

@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added credits for authors to all functions and Unit tests to verify the existence of such tags #89
 
 ### Changed
+- Get-SqlDatabase accepts Workspace as a pipeline, handles errors correctly and can filter by name (#117).
+
 ### Fixed
 ### Deprecated
 ### Removed

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

@@ -13,8 +13,12 @@ function Get-FabricSQLDatabase {
     Id of the Fabric Workspace for which the SQLDatabases should be retrieved. The value for WorkspaceId is a GUID.
     An example of a GUID is '12345678-1234-1234-1234-123456789012'.
 
+.PARAMETER Workspace
+    The workspace object. This is a mandatory parameter for the 'WorkspaceObject' parameter set and can be pipelined into the function.
+    The object can be easily retrieved by Get-FabricWorkspace function.
+
 .PARAMETER SQLDatabaseName
-    The name of the KQLDatabase to retrieve. This parameter cannot be used together with SQLDatabaseID.
+    The name of the SQLDatabase to retrieve. This parameter cannot be used together with SQLDatabaseID.
 
 .PARAMETER SQLDatabaseID
     The Id of the SQLDatabase to retrieve. This parameter cannot be used together with SQLDatabaseName.
@@ -28,7 +32,7 @@ function Get-FabricSQLDatabase {
     This example will retrieve the SQLDatabase with the name 'MySQLDatabase'.
 
 .EXAMPLE
-    Get-FabricSQLDatabase
+    Get-FabricSQLDatabase -WorkspaceId '12345678-1234-1234-1234-123456789012'
 
     This example will retrieve all SQLDatabases in the workspace that is specified
     by the WorkspaceId.
@@ -40,6 +44,11 @@ function Get-FabricSQLDatabase {
 
     This example will retrieve the SQLDatabase with the ID '12345678-1234-1234-1234-123456789012'.
 
+.EXAMPLE
+    Get-FabricWorkspace -WorkspaceName 'MsLearn-dev' | Get-FabricSQLDatabase
+
+    This example will retrieve all SQLDatabases from the workspace with the name 'MsLearn-dev' (using the pipeline).
+
 .NOTES
     Revision History:
         - 2025-03-06 - KNO: Init version of the function
@@ -51,31 +60,54 @@ function Get-FabricSQLDatabase {
 
     [CmdletBinding()]
     param (
-        [Parameter(Mandatory = $true)]
+        [Parameter(Mandatory = $true, ParameterSetName = 'WorkspaceId')]
         [string]$WorkspaceId,
 
+        [Parameter(Mandatory = $true, ParameterSetName = 'WorkspaceObject', ValueFromPipeline = $true )]
+        $Workspace,
+
         [Alias("Name", "DisplayName")]
         [string]$SQLDatabaseName,
 
         [Alias("Id")]
         [string]$SQLDatabaseId
     )
 
-    Confirm-TokenState
+    begin {
+        Confirm-TokenState
 
-    Write-Verbose "You can either use SQLDatabaseName or SQLDatabaseID not both. If both are used throw error"
-    if ($PSBoundParameters.ContainsKey("SQLDatabaseName") -and $PSBoundParameters.ContainsKey("SQLDatabaseId")) {
-        throw "Parameters SQLDatabaseName and SQLDatabaseId cannot be used together"
+        if ($PSBoundParameters.ContainsKey("SQLDatabaseName") -and $PSBoundParameters.ContainsKey("SQLDatabaseId")) {
+            throw "Parameters SQLDatabaseName and SQLDatabaseId cannot be used together"
+        }
     }
 
-    # Create SQLDatabase API
-    $uri = "$($FabricSession.BaseApiUrl)/workspaces/$workspaceId/SqlDatabases"
-    if ($SQLDatabaseId) {
-        $uri = "$uri/$SQLDatabaseId"
+    process {
+        if ($PSCmdlet.ParameterSetName -eq 'WorkspaceObject') {
+            $WorkspaceId = $Workspace.id
+        }
+
+        # Create SQLDatabase API
+        $uri = "$($FabricSession.BaseApiUrl)/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
+        }
+
+        $response = $response.value
+        if ($SQLDatabaseName) {
+            # Filter the SQLDatabase by name
+            $response = $response | Where-Object { $_.displayName -eq $SQLDatabaseName }
+        }
+        return $response
     }
-    $result = Invoke-RestMethod -Headers $FabricSession.HeaderParams -Uri $uri
-    ##$databases.Where({$_.displayName -eq $body.displayName}).id
-
-    return $result.value
-
 }

tests/Unit/Get-FabricSQLDatabase.Tests.ps1

@@ -3,21 +3,21 @@ param(
     $ModuleName = "FabricTools",
     $expectedParams = @(
         "WorkspaceId"
-                "SQLDatabaseName"
-                "SQLDatabaseId"
-                "Verbose"
-                "Debug"
-                "ErrorAction"
-                "WarningAction"
-                "InformationAction"
-                "ProgressAction"
-                "ErrorVariable"
-                "WarningVariable"
-                "InformationVariable"
-                "OutVariable"
-                "OutBuffer"
-                "PipelineVariable"
-                
+        "Workspace"
+        "SQLDatabaseName"
+        "SQLDatabaseId"
+        "Verbose"
+        "Debug"
+        "ErrorAction"
+        "WarningAction"
+        "InformationAction"
+        "ProgressAction"
+        "ErrorVariable"
+        "WarningVariable"
+        "InformationVariable"
+        "OutVariable"
+        "OutBuffer"
+        "PipelineVariable"
     )
 )
 
@@ -45,4 +45,3 @@ Describe "Get-FabricSQLDatabase" -Tag "UnitTests" {
         }
     }
 }
-