| document type | module |
|---|---|
| Help Version | 1.0.0.0 |
| HelpInfoUri | https://www.github.com/dataplat/FabricTools |
| Locale | en-US |
| Module Guid | f2a0f9e6-fab6-41fc-9e1c-0c94ff38f794 |
| Module Name | FabricTools |
| ms.date | 04/08/2026 |
| PlatyPS schema version | 2024-05-01 |
| title | FabricTools Module |
A module to be able to do more with Microsoft Fabric. It lets you pause and resume Fabric capacities. Adds functionality 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.
Assigns workspaces to a Fabric domain based on specified capacities.
Assigns workspaces to a specified domain in Microsoft Fabric by their IDs.
Assigns workspaces to a domain based on principal IDs in Microsoft Fabric.
Bulk assigns roles to principals for workspaces in a Fabric domain.
Assigns a Fabric workspace to a specified capacity.
Provisions an identity for a Fabric workspace.
Assigns a role to a principal for a specified Fabric workspace.
Assigns a workspace to a deployment pipeline stage.
Connects to the Fabric WebAPI.
Decodes a Base64-encoded string into its original text representation.
Encodes the content of a file into a Base64-encoded string.
Exports items from a Fabric workspace. Either all items in a workspace or a specific item.
Retrieves the cluster URI for the tenant.
Retrieves the Fabric API authentication token.
This function retrieves all resources of type "Microsoft.Fabric/capacities" from all resource groups in a given subscription or all subscriptions if no subscription ID is provided.
Retrieves capacity details from a specified Microsoft Fabric workspace.
Returns a list of refreshables for all capacities that the user has access to.
Retrieves the fabric capacity information.
Retrieves the state of a specific capacity.
Retrieves the tenant overrides for all capacities.
Retrieves tenant setting overrides for a specific capacity or all capacities in the Fabric tenant.
Retrieves the workloads for a specific capacity.
Gets the configuration for use with all functions in the FabricTools module.
Retrieves Fabric connections.
Retrieves CopyJob details from a specified Microsoft Fabric workspace.
Retrieves the definition of a Copy Job from a specific workspace in Microsoft Fabric.
Retrieves dashboards from a specified workspace.
Retrieves datamarts from a specified workspace.
Retrieves data pipelines from a specified Microsoft Fabric workspace.
Retrieves one or more Power BI datasets from My Workspace or a specific workspace.
Retrieves the refresh history of a specified dataset in a PowerBI workspace.
Retrieves the refresh history of a Power BI dataset.
Shows internal debug information about the current Azure & Fabric sessions & Fabric config.
Retrieves deployment pipeline(s) from Microsoft Fabric.
Retrieves details of a specific deployment pipeline operation.
Returns a list of deployment pipeline role assignments.
Retrieves details of deployment pipeline stages.
Retrieves the supported items from the workspace assigned to a specific stage of a deployment pipeline.
Retrieves domain information from Microsoft Fabric, optionally filtering by domain ID, domain name, or only non-empty domains.
Retrieves tenant setting overrides for a specific domain or all capacities in the Fabric tenant.
Retrieves the workspaces associated with a specific domain in Microsoft Fabric.
Retrieves an environment or a list of environments from a specified workspace in Microsoft Fabric.
Retrieves the list of libraries associated with a specific environment in a Microsoft Fabric workspace.
Retrieves the Spark compute details for a specific environment in a Microsoft Fabric workspace.
Retrieves the staging library details for a specific environment in a Microsoft Fabric workspace.
Retrieves staging Spark compute details for a specific environment in a Microsoft Fabric workspace.
Retrieves Fabric Eventhouses
Retrieves the definition of an Eventhouse from a specified Microsoft Fabric workspace.
Retrieves an Eventstream or a list of Eventstreams from a specified workspace in Microsoft Fabric.
Retrieves the definition of a Eventstream from a specific workspace in Microsoft Fabric.
Retrieves External Data Shares details from a specified Microsoft Fabric.
Retrieves fabric items from a workspace.
Retrieves an KQLDashboard or a list of KQLDashboards from a specified workspace in Microsoft Fabric.
Retrieves the definition of a KQLDashboard from a specific workspace in Microsoft Fabric.
Retrieves an KQLDatabase or a list of KQLDatabases from a specified workspace in Microsoft Fabric.
Retrieves the definition of a KQLDatabase from a specific workspace in Microsoft Fabric.
Retrieves an KQLQueryset or a list of KQLQuerysets from a specified workspace in Microsoft Fabric.
Retrieves the definition of a KQLQueryset from a specific workspace in Microsoft Fabric.
Retrieves an Lakehouse or a list of Lakehouses from a specified workspace in Microsoft Fabric.
Retrieves tables from a specified Lakehouse in a Fabric workspace.
Monitors the status of a long-running operation in Microsoft Fabric.
Retrieves the result of a completed long-running operation from the Microsoft Fabric API.
Retrieves an MirroredDatabase or a list of MirroredDatabases from a specified workspace in Microsoft Fabric.
Retrieves the definition of a MirroredDatabase from a specific workspace in Microsoft Fabric.
Retrieves the status of a mirrored database in a specified workspace.
Retrieves the status of tables in a mirrored database.
Retrieves an MirroredWarehouse or a list of MirroredWarehouses from a specified workspace in Microsoft Fabric.
Retrieves ML Experiment details from a specified Microsoft Fabric workspace.
Retrieves ML Model details from a specified Microsoft Fabric workspace.
Retrieves an Notebook or a list of Notebooks from a specified workspace in Microsoft Fabric.
Retrieves the definition of a notebook from a specific workspace in Microsoft Fabric.
Retrieves paginated report details from a specified Microsoft Fabric workspace.
Retrieves Reflex details from a specified Microsoft Fabric workspace.
Retrieves the definition of an Reflex from a specified Microsoft Fabric workspace.
Retrieves Report details from a specified Microsoft Fabric workspace.
Retrieves the definition of an Report from a specified Microsoft Fabric workspace.
Retrieves SemanticModel details from a specified Microsoft Fabric workspace.
Retrieves the definition of an SemanticModel from a specified Microsoft Fabric workspace.
Retrieves Spark custom pools from a specified workspace.
Retrieves Spark Job Definition details from a specified Microsoft Fabric workspace.
Retrieves the definition of an SparkJobDefinition from a specified Microsoft Fabric workspace.
Retrieves Spark settings from a specified Microsoft Fabric workspace.
Retrieves Fabric SQL Database details.
Retrieves SQL Endpoints from a specified workspace in Fabric.
Retrieves tenant settings from the Fabric environment.
Retrieves usage metrics for a specific dataset.
Retrieves access entities for a specified user in Microsoft Fabric.
Retrieves warehouse details from a specified Microsoft Fabric workspace.
Retrieves details of a Microsoft Fabric workspace by its ID or name.
Retrieves the refresh history of all datasets in a specified PowerBI workspace.
Retrieves role assignments for a specified Fabric workspace.
Retrieves tenant setting overrides for all workspaces in the Fabric tenant.
Retrieves workspace usage metrics data.
Retrieves the user(s) of a workspace.
Uploads a library to the staging environment in a Microsoft Fabric workspace.
Imports items using the Power BI Project format (PBIP) into a Fabric workspace from a specified file system source.
Triggers a refresh of a Power BI dataset.
Executes a KQL command in a Kusto Database.
Sends an HTTP request to a Fabric or Power BI API endpoint and retrieve the response.
Creates a new copy job in a specified Microsoft Fabric workspace.
Creates a new DataPipeline in a specified Microsoft Fabric workspace.
Creates a new deployment pipeline.
Creates a new Fabric domain.
Creates a new environment in a specified workspace.
Creates a new Eventhouse in a specified Microsoft Fabric workspace.
Creates a new Eventstream in a specified Microsoft Fabric workspace.
Creates a new KQLDashboard in a specified Microsoft Fabric workspace.
Creates a new KQLDatabase in a specified Microsoft Fabric workspace.
Creates a new KQLQueryset in a specified Microsoft Fabric workspace.
Creates a new Lakehouse in a specified Microsoft Fabric workspace.
Creates a new MirroredDatabase in a specified Microsoft Fabric workspace.
Creates a new ML Experiment in a specified Microsoft Fabric workspace.
Creates a new ML Model in a specified Microsoft Fabric workspace.
Creates a new notebook in a specified Microsoft Fabric workspace.
Creates a new Reflex in a specified Microsoft Fabric workspace.
Creates a new Report in a specified Microsoft Fabric workspace.
Creates a new SemanticModel in a specified Microsoft Fabric workspace.
Creates a new Spark custom pool in a specified Microsoft Fabric workspace.
Creates a new SparkJobDefinition in a specified Microsoft Fabric workspace.
Creates a new SQL Database in a specified Microsoft Fabric workspace.
Creates a new warehouse in a specified Microsoft Fabric workspace.
Creates a new Fabric workspace with the specified display name.
Retrieves the workspace usage metrics dataset ID.
Publishes a staging environment in a specified Microsoft Fabric workspace.
Deletes a Copy Job from a specified Microsoft Fabric workspace.
Removes a DataPipeline from a specified Microsoft Fabric workspace.
Deletes a specified deployment pipeline.
Deletes a Fabric domain by its ID.
Unassign workspaces from a specified Fabric domain.
Bulk unassign roles to principals for workspaces in a Fabric domain.
Deletes an environment from a specified workspace in Microsoft Fabric.
Deletes a specified library from the staging environment in a Microsoft Fabric workspace.
Removes an Eventhouse from a specified Microsoft Fabric workspace.
Deletes an Eventstream from a specified workspace in Microsoft Fabric.
Removes selected items from a Fabric workspace.
Deletes an KQLDashboard from a specified workspace in Microsoft Fabric.
Deletes an KQLDatabase from a specified workspace in Microsoft Fabric.
Deletes an KQLQueryset from a specified workspace in Microsoft Fabric.
Deletes an Lakehouse from a specified workspace in Microsoft Fabric.
Deletes an MirroredDatabase from a specified workspace in Microsoft Fabric.
Removes an ML Experiment from a specified Microsoft Fabric workspace.
Removes an ML Model from a specified Microsoft Fabric workspace.
Deletes an Notebook from a specified workspace in Microsoft Fabric.
Removes an Reflex from a specified Microsoft Fabric workspace.
Removes an Report from a specified Microsoft Fabric workspace.
Removes an SemanticModel from a specified Microsoft Fabric workspace.
Removes a Spark custom pool from a specified Microsoft Fabric workspace.
Removes an SparkJobDefinition from a specified Microsoft Fabric workspace.
Deletes a SQL Database from a specified workspace in Microsoft Fabric.
Removes a warehouse from a specified Microsoft Fabric workspace.
Deletes an existing Fabric workspace by its workspace ID.
Unassigns a Fabric workspace from its capacity.
Removes a workspace from a deployment pipeline stage.
Deprovisions the Managed Identity for a specified Fabric workspace.
Removes a role assignment from a Fabric workspace.
Resumes a capacity.
Removes a tenant setting override from a specific capacity in the Fabric tenant.
Retrieves External Data Shares details from a specified Microsoft Fabric.
Deploys items from one stage to another in a deployment pipeline.
Initiates a table maintenance job for a specified Lakehouse in a Fabric workspace.
Starts the mirroring of a specified mirrored database in a given workspace.
Starts a Fabric Spark Job Definition on demand.
Cancels the publish operation for a specified environment in Microsoft Fabric.
Stops the mirroring of a specified mirrored database in a given workspace.
Suspends a capacity.
Creates or updates a Microsoft Fabric capacity.
Updates tenant setting overrides for a specified capacity ID.
Updates an existing Copy Job in a specified Microsoft Fabric workspace.
Updates the definition of a Copy Job in a Microsoft Fabric workspace.
Updates an existing DataPipeline in a specified Microsoft Fabric workspace.
Updates a Fabric domain by its ID.
Updates the properties of a Fabric Environment.
Updates the Spark compute configuration in the staging environment for a given workspace.
Updates an existing Eventhouse in a specified Microsoft Fabric workspace.
Updates the definition of an existing Eventhouse in a specified Microsoft Fabric workspace.
Updates the properties of a Fabric Eventstream.
Updates the definition of a Eventstream in a Microsoft Fabric workspace.
Updates the properties of a Fabric KQLDashboard.
Updates the definition of a KQLDashboard in a Microsoft Fabric workspace.
Updates the properties of a Fabric KQLDatabase.
Updates the definition of a KQLDatabase in a Microsoft Fabric workspace.
Updates the properties of a Fabric KQLQueryset.
Updates the definition of a KQLQueryset in a Microsoft Fabric workspace.
Updates the properties of a Fabric Lakehouse.
Updates the properties of a Fabric MirroredDatabase.
Updates the definition of a MirroredDatabase in a Microsoft Fabric workspace.
Updates an existing ML Experiment in a specified Microsoft Fabric workspace.
Updates an existing ML Model in a specified Microsoft Fabric workspace.
Updates the properties of a Fabric Notebook.
Updates the definition of a notebook in a Microsoft Fabric workspace.
Updates an existing paginated report in a specified Microsoft Fabric workspace.
Updates an existing Reflex in a specified Microsoft Fabric workspace.
Updates the definition of an existing Reflex in a specified Microsoft Fabric workspace.
Updates an existing Report in a specified Microsoft Fabric workspace.
Updates the definition of an existing Report in a specified Microsoft Fabric workspace.
Updates an existing SemanticModel in a specified Microsoft Fabric workspace.
Updates the definition of an existing SemanticModel in a specified Microsoft Fabric workspace.
Updates an existing Spark custom pool in a specified Microsoft Fabric workspace.
Updates an existing SparkJobDefinition in a specified Microsoft Fabric workspace.
Updates the definition of an existing SparkJobDefinition in a specified Microsoft Fabric workspace.
Updates an existing Spark custom pool in a specified Microsoft Fabric workspace.
Updates an existing warehouse in a specified Microsoft Fabric workspace.
Updates the properties of a Fabric workspace.
Updates the role assignment for a specific principal in a Fabric workspace.
Loads data into a specified table in a Lakehouse within a Fabric workspace.