Skip to content

README out of sync: missing parameters, wrong permissions, incomplete menu docs #116

@ugurkocde

Description

@ugurkocde

Summary

The README has drifted from the current script (v3.10.0) in several areas: missing parameters, a removed parameter still listed, outdated permissions table, and incomplete interactive menu documentation.


1. Missing parameters from README parameters table

The following parameters exist in the script's param() block (lines 93-172) but are not listed in the README parameters table (lines 293-316):

Parameter Script line Description in script
-HTMLReportPath line 128 Path for the exported HTML report file
-ShowFailedAssignments line 137 Show all failed assignments
-IncludeNestedGroups line 168 Include assignments inherited from parent groups
-ScopeTagFilter line 171 Filter results by scope tag name
-SkipExecution line 122 Skip execution (used for testing) - may intentionally be omitted

2. Removed parameter still listed in README

-ShowAdminTemplates is listed in the README parameters table (line 307) but does not exist in the script's param() block. It was removed in v3.4.0. This should be removed from the README.

3. Permissions table is outdated

README (lines 107-115) lists 7 permissions:

  • User.Read.All
  • Group.Read.All
  • Device.Read.All
  • DeviceManagementApps.Read.All
  • DeviceManagementConfiguration.Read.All
  • DeviceManagementManagedDevices.Read.All
  • DeviceManagementServiceConfig.Read.All

Script's $requiredPermissions (lines 512-549) requires 9 permissions:

  • User.Read.All
  • Group.Read.All
  • Device.Read.All
  • DeviceManagementApps.Read.All
  • DeviceManagementConfiguration.Read.All
  • DeviceManagementManagedDevices.Read.All
  • DeviceManagementScripts.Read.All (missing from README)
  • CloudPC.Read.All (missing from README)
  • DeviceManagementRBAC.Read.All (missing from README)

Additionally, DeviceManagementServiceConfig.Read.All is listed in the README but is not in the script's required permissions array. Users following the README will set up incorrect permissions.

4. Interactive menu section is incomplete

The README's interactive menu section (lines 318-386) is missing:

  • Option 10: Compare Groups - exists in the script (line 187) but not in the README menu docs
  • Option 11: Show All Failed Assignments - exists in the script (line 188) but not in the README menu docs
  • Option 12: Switch Tenant - mentioned in v3.4.5 release notes but not in the README menu docs

Suggested changes

  1. Add -HTMLReportPath, -ShowFailedAssignments, -IncludeNestedGroups, -ScopeTagFilter to the parameters table
  2. Remove -ShowAdminTemplates from the parameters table
  3. Update the permissions table to match the script's $requiredPermissions array
  4. Add options 10, 11, and 12 to the interactive menu documentation

Metadata

Metadata

Assignees

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions