public/Workspace/Get-FabricWorkspace.ps1
|
<#
.SYNOPSIS Retrieves details of a Microsoft Fabric workspace by its ID or name. .DESCRIPTION The `Get-FabricWorkspace` function fetches workspace details from the Fabric API. It supports filtering by WorkspaceId or WorkspaceName. .PARAMETER WorkspaceId The unique identifier of the workspace to retrieve. .PARAMETER WorkspaceName The display name of the workspace to retrieve. .EXAMPLE Get-FabricWorkspace -WorkspaceId "workspace123" Fetches details of the workspace with ID "workspace123". .EXAMPLE Get-FabricWorkspace -WorkspaceName "MyWorkspace" Fetches details of the workspace with the name "MyWorkspace". .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Test-TokenExpired` to ensure token validity before making the API request. - Returns the matching workspace details or all workspaces if no filter is provided. Author: Tiago Balabuch #> function Get-FabricWorkspace { [CmdletBinding()] param ( [Parameter(Mandatory = $false)] [ValidateNotNullOrEmpty()] [string]$WorkspaceId, [Parameter(Mandatory = $false)] [ValidateNotNullOrEmpty()] [ValidatePattern('^[a-zA-Z0-9_ ]*$')] [string]$WorkspaceName ) try { # Step 1: Handle ambiguous input if ($WorkspaceId -and $WorkspaceName) { Write-Message -Message "Both 'WorkspaceId' and 'WorkspaceName' were provided. Please specify only one." -Level Error return $null } # Step 2: Ensure token validity Write-Message -Message "Validating token..." -Level Debug Test-TokenExpired Write-Message -Message "Token validation completed." -Level Debug # Step 3: Initialize variables $continuationToken = $null $workspaces = @() if (-not ([AppDomain]::CurrentDomain.GetAssemblies() | Where-Object { $_.GetName().Name -eq "System.Web" })) { Add-Type -AssemblyName System.Web } # Step 4: Loop to retrieve all capacities with continuation token Write-Message -Message "Loop started to get continuation token" -Level Debug $baseApiEndpointUrl = "{0}/workspaces" -f $FabricConfig.BaseUrl do { # Step 5: 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 6: Make the API request $response = Invoke-RestMethod ` -Headers $FabricConfig.FabricHeaders ` -Uri $apiEndpointUrl ` -Method Get ` -ErrorAction Stop ` -SkipHttpErrorCheck ` -ResponseHeadersVariable "responseHeader" ` -StatusCodeVariable "statusCode" # Step 7: 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 } # Step 8: Add data to the list if ($null -ne $response) { Write-Message -Message "Adding data to the list" -Level Debug $workspaces += $response.value # Update the continuation token if present if ($response.PSObject.Properties.Match("continuationToken")) { Write-Message -Message "Updating the continuation token" -Level Debug $continuationToken = $response.continuationToken Write-Message -Message "Continuation token: $continuationToken" -Level Debug } else { Write-Message -Message "Updating the continuation token to null" -Level Debug $continuationToken = $null } } else { Write-Message -Message "No data received from the API." -Level Warning break } } while ($null -ne $continuationToken) Write-Message -Message "Loop finished and all data added to the list" -Level Debug # Step 8: Filter results based on provided parameters $workspace = if ($WorkspaceId) { $workspaces | Where-Object { $_.Id -eq $WorkspaceId } } elseif ($WorkspaceName) { $workspaces | Where-Object { $_.DisplayName -eq $WorkspaceName } } else { # Return all workspaces if no filter is provided Write-Message -Message "No filter provided. Returning all workspaces." -Level Debug $workspaces } # Step 9: Handle results if ($workspace) { Write-Message -Message "Workspace found matching the specified criteria." -Level Debug return $workspace } else { Write-Message -Message "No workspace found matching the provided criteria." -Level Warning return $null } } catch { # Step 10: Capture and log error details $errorDetails = $_.Exception.Message Write-Message -Message "Failed to retrieve workspace. Error: $errorDetails" -Level Error } } |