microsoft / microsoft/finops-toolkit
[PowerShell][Hubs] Get-FinOpsHubDiagnosticInfo
Nobody has claimed this yet.
- Dominant language
- PowerShell
- Stars
- 603
- Forks
- 248
- Avg merge
- 7d 11h
- Merged PRs (30d)
- 11
Description
📝 Scenario
As a FinOps hub admin, I need to identify the source of any errors in order to troubleshoot and resolve issues
💎 Solution
Create a Get-FinOpsHubDiagnosticInfo command to capture details about the current deployment, identify problems, and recommend solutions to those problems.
Synopsis
Gets details about the current FinOps hub instance, identifies potential issues, and recommends solutions.
Syntax
Get-FinOpsHubDiagnosticInfo `
[-Name] <string> `
[-ResourceGroupName <string>] `
[<CommonParameters>]
Description
The Get-FinOpsHubDiagnosticInfo command gets details about the current FinOps hub instance to facilitate troubleshooting and resolving issues. This command is commonly used to identify and resolve common issues or for collecting details to share with Microsoft Support.
Parameters
| Parameter | Description |
|---|---|
-Name |
Required. Name of the FinOps hub instance. |
| -ResourceGroup | Optional. Name of the resource group the FinOps hub was deployed to. |
ℹ️ Additional context
Show the following details:
- Subscription ID
- Resource group name
- Hub name
- Storage account name
- ADX cluster name with region (e.g., "my-cluster.brazilsouth")
- ADX SKU
- ADF name
- Version (ftk-version tag + config/settings.json) -- confirm they're the same
- Configured managed exports (count and list of scope IDs)
- Data retention settings
- Is a remote hub configured?
- Is private access enabled?
- Is infrastructure encryption enabled?
🙋♀️ Ask for the community
We could use your help:
- Please vote this issue up (👍) to prioritize it.
- 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 locating the existing PowerShell hub commands and reading the deployment's config/settings.json. Compare the ftk-version tag with the configured version and trace how hub resources and settings are exposed. Done means Get-FinOpsHubDiagnosticInfo reports the listed deployment, configuration, security, retention, export, and version details, including any identified problems and recommendations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- azure, powershell
- Domain
- cli, cloud
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100