public/Environment/Get-FabricEnvironmentSparkCompute.ps1
|
<#
.SYNOPSIS Retrieves the Spark compute details for a specific environment in a Microsoft Fabric workspace. .DESCRIPTION The Get-FabricEnvironmentSparkCompute function communicates with the Microsoft Fabric API to fetch information about Spark compute resources associated with a specified environment. It ensures that the API token is valid and gracefully handles errors during the API call. .PARAMETER WorkspaceId The unique identifier of the workspace containing the target environment. .PARAMETER EnvironmentId The unique identifier of the environment whose Spark compute details are being retrieved. .EXAMPLE Get-FabricEnvironmentSparkCompute -WorkspaceId "workspace-12345" -EnvironmentId "environment-67890" Retrieves Spark compute details for the specified environment in the given workspace. .NOTES - Requires the `$FabricConfig` global object, including `BaseUrl` and `FabricHeaders`. - Uses `Test-TokenExpired` to validate the token before making API calls. Author: Tiago Balabuch #> function Get-FabricEnvironmentSparkCompute { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [string]$WorkspaceId, [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [string]$EnvironmentId ) try { # Step 1: Ensure token validity Write-Message -Message "Validating token..." -Level Debug Test-TokenExpired Write-Message -Message "Token validation completed." -Level Debug # Step 2: Construct the API URL $apiEndpointUrl = "{0}/workspaces/{1}/environments/{2}/sparkcompute" -f $FabricConfig.BaseUrl, $WorkspaceId, $EnvironmentId Write-Message -Message "API Endpoint: $apiEndpointUrl" -Level Debug # Step 3: Make the API request $response = Invoke-RestMethod ` -Headers $FabricConfig.FabricHeaders ` -Uri $apiEndpointUrl ` -Method Get ` -ErrorAction Stop ` -SkipHttpErrorCheck ` -ResponseHeadersVariable "responseHeader" ` -StatusCodeVariable "statusCode" # Step 4: 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 "Error Code: $($response.errorCode)" -Level Error return $null } # Step 5: Handle results return $response } catch { # Step 6: Capture and log error details $errorDetails = $_.Exception.Message Write-Message -Message "Failed to retrieve environment Spark compute. Error: $errorDetails" -Level Error } } |