microsoft / microsoft/finops-toolkit
[PowerShell] Publish-FinOpsHubReport
Nobody has claimed this yet.
- Dominant language
- PowerShell
- Stars
- 603
- Forks
- 248
- Avg merge
- 7d 11h
- Merged PRs (30d)
- 11
Description
📝 Scenario
As a hub admin, I need to publish a Power BI report in order to make it available to all stakeholders
💎 Solution
Create a Publish-FinOpsHubReport command that downloads FinOps hub reports, publishes them to the Power BI service, and optionally connects them to a hub instance.
⛔ Blocked
- See #250
Synopsis
Publishes a report to the Power BI service and optionally connects it to a FinOps hub instance.
Syntax
Publish-FinOpsHubReport `
[-Name] <string> `
[-HubName <string>] `
[-ResourceGroupName <string>] `
[-Version <string>] `
[-Preview]
Description
The Publish-FinOpsHubReport command publishes a report to the Power BI service. If the -Name is a file path to a PBIX file, that custom report will be published. If the -Name references a FinOps hub report name, the report will be downloaded and published. If a hub instance is specified either via -HubName or -ResourceGroupName, the report will be connected to that hub instance. If a hub instance is not specified, the report will contain sample data.
Parameters
| Parameter | Description |
|---|---|
-Name |
Required. Name of the Power BI report or a path to a custom PBIX file to publish. |
-HubName |
Optional. Name of the hub instance to connect to. Default = none. |
-ResourceGroupName |
Optional. Name of the resource group the FinOps hub is deployed to. |
| -Version | Optional. Version to download. Default = Hub instance version or "latest", if not specified. |
| -Preview | Optional. Indicates whether to include preview releases when -Version is "latest". Ignored when a specific version is specified. Default = false. |
ℹ️ Additional info
Use the Download-FinOpsHubReport to get the download the report. Use the version of the hub instance when downloading a specific version. If not specified, use the latest version.
We should be able to use New-PowerBIReport to publish the report.
We might be able to update the query parameters via the Set-PowerBIDataset command. We need to confirm.
🙋♀️ Ask for the community
We could use your help:
- Please vote this issue up (👍) to prioritize it.
- Are there any parameters that are missing?
- Leave comments to help us solidify the vision.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the blocker in #250 and the Publish-FinOpsHubReport entry point described here. Check how Download-FinOpsHubReport provides reports and investigate New-PowerBIReport and Set-PowerBIDataset. Done means publishing local or downloaded reports, optionally connecting them to the specified hub, and handling version and preview parameters.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- azure, powershell
- Domain
- analytics, cloud
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100