microsoft / microsoft/finops-toolkit
[PowerShell] Get-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 discover what Power BI reports are available in order to download them
💎 Solution
Create a Get-FinOpsHubReport command to get a list of available FinOps hub reports.
Synopsis
Gets details about Power BI reports available for FinOps hubs.
Syntax
Get-FinOpsHubReport `
[-Name] <string> `
[[-Version] <string>] `
[-Preview]
Description
The Get-FinOpsHubReport command gets a list of Power BI reports that are available for FinOps hubs.
Parameters
| Parameter | Description |
|---|---|
-Name |
Optional. Name of the Power BI report to get details about. Default = "*". |
| -Version | Optional. FinOps hub version to get reports for. Default = "latest". |
| -Preview | Optional. Indicates whether to include preview releases when -Version is "latest". Ignored when a specific version is specified. Default = false. |
ℹ️ Additional info
Use Get-FinOpsToolkitVersion to get the release details. Refer to the Releases API for more details about what's available in case details are getting trimmed today. PBIX files are saved there. Return a list of reports with the following properties:
- Name (e.g., "CostSummary")
- FileName (e.g., "CostSummary.pbix")
- FileSize
- DownloadUrl
- DocumentationUrl (e.g., "https://aka.ms/finops/toolkit/costsummary")
- ReleaseName
- ReleaseVersion
- ReleaseUrl
- DownloadCount
- PublishDate
- UpdateDate
🙋♀️ Ask for the community
We could use your help:
- Please vote this issue up (👍) to prioritize it.
- Are there any other properties you expect to see per report?
- 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 Get-FinOpsToolkitVersion and the Releases API linked in the issue to understand release and PBIX metadata. Define the Name, Version, and Preview behavior, then verify the command returns the listed report properties, including download and release details, for the applicable FinOps hub version.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- powershell
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100