Merge branch 'develop' into Update-FabricCapacity-161

Author: NowinskiK

CHANGELOG.md

@@ -13,9 +13,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 
 - Version of `Microsoft.PowerShell.PSResourceGet` and `Microsoft.PowerShell.PlatyPS` updated
+- Replace the repo's configuration approach with PSFramework (move config handling to PSFramework) #85
+- Applied `Invoke-FabricRestMethod` to several public cmdlets #85
 
 ### Fixed
 
+- Fixed bug in `Update-FabricSemanticModelDefinition` - Uri was incorrect when a platform file exists
+
 ### Deprecated
 
 ### Removed

RequiredModules.psd1

@@ -13,16 +13,16 @@
     #}
     Assert                         = "0.9.6"
     InvokeBuild                    = 'latest'
-    PSScriptAnalyzer               = '1.19.1'
+    PSScriptAnalyzer               = '1.24.0'
     Pester                         = 'latest'
     ModuleBuilder                  = 'latest'
     ChangelogManagement            = 'latest'
     Sampler                        = 'latest'
     'Sampler.GitHubTasks'          = 'latest'
     MarkdownLinkCheck              = 'latest'
-    PSFramework                    = 'latest'
-    'Az.Accounts'                  = '5.0.0'
-    'Az.Resources'                 = '6.15.1'
+    'PSFramework'                  = 'latest'
+    'Az.Accounts'                  = '5.3.0'
+    'Az.Resources'                 = '8.1.1'
     'MicrosoftPowerBIMgmt'         = '1.2.1111'
     'Microsoft.PowerShell.PlatyPS' = 'latest'
 }

build.yaml

@@ -103,7 +103,7 @@ Pester:
   #  - FunctionalQuality
   #  - TestQuality
   Tag:
-  CodeCoverageThreshold: 0.30 # 85 # Set to 0 to bypass
+  CodeCoverageThreshold: 0.10 # 85 # Set to 0 to bypass
   #CodeCoverageOutputFile: JaCoCo_$OsShortName.xml
   #CodeCoverageOutputFileEncoding: ascii
   # Use this if code coverage should be merged from several pipeline test jobs.

docs/en-US/FabricTools.md

@@ -112,7 +112,7 @@ Retrieves the workloads for a specific capacity.
 
 ### [Get-FabricConfig](Get-FabricConfig.md)
 
-Gets the configuration for use with all functions in the PSFabricTools module.
+Gets the configuration for use with all functions in the FabricTools module.
 
 ### [Get-FabricConnection](Get-FabricConnection.md)
 
@@ -686,7 +686,7 @@ Retrieves External Data Shares details from a specified Microsoft Fabric.
 
 ### [Set-FabricConfig](Set-FabricConfig.md)
 
-Register the configuration for use with all functions in the PSFabricTools module.
+Register the configuration for use with all functions in the FabricTools module.
 
 ### [Start-FabricDeploymentPipelineStage](Start-FabricDeploymentPipelineStage.md)
 
@@ -875,4 +875,3 @@ Updates the role assignment for a specific principal in a Fabric workspace.
 ### [Write-FabricLakehouseTableData](Write-FabricLakehouseTableData.md)
 
 Loads data into a specified table in a Lakehouse within a Fabric workspace.
-

docs/en-US/Get-FabricConfig.md

@@ -13,7 +13,7 @@ title: Get-FabricConfig
 
 ## SYNOPSIS
 
-Gets the configuration for use with all functions in the PSFabricTools module.
+Gets the configuration for use with all functions in the FabricTools module.
 
 ## SYNTAX
 
@@ -27,21 +27,21 @@ Get-FabricConfig [[-ConfigName] <string>]
 
 ## DESCRIPTION
 
-Gets the configuration for use with all functions in the PSFabricTools module.
+Gets the configuration for use with all functions in the FabricTools module.
 
 ## EXAMPLES
 
 ### EXAMPLE 1
 
-Gets all configuration values for the PSFabricTools module and outputs them.
+Gets all configuration values for the FabricTools module and outputs them.
 
 ```powershell
 Get-FabricConfig
 ```
 
 ### EXAMPLE 2
 
-Gets the BaseUrl configuration value for the PSFabricTools module.
+Gets the BaseUrl configuration value for the FabricTools module.
 
 ```powershell
 Get-FabricConfig -ConfigName BaseUrl
@@ -81,4 +81,3 @@ Author: Jess Pomfret
 ## RELATED LINKS
 
 {{ Fill in the related links here }}
-

docs/en-US/Set-FabricConfig.md

@@ -13,7 +13,7 @@ title: Set-FabricConfig
 
 ## SYNOPSIS
 
-Register the configuration for use with all functions in the PSFabricTools module.
+Register the configuration for use with all functions in the FabricTools module.
 
 ## SYNTAX
 
@@ -28,21 +28,21 @@ Set-FabricConfig [[-WorkspaceGUID] <guid>] [[-DataWarehouseGUID] <guid>] [[-Base
 
 ## DESCRIPTION
 
-Register the configuration for use with all functions in the PSFabricTools module.
+Register the configuration for use with all functions in the FabricTools module.
 
 ## EXAMPLES
 
 ### EXAMPLE 1
 
-Registers the specified Fabric Data Warehouse configuration for use with all functions in the PSFabricTools module.
+Registers the specified Fabric Data Warehouse configuration for use with all functions in the FabricTools module.
 
 ```powershell
 Set-FabricConfig -WorkspaceGUID 'GUID-GUID-GUID-GUID' -DataWarehouseGUID 'GUID-GUID-GUID-GUID'
 ```
 
 ### EXAMPLE 2
 
-Registers the specified Fabric Data Warehouse configuration for use with all functions in the PSFabricTools module, but does not persist the values.
+Registers the specified Fabric Data Warehouse configuration for use with all functions in the FabricTools module, but does not persist the values.
 
 ```powershell
 Set-FabricConfig -WorkspaceGUID 'GUID-GUID-GUID-GUID' -DataWarehouseGUID 'GUID-GUID-GUID-GUID' -SkipPersist
@@ -196,4 +196,3 @@ Author: Jess Pomfret
 ## RELATED LINKS
 
 {{ Fill in the related links here }}
-

source/Private/Confirm-TokenState.ps1

@@ -24,26 +24,32 @@ function Confirm-TokenState {
     [CmdletBinding()]
     param ()
 
+    # Refresh the global FabricConfig variable to be backwards compatible
+    $script:FabricConfig = Get-PSFConfigValue 'FabricTools.FabricApi.BaseApiUrl'
+
     Write-Message -Message "Validating token..." -Level Verbose
 
     try {
         # Ensure required properties have valid values
-        if ([string]::IsNullOrWhiteSpace($FabricConfig.TenantId) -or
-            [string]::IsNullOrWhiteSpace($FabricConfig.TokenExpiresOn)) {
+        $tenantId = Get-PSFConfigValue FabricTools.FabricApi.TenantId
+        $tokenExpiresOn = Get-PSFConfigValue FabricTools.FabricSession.TokenExpiresOn
+
+        if ([string]::IsNullOrWhiteSpace($tenantId) -or
+            [string]::IsNullOrWhiteSpace($tokenExpiresOn)) {
             Write-Message -Message "Token details are missing. Please run 'Connect-FabricAccount' to configure the session." -Level Error
             throw "MissingTokenDetailsException: Token details are missing."
         }
 
         # Convert the TokenExpiresOn value to a DateTime object
-        if ($FabricConfig.TokenExpiresOn.GetType() -eq [datetimeoffset]) {
-            $tokenExpiryDate = $FabricConfig.TokenExpiresOn
+        if ($tokenExpiresOn.GetType() -eq [DateTimeOffset]) {
+            $tokenExpiryDate = $tokenExpiresOn
         } else {
-            $tokenExpiryDate = [datetimeoffset]::Parse($FabricConfig.TokenExpiresOn)
+            $tokenExpiryDate = [DateTimeOffset]::Parse($tokenExpiresOn)
         }
 
         # Check if the token is expired
-        if ($tokenExpiryDate -le [datetimeoffset]::Now) {
-            if ($FabricConfig.FeatureFlags.EnableTokenRefresh) {
+        if ($tokenExpiryDate -le [DateTimeOffset]::Now) {
+            if (Get-PSFConfigValue -FullName 'FabricTools.FeatureFlags.EnableTokenRefresh') {
                 Write-Message -Message "Token has expired. Attempting to refresh the token..." -Level Warning
                 Connect-FabricAccount -reset
             } else {

source/Private/Set-FabConfig.ps1

@@ -1,32 +1,24 @@
-# this is a workaround to get the variables set for now
-# TODO: change to use PSFConfig?
+Set-PSFConfig -Name 'FabricTools.FabricApi.BaseApiUrl'         -Value 'https://api.fabric.microsoft.com/v1'
+Set-PSFConfig -Name 'FabricTools.FabricApi.ResourceUrl'        -Value 'https://api.fabric.microsoft.com'
+Set-PSFConfig -Name 'FabricTools.FabricApi.TenantId'
+Set-PSFConfig -Name 'FabricTools.FabricApi.ContentType'        -Value 'application/json; charset=utf-8'
 
-$script:FabricSession = [ordered]@{
-    BaseApiUrl   = 'https://api.fabric.microsoft.com/v1'
-    ResourceUrl  = 'https://api.fabric.microsoft.com'
-    HeaderParams = $null
-    ContentType  = @{'Content-Type' = "application/json" }
-    KustoURL     = "https://api.kusto.windows.net"
-    AccessToken  = $null
-}
+Set-PSFConfig -Name 'FabricTools.FabricSession.Headers'        -Value @{}
+Set-PSFConfig -Name 'FabricTools.FabricSession.TokenExpiresOn' -Value $null
+Set-PSFConfig -Name 'FabricTools.FabricSession.AccessToken'    -Value $null
 
-$script:AzureSession = [ordered]@{
-    BaseApiUrl   = "https://management.azure.com"
-    AccessToken  = $null
-    HeaderParams = $null
-}
+Set-PSFConfig -Name 'FabricTools.KustoApi.BaseUrl'             -Value 'https://api.kusto.windows.net'
+Set-PSFConfig -Name 'FabricTools.AzureApi.BaseUrl'             -Value "https://management.azure.com"
 
-$script:PowerBI = [ordered]@{
-    BaseApiUrl = "https://api.powerbi.com/v1.0/myorg"
-}
+Set-PSFConfig -Name 'FabricTools.AzureSession.AccessToken'     -Value $null
+Set-PSFConfig -Name 'FabricTools.AzureSession.Headers'         -Value @{}
 
-$FabricConfig = @{
+Set-PSFConfig -Name 'FabricTools.PowerBiApi.BaseUrl'           -Value "https://api.powerbi.com/v1.0/myorg"
+
+# Remain backwards compatible with scripts relying on $FabricConfig variable
+$script:FabricConfig = @{
     BaseUrl        = "https://api.fabric.microsoft.com/v1"
-    ResourceUrl    = "https://api.fabric.microsoft.com"
-    FabricHeaders  = @{}
-    TenantId = ""
-    TokenExpiresOn = ""
-    FeatureFlags = @{
-        EnableTokenRefresh = $true
-    }
 }
+
+# Feature Flags
+Set-PSFConfig -Name 'FabricTools.FeatureFlags.EnableTokenRefresh' -Value $true -Validation bool

source/Public/Capacity/Get-FabricCapacityRefreshables.ps1

@@ -36,5 +36,6 @@ Author: Ioana Bouariu
 
     # Make a GET request to the PowerBI API to retrieve the top refreshable capacities.
     # The function returns the 'value' property of the response.
-    return (Invoke-RestMethod -uri "$($PowerBI.BaseApiUrl)/capacities/refreshables?`$top=$top" -Headers $FabricSession.HeaderParams -Method GET).value
+    $result = Invoke-FabricRestMethod -Method GET -PowerBIApi -Uri "capacities/refreshables?`$top=$top"
+    $result.value
 }

source/Public/Capacity/Get-FabricCapacitySkus.ps1

@@ -39,9 +39,12 @@ Author: Kamil Nowinski
 
     Confirm-TokenState
 
+    $AzureBaseApiUrl = Get-PSFConfigValue 'FabricTools.AzureApi.BaseUrl'
+    $AzureSessionHeaderParams = Get-PSFConfigValue 'FabricTools.AzureSession.Headers'
+
     #GET https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest/skus?api-version=2023-11-01
-    $uri = "$($AzureSession.BaseApiUrl)/subscriptions/$subscriptionID/resourceGroups/$ResourceGroupName/providers/Microsoft.Fabric/capacities/$capacity/skus?api-version=2023-11-01"
-    $result = Invoke-RestMethod -Headers $AzureSession.HeaderParams -Uri $uri -Method GET
+    $uri = "$AzureBaseApiUrl/subscriptions/$subscriptionID/resourceGroups/$ResourceGroupName/providers/Microsoft.Fabric/capacities/$capacity/skus?api-version=2023-11-01"
+    $result = Invoke-RestMethod -Headers $AzureSessionHeaderParams -Uri $uri -Method GET
 
     return $result.value