Functions/Get-FabricWorkspaceUsageMetricsData.ps1
|
<#
.SYNOPSIS Retrieves workspace usage metrics data. .DESCRIPTION The Get-FabricWorkspaceUsageMetricsData function retrieves workspace usage metrics. It supports multiple aliases for flexibility. .PARAMETER workspaceId The ID of the workspace. This is a mandatory parameter. .PARAMETER username The username. This is a mandatory parameter. .EXAMPLE Get-FabricWorkspaceUsageMetricsData -workspaceId "your-workspace-id" -username "your-username" This example retrieves the workspace usage metrics for a specific workspace given the workspace ID and username. .NOTES The function retrieves the PowerBI access token and creates a new usage metrics report. It then defines the names of the reports to retrieve, initializes an empty hashtable to store the reports, and for each report name, retrieves the report and adds it to the hashtable. It then returns the hashtable of reports. #> # This function retrieves workspace usage metrics. function Get-FabricWorkspaceUsageMetricsData { # Define aliases for the function for flexibility. [Alias("Get-FabWorkspaceUsageMetricsData")] # Define parameters for the workspace ID and username. param( [Parameter(Mandatory = $true)] [string]$workspaceId, [Parameter(Mandatory = $false)] [string]$username = "" ) # Create a new workspace usage metrics dataset. $datasetId = New-FabWorkspaceUsageMetricsReport -workspaceId $workspaceId # Define the names of the reports to retrieve. $reportnames = @("'Workspace views'", "'Report pages'", "Users", "Reports", "'Report views'", "'Report page views'", "'Report load times'") # Initialize an empty hashtable to store the reports. $reports = @{} # For each report name, retrieve the report and add it to the hashtable. if ($username -eq "") { foreach ($reportname in $reportnames) { $report = Get-FabricUsagemetricsQuery -DatasetID $datasetId -groupId $workspaceId -reportname $reportname $reports += @{ $reportname.replace("'", "") = $report } } } else { foreach ($reportname in $reportnames) { $report = Get-FabricUsagemetricsQuery -DatasetID $datasetId -groupId $workspaceId -reportname $reportname -ImpersonatedUser $username $reports += @{ $reportname.replace("'", "") = $report } } } # Return the hashtable of reports. return $reports } |