MicrosoftFabricMgmt

1.0.0

PowerShell module for managing Microsoft Fabric resources via the Fabric API. Supports workspaces, lakehouses, warehouses, notebooks, and more.

Minimum PowerShell version

5.1

Installation Options

Copy and Paste the following command to install this package using PowerShellGet More Info

Install-Module -Name MicrosoftFabricMgmt -RequiredVersion 1.0.0

Copy and Paste the following command to install this package using Microsoft.PowerShell.PSResourceGet More Info

Install-PSResource -Name MicrosoftFabricMgmt -Version 1.0.0

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deploy all the dependencies to Azure Automation. Learn More

Manually download the .nupkg file to your system's default download location. Note that the file won't be unpacked, and won't include any dependencies. Learn More

Owners

Copyright

2025 Microsoft Fabric Mgmt by Fabric Toolbox

Package Details

Author(s)

  • Rob Sewell Jess Pomfret and Tiago Balabuch on behalf of the community

Functions

Get-FabricApacheAirflowJob Get-FabricApacheAirflowJobDefinition New-FabricApacheAirflowJob Remove-FabricApacheAirflowJob Update-FabricApacheAirflowJob Update-FabricApacheAirflowJobDefinition Get-FabricCapacity Add-FabricConnectionRoleAssignment Get-FabricConnection Get-FabricConnectionSupportedType Remove-FabricConnection Remove-FabricConnectionRoleAssignment Update-FabricConnectionRoleAssignment 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-FabricDomainWorkspaceByCapacity Add-FabricDomainWorkspaceById Add-FabricDomainWorkspaceByPrincipal Add-FabricDomainWorkspaceByRoleAssignment Get-FabricDomain Get-FabricDomainWorkspace New-FabricDomain Remove-FabricDomain Remove-FabricDomainWorkspace 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 Get-FabricEventstreamDestination Get-FabricEventstreamDestinationConnection Get-FabricEventstreamSource Get-FabricEventstreamSourceConnection Get-FabricEventstreamTopology New-FabricEventstream Remove-FabricEventstream Resume-FabricEventstream Resume-FabricEventstreamDestination Resume-FabricEventstreamSource Suspend-FabricEventstream Suspend-FabricEventstreamDestination Suspend-FabricEventstreamSource Update-FabricEventstream Update-FabricEventstreamDefinition Get-FabricExternalDataShare Revoke-FabricExternalDataShare Get-FabricFolder Move-FabricFolder New-FabricFolder Remove-FabricFolder Update-FabricFolder Get-FabricGraphQLApi Get-FabricGraphQLApiDefinition New-FabricGraphQLApi Remove-FabricGraphQLApi Update-FabricGraphQLApi Update-FabricGraphQLApiDefinition 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 New-FabricKQLQueryset Remove-FabricKQLQueryset Update-FabricKQLQueryset Update-FabricKQLQuerysetDefinition Remove-FabricLabel Set-FabricLabel Get-FabricLakehouse Get-FabricLakehouseLivySession Get-FabricLakehouseTable New-FabricLakehouse Remove-FabricLakehouse Start-FabricLakehouseRefreshMaterializedLakeView Start-FabricLakehouseTableMaintenance Update-FabricLakehouse Write-FabricLakehouseTableData Get-FabricManagedPrivateEndpoint New-FabricManagedPrivateEndpoint Remove-FabricManagedPrivateEndpoint 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-FabricMountedDataFactory Get-FabricMountedDataFactoryDefinition New-FabricMountedDataFactory Remove-FabricMountedDataFactory Update-FabricMountedDataFactory Update-FabricMountedDataFactoryDefinition Get-FabricNotebook Get-FabricNotebookDefinition Get-FabricNotebookLivySession New-FabricNotebook New-FabricNotebookNEW Remove-FabricNotebook Update-FabricNotebook Update-FabricNotebookDefinition Get-FabricOneLakeDataAccessSecurity Get-FabricOneLakeShortcut New-FabricOneLakeShortcut Remove-FabricOneLakeShortcut Reset-FabricOneLakeShortcutCache Set-FabricOneLakeDataAccessSecurity 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-FabricSemanticModel Get-FabricSemanticModelDefinition New-FabricSemanticModel Remove-FabricSemanticModel Update-FabricSemanticModel Update-FabricSemanticModelDefinition Remove-FabricSharingLinks Remove-FabricSharingLinksBulk Get-FabricSparkCustomPool Get-FabricSparkLivySession Get-FabricSparkSettings Get-FabricSparkWorkspaceSettings New-FabricSparkCustomPool Remove-FabricSparkCustomPool Update-FabricSparkCustomPool Update-FabricSparkSettings Update-FabricSparkWorkspaceSettings Get-FabricSparkJobDefinition Get-FabricSparkJobDefinitionDefinition Get-FabricSparkJobDefinitionLivySession New-FabricSparkJobDefinition Remove-FabricSparkJobDefinition Start-FabricSparkJobDefinitionOnDemand Update-FabricSparkJobDefinition Update-FabricSparkJobDefinitionDefinition Get-FabricSQLEndpoint Get-FabricSQLEndpointConnectionString Update-FabricSQLEndpointMetadata Get-FabricTag New-FabricTag Remove-FabricTag Update-FabricTag Get-FabricCapacityTenantSettingOverrides Get-FabricDomainTenantSettingOverrides Get-FabricTenantSetting Get-FabricTenantSettingOverridesCapacity Get-FabricWorkspaceTenantSettingOverrides Revoke-FabricCapacityTenantSettingOverrides Update-FabricCapacityTenantSettingOverrides Update-FabricTenantSetting Get-FabricUserListAccessEntities Convert-FromBase64 Convert-ToBase64 Get-FabricLongRunningOperation Get-FabricLongRunningOperationResult Invoke-FabricAPIRequest Set-FabricApiHeaders Get-FabricVariableLibrary Get-FabricVariableLibraryDefinition New-FabricVariableLibrary Remove-FabricVariableLibrary Update-FabricVariableLibrary Get-FabricWarehouse Get-FabricWarehouseConnectionString Get-FabricWarehouseSnapshot New-FabricWarehouse New-FabricWarehouseSnapshot Remove-FabricWarehouse Remove-FabricWarehouseSnapshot Update-FabricWarehouse Update-FabricWarehouseSnapshot Add-FabricWorkspaceCapacity Add-FabricWorkspaceIdentity Add-FabricWorkspaceRoleAssignment Get-FabricWorkspace Get-FabricWorkspaceGitConnection Get-FabricWorkspaceRoleAssignment New-FabricWorkspace Remove-FabricWorkspace Remove-FabricWorkspaceCapacity Remove-FabricWorkspaceIdentity Remove-FabricWorkspaceRoleAssignment Update-FabricWorkspace Update-FabricWorkspaceRoleAssignment

PSEditions

Desktop Core

Dependencies

Release Notes

[1.0.0] - 2026-01-07
BREAKING CHANGES
⚠️ Version 1.0.0 contains significant breaking changes. See BREAKING-CHANGES.md for detailed migration guide.

BREAKING: Removed global $FabricConfig variable - Module now uses internal state management via PSFramework with $script:FabricAuthContext
BREAKING: Removed custom Write-Message function - All logging now uses PSFrameworks Write-PSFMessage
BREAKING: Test-TokenExpired now returns boolean ($true/$false) instead of throwing exceptions for better error handling
BREAKING: PowerShell 5.1 minimum version required (supports both PowerShell 5.1 and 7+)
Added
Managed Identity Authentication: Full support for Azure Managed Identity (both system-assigned and user-assigned)
Set-FabricApiHeaders -UseManagedIdentity for system-assigned identity
Set-FabricApiHeaders -UseManagedIdentity -ClientId "..." for user-assigned identity
Automatic Token Refresh: New Test-TokenExpired -AutoRefresh capability for Managed Identity authentication
PSFramework Integration: Complete migration to PSFramework for configuration and logging
Configuration: Get-PSFConfig -Module MicrosoftFabricMgmt to view all settings
Logging: Enterprise-grade logging with multiple providers (file, event log, etc.)
New Helper Function: Invoke-TokenRefresh for automatic token renewal (Managed Identity only)
Configuration Options: New PSFramework-based configuration settings:
Api.BaseUrl: Base URL for Fabric API endpoints
Api.ResourceUrl: Azure resource URL for token acquisition
Api.TimeoutSeconds: Default timeout for API requests (30 seconds)
Api.RetryMaxAttempts: Maximum retry attempts (3)
Api.RetryBackoffMultiplier: Exponential backoff multiplier (2)
Auth.TokenRefreshThresholdSeconds: Token refresh threshold (300 seconds / 5 minutes)
Json.DefaultDepth: Default depth for JSON conversion (10)
Module Cleanup Handler: Automatic cleanup of sensitive authentication data when module is unloaded
Enhanced Documentation: Complete comment-based help updates for all authentication functions
Changed
Module Manifest: Updated to version 1.0.0 with explicit PowerShell 5.1 compatibility
Added RequiredModules
Added CompatiblePSEditions
Updated PowerShellVersion
Module Initialization (prefix.ps1): Complete rewrite with PSFramework configuration system
Initializes all module configuration on import
Creates module-scoped $script:FabricAuthContext instead of global $FabricConfig
Registers module cleanup handler for security
Displays breaking change notice on module load
Authentication (Set-FabricApiHeaders): Complete rewrite with modern PowerShell patterns
Three parameter sets: UserPrincipal, ServicePrincipal, ManagedIdentity
All code is PowerShell 5.1 compatible (uses New-Object instead of ::new())
Uses PSFramework logging (Write-PSFMessage) throughout
Updates module-scoped $script:FabricAuthContext instead of global variable
Enhanced error messages with context-specific guidance
Stores authentication method and metadata for token refresh capability
Token Validation (Test-TokenExpired): Enhanced with auto-refresh and better error handling
Returns $true (expired) or $false (valid) instead of throwing exceptions
New -AutoRefresh parameter for automatic token renewal
Proactive refresh when token < 5 minutes from expiration
Uses PSFramework logging and configuration
Checks module-scoped $script:FabricAuthContext instead of $FabricConfig
All Logging: Migrated from custom Write-Message to PSFrameworks Write-PSFMessage
Better performance and flexibility
Supports multiple logging providers
Configurable log levels and filtering
Structured logging support
Removed
Global $FabricConfig Variable: Removed entirely - use module functions instead
Custom Write-Message Function: Removed - use Write-PSFMessage from PSFramework
Exception-Based Token Validation: Test-TokenExpired no longer throws - returns boolean
Security
Improved Token Security: Module-scoped authentication context prevents accidental global variable exposure
Automatic Memory Cleanup: Secure cleanup of authentication data when module is unloaded
SecureString Handling: Proper SecureString to plain text conversion with guaranteed memory cleanup
Migration Guide
If upgrading from 0.x to 1.0.0:

Remove all $FabricConfig references from your scripts
Authentication still works the same way via Set-FabricApiHeaders
Use Get-PSFConfigValue if you need configuration values
Update any Test-TokenExpired calls to handle boolean return values
Consider migrating Azure-hosted workloads to Managed Identity authentication
See BREAKING-CHANGES.md for complete migration guide with examples.

FileList

Version History

Version Downloads Last updated
1.0.2 3 1/12/2026
1.0.1 5 1/12/2026
1.0.0 (current version) 4 1/12/2026