Feature/small updates (#122)

* Fix function name in CHANGELOG and update examples

Corrected the function name from Get-SqlDatabase to Get-FabricSqlDatabase in the CHANGELOG.
Updated examples in the Get-FabricSQLDatabase function to improve clarity and consistency.
Thank you!

* Update Get-FabricSQLDatabase to improve parameter handling

Refactor the function to return warnings instead of throwing errors when both SQLDatabaseName and SQLDatabaseId are provided. Update the synopsis and description for clarity. Ensure the return value is correctly handled in the End block.

Thank you!

* Update Get-FabricSQLDatabase documentation and URI

Clarify the function's synopsis and description to enhance understanding.
Corrected the spelling of "examples" and updated the URI to follow the correct casing for SQL databases.

Thank you!

* Update example in Get-FabricSQLDatabase documentation

Changed the example command to use quotes around the workspace name for consistency and clarity. This helps users understand the correct syntax when using the function.

Thank you!

* Update example in Get-FabricSQLDatabase documentation

Changed the workspace name in the example to 'MsLearn-dev' because thats important

Thank you!

* Refactor Get-FabricSQLDatabase to improve parameter handling

This change restructures the function to ensure that the SQLDatabaseName and SQLDatabaseID parameters cannot be used together, enhancing the clarity of parameter usage. The process block has been properly defined to maintain code organization and readability.

Thank you!

* Refactor Get-FabricSQLDatabase for improved readability

Reorganize function structure and enhance code clarity by adjusting the formatting of the function definition and control structures. This change aims to make the code more maintainable and easier to understand.

Thank you!

* Initialize return array in Get-FabricSQLDatabase

This change introduces an initialization of the return array at the beginning of the Get-FabricSQLDatabase function. This will ensure that the function has a defined return structure, improving its reliability and maintainability.

Thank you!

* Add check for response before updating return array

This change ensures that the return array is only updated if there is a valid response from the SQLDatabase filtering. This prevents potential errors when no matching databases are found.

Thank you!

Author: SQLDBAWithABeard

CHANGELOG.md

@@ -9,7 +9,7 @@ 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).
+- Get-FabricSqlDatabase accepts Workspace as a pipeline, handles errors correctly and can filter by name (#117).
 
 ### Fixed
 ### Deprecated

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

@@ -1,16 +1,17 @@
-function Get-FabricSQLDatabase {
+function Get-FabricSQLDatabase
+{
 
     <#
 .SYNOPSIS
-    Retrieves Fabric SQLDatabases
+    Retrieves Fabric SQL Database details.
 
 .DESCRIPTION
-    Retrieves Fabric SQLDatabases. Without the SQLDatabaseName or SQLDatabaseID parameter,
-    all SQLDatabases are returned. If you want to retrieve a specific SQLDatabase, you can
+    Retrieves Fabric SQL Database details. Without the SQLDatabaseName or SQLDatabaseID parameter,
+    all SQL Databases are returned. If you want to retrieve a specific SQLDatabase, you can
     use the SQLDatabaseName or SQLDatabaseID parameter. These parameters cannot be used together.
 
 .PARAMETER WorkspaceId
-    Id of the Fabric Workspace for which the SQLDatabases should be retrieved. The value for WorkspaceId is a GUID.
+    Id of the Fabric Workspace for which the SQL Databases should be retrieved. The value for WorkspaceId is a GUID.
     An example of a GUID is '12345678-1234-1234-1234-123456789012'.
 
 .PARAMETER Workspace
@@ -25,33 +26,37 @@ function Get-FabricSQLDatabase {
     The value for SQLDatabaseID is a GUID. An example of a GUID is '12345678-1234-1234-1234-123456789012'.
 
 .EXAMPLE
-    Get-FabricSQLDatabase `
-        -WorkspaceId '12345678-1234-1234-1234-123456789012' `
-        -SQLDatabaseName 'MySQLDatabase'
+    $FabricSQLDatabaseConfig = @{
+        WorkspaceId = '12345678-1234-1234-1234-123456789012'
+        SQLDatabaseName = 'MySQLDatabase'
+    }
+    Get-FabricSQLDatabase @FabricSQLDatabaseConfig
 
-    This example will retrieve the SQLDatabase with the name 'MySQLDatabase'.
+    Returns the details of the Fabric SQL Database with the name 'MySQLDatabase' in the workspace that is specified by the WorkspaceId.
 
 .EXAMPLE
     Get-FabricSQLDatabase -WorkspaceId '12345678-1234-1234-1234-123456789012'
 
-    This example will retrieve all SQLDatabases in the workspace that is specified
-    by the WorkspaceId.
+    Returns the details of the Fabric SQL Databases in the workspace that is specified by the WorkspaceId.
 
 .EXAMPLE
-    Get-FabricSQLDatabase `
-        -WorkspaceId '12345678-1234-1234-1234-123456789012' `
-        -SQLDatabaseId '12345678-1234-1234-1234-123456789012'
+    $FabricSQLDatabaseConfig = @{
+        WorkspaceId = '12345678-1234-1234-1234-123456789012'
+        -SQLDatabaseId = '12345678-1234-1234-1234-123456789012'
+    }
+    Get-FabricSQLDatabase @FabricSQLDatabaseConfig
 
-    This example will retrieve the SQLDatabase with the ID '12345678-1234-1234-1234-123456789012'.
+    Returns the details of the Fabric SQL Database with the ID '12345678-1234-1234-1234-123456789012' from the workspace 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).
+    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
 
@@ -73,29 +78,40 @@ function Get-FabricSQLDatabase {
         [string]$SQLDatabaseId
     )
 
-    begin {
+    begin
+    {
+        $return = @()
         Confirm-TokenState
 
-        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"))
+        {
+            Write-Warning "The parameters SQLDatabaseName and SQLDatabaseId cannot be used together"
+            return
         }
+
+
     }
 
-    process {
-        if ($PSCmdlet.ParameterSetName -eq 'WorkspaceObject') {
+    process
+    {
+
+        if ($PSCmdlet.ParameterSetName -eq 'WorkspaceObject')
+        {
             $WorkspaceId = $Workspace.id
         }
 
         # Create SQLDatabase API
-        $uri = "$($FabricSession.BaseApiUrl)/workspaces/$WorkspaceId/SqlDatabases"
-        if ($SQLDatabaseId) {
+        $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) {
+        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
@@ -104,10 +120,19 @@ function Get-FabricSQLDatabase {
         }
 
         $response = $response.value
-        if ($SQLDatabaseName) {
+        if ($SQLDatabaseName)
+        {
             # Filter the SQLDatabase by name
             $response = $response | Where-Object { $_.displayName -eq $SQLDatabaseName }
         }
-        return $response
+        if ($response)
+        {
+            $return += $response
+        }
+    }
+
+    End
+    {
+        $return
     }
 }