FabricTools.psd1
|
# # Module manifest for module 'FabricTools' # # Generated by: The FabricTools Team # # Generated on: 26/05/2025 # @{ # Script module or binary module file associated with this manifest. RootModule = 'FabricTools.psm1' # Version number of this module. ModuleVersion = '0.21.0' # Supported PSEditions # CompatiblePSEditions = @() # ID used to uniquely identify this module GUID = '0ba3e49a-b47e-4beb-8434-5a34ad41ae72' # Author of this module Author = 'The FabricTools Team' # Company or vendor of this module CompanyName = 'fabrictools.io' # Copyright statement for this module Copyright = 'Copyright (c) 2025 by FabricTools Team' # Description of the functionality provided by this module Description = 'A module to be able to do more with Microsoft Fabric. It lets you pause and resume Fabric capacities. Adds functionallity previously only available with the REST API as PowerShell functions. There are also functions to make it easier to monitor usage metrics and refreshes. It also adds Fabric-friendly aliases for PowerBI functions to make it easier to use the module.' # Minimum version of the PowerShell engine required by this module PowerShellVersion = '5.1' # Name of the PowerShell host required by this module # PowerShellHostName = '' # Minimum version of the PowerShell host required by this module # PowerShellHostVersion = '' # Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only. # DotNetFrameworkVersion = '' # Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only. # ClrVersion = '' # Processor architecture (None, X86, Amd64) required by this module # ProcessorArchitecture = '' # Modules that must be imported into the global environment prior to importing this module RequiredModules = @( @{ ModuleName = 'Az.Accounts' ; ModuleVersion = '4.2.0' }, @{ ModuleName = 'MicrosoftPowerBIMgmt.Profile' ; ModuleVersion = '1.2.1111' }, @{ ModuleName = 'Az.Resources' ; ModuleVersion = '6.15.1' } ) # Assemblies that must be loaded prior to importing this module. # RequiredAssemblies = @() # Script files (.ps1) that are run in the caller's environment prior to importing this module # ScriptsToProcess = @() # Type files (.ps1xml) to be loaded when importing this module # TypesToProcess = @() # Format files (.ps1xml) to be loaded when importing this module. # FormatsToProcess = @() # Modules to import as nested modules of the module specified in RootModule/ModuleToProcess # NestedModules = @() # Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export. FunctionsToExport = @('Get-FabricCapacities','Get-FabricCapacity','Get-FabricCapacityRefreshables','Get-FabricCapacitySkus','Get-FabricCapacityState','Get-FabricCapacityTenantOverrides','Get-FabricCapacityWorkload','Resume-FabricCapacity','Suspend-FabricCapacity','Get-FabricConfig','Set-FabricConfig','Get-FabricCopyJob','Get-FabricCopyJobDefinition','New-FabricCopyJob','Remove-FabricCopyJob','Update-FabricCopyJob','Update-FabricCopyJobDefinition','Get-FabricDashboard','Get-FabricDataPipeline','New-FabricDataPipeline','Remove-FabricDataPipeline','Update-FabricDataPipeline','Get-FabricDatamart','Add-FabricDomainWorkspaceAssignmentByCapacity','Add-FabricDomainWorkspaceAssignmentById','Add-FabricDomainWorkspaceAssignmentByPrincipal','Add-FabricDomainWorkspaceRoleAssignment','Get-FabricDomain','Get-FabricDomainWorkspace','New-FabricDomain','Remove-FabricDomain','Remove-FabricDomainWorkspaceAssignment','Remove-FabricDomainWorkspaceRoleAssignment','Update-FabricDomain','Get-FabricEnvironment','Get-FabricEnvironmentLibrary','Get-FabricEnvironmentSparkCompute','Get-FabricEnvironmentStagingLibrary','Get-FabricEnvironmentStagingSparkCompute','Import-FabricEnvironmentStagingLibrary','New-FabricEnvironment','Publish-FabricEnvironment','Remove-FabricEnvironment','Remove-FabricEnvironmentStagingLibrary','Stop-FabricEnvironmentPublish','Update-FabricEnvironment','Update-FabricEnvironmentStagingSparkCompute','Get-FabricEventhouse','Get-FabricEventhouseDefinition','New-FabricEventhouse','Remove-FabricEventhouse','Update-FabricEventhouse','Update-FabricEventhouseDefinition','Get-FabricEventstream','Get-FabricEventstreamDefinition','New-FabricEventstream','Remove-FabricEventstream','Update-FabricEventstream','Update-FabricEventstreamDefinition','Get-FabricExternalDataShares','Revoke-FabricExternalDataShares','Export-FabricItem','Get-FabricItem','Import-FabricItem','Remove-FabricItem','Get-FabricKQLDashboard','Get-FabricKQLDashboardDefinition','New-FabricKQLDashboard','Remove-FabricKQLDashboard','Update-FabricKQLDashboard','Update-FabricKQLDashboardDefinition','Get-FabricKQLDatabase','Get-FabricKQLDatabaseDefinition','New-FabricKQLDatabase','Remove-FabricKQLDatabase','Update-FabricKQLDatabase','Update-FabricKQLDatabaseDefinition','Get-FabricKQLQueryset','Get-FabricKQLQuerysetDefinition','Invoke-FabricKQLCommand','New-FabricKQLQueryset','Remove-FabricKQLQueryset','Update-FabricKQLQueryset','Update-FabricKQLQuerysetDefinition','Get-FabricLakehouse','Get-FabricLakehouseTable','New-FabricLakehouse','Remove-FabricLakehouse','Start-FabricLakehouseTableMaintenance','Update-FabricLakehouse','Write-FabricLakehouseTableData','Get-FabricMirroredDatabase','Get-FabricMirroredDatabaseDefinition','Get-FabricMirroredDatabaseStatus','Get-FabricMirroredDatabaseTableStatus','New-FabricMirroredDatabase','Remove-FabricMirroredDatabase','Start-FabricMirroredDatabaseMirroring','Stop-FabricMirroredDatabaseMirroring','Update-FabricMirroredDatabase','Update-FabricMirroredDatabaseDefinition','Get-FabricMirroredWarehouse','Get-FabricMLExperiment','New-FabricMLExperiment','Remove-FabricMLExperiment','Update-FabricMLExperiment','Get-FabricMLModel','New-FabricMLModel','Remove-FabricMLModel','Update-FabricMLModel','Get-FabricNotebook','Get-FabricNotebookDefinition','New-FabricNotebook','New-FabricNotebookNEW','Remove-FabricNotebook','Update-FabricNotebook','Update-FabricNotebookDefinition','Get-FabricPaginatedReport','Update-FabricPaginatedReport','Get-FabricReflex','Get-FabricReflexDefinition','New-FabricReflex','Remove-FabricReflex','Update-FabricReflex','Update-FabricReflexDefinition','Get-FabricReport','Get-FabricReportDefinition','New-FabricReport','Remove-FabricReport','Update-FabricReport','Update-FabricReportDefinition','Get-FabricRecoveryPoint','New-FabricRecoveryPoint','Remove-FabricRecoveryPoint','Restore-FabricRecoveryPoint','Get-FabricSemanticModel','Get-FabricSemanticModelDefinition','New-FabricSemanticModel','Remove-FabricSemanticModel','Update-FabricSemanticModel','Update-FabricSemanticModelDefinition','Get-FabricSparkCustomPool','Get-FabricSparkSettings','New-FabricSparkCustomPool','Remove-FabricSparkCustomPool','Update-FabricSparkCustomPool','Update-FabricSparkSettings','Get-FabricSparkJobDefinition','Get-FabricSparkJobDefinitionDefinition','New-FabricSparkJobDefinition','Remove-FabricSparkJobDefinition','Start-FabricSparkJobDefinitionOnDemand','Update-FabricSparkJobDefinition','Update-FabricSparkJobDefinitionDefinition','Get-FabricSQLDatabase','New-FabricSQLDatabase','Remove-FabricSQLDatabase','Get-FabricSQLEndpoint','Get-FabricCapacityTenantSettingOverrides','Get-FabricDomainTenantSettingOverrides','Get-FabricTenantSetting','Get-FabricWorkspaceTenantSettingOverrides','Revoke-FabricCapacityTenantSettingOverrides','Update-FabricCapacityTenantSettingOverrides','Update-FabricTenantSetting','Get-FabricUserListAccessEntities','Convert-FromBase64','Convert-ToBase64','Get-FabricLongRunningOperation','Get-FabricLongRunningOperationResult','Invoke-FabricAPIRequest_duplicate','Set-FabricApiHeaders','Test-FabricApiResponse','Get-FabricWarehouse','New-FabricWarehouse','Remove-FabricWarehouse','Update-FabricWarehouse','Add-FabricWorkspaceCapacityAssignment','Add-FabricWorkspaceIdentity','Add-FabricWorkspaceRoleAssignment','Get-FabricWorkspace','Get-FabricWorkspaceDatasetRefreshes','Get-FabricWorkspaceRoleAssignment','Get-FabricWorkspaceUsageMetricsData','Get-FabricWorkspaceUsers','New-FabricWorkspace','New-FabricWorkspaceUsageMetricsReport','Register-FabricWorkspaceToCapacity','Remove-FabricWorkspace','Remove-FabricWorkspaceCapacityAssignment','Remove-FabricWorkspaceIdentity','Remove-FabricWorkspaceRoleAssignment','Unregister-FabricWorkspaceToCapacity','Update-FabricWorkspace','Update-FabricWorkspaceRoleAssignment','Confirm-FabricAuthToken','Connect-FabricAccount','Get-AllFabricDatasetRefreshes','Get-FabricAPIClusterURI','Get-FabricAuthToken','Get-FabricConnection','Get-FabricDatasetRefreshes','Get-FabricDebugInfo','Get-FabricUsageMetricsQuery','Get-SHA256','Invoke-FabricAPIRequest','Invoke-FabricDatasetRefresh','Set-FabricAuthToken') # Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export. CmdletsToExport = @() # Variables to export from this module VariablesToExport = @() # Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export. AliasesToExport = @('Get-FabCapacityRefreshables','Get-FabCapacityState','Get-FabCapacityTenantOverrides','Get-FabCapacityWorkload','Resume-FabCapacity','Suspend-PowerBICapacity','Suspend-FabCapacity','Assign-FabricDomainWorkspaceByCapacity','Assign-FabricDomainWorkspaceById','Assign-FabricDomainWorkspaceByPrincipal','Assign-FabricDomainWorkspaceRoleAssignment','Unassign-FabricDomainWorkspace','Unassign-FabricDomainWorkspaceRoleAssignment','Upload-FabricEnvironmentStagingLibrary','Get-FabAPIClusterURI','Get-FabAuthToken','Get-FabDatasetRefreshes','Get-FabUsageMetricsQuery','Invoke-FabDatasetRefresh','Export-FabItem','Import-FabricLakehouseTableData','Assign-FabricWorkspaceCapacity','Get-FabWorkspaceDatasetRefreshes','Get-FabWorkspaceUsageMetricsData','Get-FabWorkspaceUsers','New-FabWorkspaceUsageMetricsReport','Register-FabWorkspaceToCapacity','Unassign-FabricWorkspaceCapacity','Unregister-FabWorkspaceToCapacity') # DSC resources to export from this module DscResourcesToExport = @() # List of all modules packaged with this module # ModuleList = @() # List of all files packaged with this module # FileList = @() # Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell. PrivateData = @{ PSData = @{ # Tags applied to this module. These help with module discovery in online galleries. # Tags = @() # A URL to the license for this module. # LicenseUri = '' # A URL to the main website for this project. # ProjectUri = '' # A URL to an icon representing this module. # IconUri = '' # ReleaseNotes of this module ReleaseNotes = '## [0.21.0] - 2025-05-26 ### Added - Introduced new PowerShell functions for managing Fabric workspaces, recovery points, configurations, tenant settings, and workspace identities. - Added unit tests for key functions, including `Get-FabricAPIclusterURI` and `Get-FabricCapacityTenantOverrides`. - Added standard tests for each function and enhanced Help tests to filter by exported commands. - Added OutputType attributes to several functions for improved type safety. - Added support for WhatIf and Confirm parameters to update and revoke functions. - Added Contributor Covenant Code of Conduct and enhanced contributing guidelines. - Added commit message guidelines for contributors using GitHub Copilot. ### Changed - Refactored `Get-FabricAPIClusterURI` to use `Invoke-FabricRestApi` for improved consistency. - Updated validation pattern for `WorkspaceName` to allow additional special characters, then removed the pattern for greater flexibility. - Improved documentation for many functions, especially around parameters like `WorkspaceId`. - Refactored multiple functions for clarity, consistency, and maintainability. - Enhanced error handling and confirmation prompts (ShouldProcess) for potentially destructive actions. - Updated module manifest and build/test workflows for better automation and deployment. - Improved code formatting using the dbatools formatter. ### Fixed - Fixed issues with `New-FabricDataPipeline` and its call to `Invoke-FabricAPIRequest`. - Fixed capital letter handling in test automation. - Fixed ResourceUrl for token retrieval in `Connect-FabricAccount`. - Fixed bugs in `New-FabricEventhouse` and improved ShouldProcess logic. - Fixed parameter naming and example formatting in several functions. ### Deprecated - None. ### Removed - Removed unnecessary or duplicate functions (e.g., `Get-AllFabricDatasetRefreshes`, `Get-AllFabricCapacities`). - Removed obsolete scripts and commented-out configuration paths. ### Security - None. --- **Contributors:** Rob Sewell, Jess Pomfret, Ioana Bouariu, Frank Geisler, Kamil Nowinski, and others. **Note:** For a full list of changes and details, please see the commit history. ### Added ### Security - In case of vulnerabilities. ' # Prerelease string of this module Prerelease = '' # Flag to indicate whether the module requires explicit user acceptance for install/update/save # RequireLicenseAcceptance = $false # External dependent modules of this module # ExternalModuleDependencies = @() } # End of PSData hashtable } # End of PrivateData hashtable # HelpInfo URI of this module # HelpInfoURI = '' # Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix. # DefaultCommandPrefix = '' } |