microsoft / microsoft/PSRule

Add option to get more output details like resourceGroup

Open
#1,625 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
C#
Stars
474
Forks
65
Avg merge
22h 25m
Merged PRs (30d)
26

Description

Is your feature request related to a problem? Please describe.

I am currently using the tool to check against different azure environments and export the results as csv. There are different options when run Invoke-PSRule, see https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputformat. It's possible to get a summary and a detailed output. The detailed output only includes the following columns RuleName, TargetName, TargetType, Outcome, OutcomeReason, Synopsis, Recommendation while the json scan includes more information such as Subscription, Resource Group, Location and so on.

The current output details are not detailed enough for me and doesn't allow to sort or filter for resource groups. That's make it hard when having many subscriptions and resource groups.

Describe the solution you'd like

I want to have an option where I can specify more output details such as resource group, subscription and location.

Describe alternatives you've considered

Alternatives can be to use suppression. But these are only allow run against different target types and not resource groups.

Additional context

I would be happy about alternatives to face the problem.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Invoke-PSRule output options and the documented outputformat behavior. Determine how detailed and CSV results are assembled, then define how an option would expose subscription, resource group, location, and other scan metadata; done means users can sort and filter those fields in the requested output.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, powershell
Domain
devops, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.