silverhack / silverhack/monkey365
Rename Instance parameter to Platform
Nobody has claimed this yet.
- Dominant language
- PowerShell
- Stars
- 1.3k
- Forks
- 140
- PR merge metrics
- No merged PRs in 30d
Description
Is your feature request related to a problem? Please describe.
The -Instance parameter was introduced when Monkey365 only supported a limited number of Azure and Microsoft 365 collectors.
Since then, the project has evolved into a collector-based PowerShell framework with support for multiple platforms, each exposing its own set of collectors and declarative security rules.
Each platform (Azure, EntraID or Microsoft365) contains collectors for different services and workloads, for example:
- Exchange Online
- SharePoint Online
- Microsoft Purview
- Virtual Machines
- Key Vault
- Storage Accounts
- Network Security Groups
- RBAC
- PIM
- App Registrations
- Enterprise Applications
- Conditional Access
The name -Instance no longer accurately describes what the parameter represents. It is also easy to confuse with the existing -Environment parameter, which is used to select the target Microsoft cloud (AzurePublic, AzureChina, AzureUSGovernment, etc.).
Describe the solution you'd like
Rename -Instance to -Platform.
Examples:
Invoke-Monkey365 -Platform Azure -Collect VirtualMachine,StorageAccount -ExportTo JSON
Invoke-Monkey365 -Platform Microsoft365 -Collect ExchangeOnline,SharePointOnline -IncludeEntraID -ExportTo HTML
I believe that -Platform better reflects the current architecture and also scales naturally if additional platforms (Azure DevOps!) are added in the future.
As always, I'd appreciate any feedback or suggestions before moving forward with this change.
Thanks,
Contributor guide
No contributing guide indexed for this repository
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 at the Invoke-Monkey365 command definition and trace every reference to the -Instance parameter, including the existing -Environment distinction. The work is done when the parameter is consistently exposed as -Platform and the Azure, Microsoft365, and EntraID examples use the new name without ambiguity.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- powershell
- Domain
- cli, cloud
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100