Skip to content

AzGovViz (Azure Governance Visualizer) is a PowerShell script that captures Azure Governance related information such as Azure Policy, RBAC (a lot more) by polling Azure ARM and Microsoft Graph APIs. From the collected data AzGovViz provides visibility on your HierarchyMap, creates a TenantSummary, creates DefinitionInsights and builds granular …

License

JulianHayward/Azure-MG-Sub-Governance-Reporting

master
Switch branches/tags
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
img
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

AzGovViz - Azure Governance Visualizer

Do you want to get granular insights on your technical Azure Governance implementation? - document it in CSV, HTML, Markdown and JSON?
AzGovViz is a PowerShell based script that iterates your Azure Tenant´s Management Group hierarchy down to Subscription level. It captures most relevant Azure governance capabilities such as Azure Policy, RBAC and Blueprints and a lot more. From the collected data AzGovViz provides visibility on your HierarchyMap, creates a TenantSummary, creates DefinitionInsights and builds granular ScopeInsights on Management Groups and Subscriptions. The technical requirements as well as the required permissions are minimal.

You can run the script either for your Tenant Root Group or any other Management Group.

Mission

"Governance can be a complex thing.."

Challenges:

  • Holistic overview on governance implementation
  • Connecting the dots

AzGovViz is intended to help you to get a holistic overview on your technical Azure Governance implementation by connecting the dots

ConnectingDot

AzGovViz @ Microsoft CAF & WAF

Microsoft Cloud Adoption Framework (CAF)

Listed as tool for the Govern discipline in the Microsoft Cloud Adoption Framework

Included in the Microsoft Cloud Adoption Framework´s Strategy-Plan-Ready-Gov Azure DevOps Demo Generator template

Microsoft Well Architected Framework (WAF)

Listed as security monitoring tool in the Microsoft Well Architected Framework

Content

Release history

Changes (2022-Jun-22 / Major)

  • New feature 'Orphaned Resources' - Azure Resource Graph based reporting on orphaned resources (TenantSummary, ScopeInsights, CSV export). Azure Orphan Resources - GitHub ARG queries and workbooks by Dolev Shor
  • New feature 'Resource fluctuation' - Compare against Resources from previous run and output aggregated summary of the Resource fluctuation (TenantSummary, CSV export)
  • Fix /providers/Microsoft.Authorization/roleAssignmentScheduleInstances AzAPICall errorhandling (error 400, 500)
  • Optimize procedure to update the AzAPICall module
  • Use AzAPICall PowerShell module version 1.1.17
  • Updated HTML Demo

Passed tests: Powershell Core 7.2.4 on Windows
Passed tests: Powershell Core 7.2.4 Azure DevOps hosted agent ubuntu-20.04
Passed tests: Powershell Core 7.2.4 Github Actions hosted agent ubuntu-latest
Passed tests: Powershell Core 7.2.4 GitHub Codespaces mcr.microsoft.com/powershell:latest
Passed tests: AzureCloud, AzureUSGovernment, AzureChinaCloud

Full release history

Demo

Demo

Demo (v6_major_20220622_2)
Enterprise-Scale (WingTip) implementation

More demo output

Media

Slideset

Short presentation on AzGovViz [download]

Features

  • Hierarchy of Management Groups
    • Builds a visual hierarchy of your Management Group setup including counts on linked Subscriptions, Policy assignments, scoped Policy/Set definitions and Role assignments per Management Group
  • Azure Policy
    • Custom Policy definitions
      • Scope information
      • Policy effect
      • If Policy effect is DeployIfNotExists (DINE) will show the specified RBAC Role
      • List of assignments
      • Usage in custom PolicySet definitions
      • System metadata 'createdOn, createdBy, updatedOn, updatedBy' ('createdBy', 'updatedBy' identity is fully resolved)
    • Orphaned custom Policy definitions
      • List of custom Policy definitions that matches the following criteria:
        • Policy definition is not used in any custom PolicySet definition
        • No Policy assignment exists for the Policy definition
    • Custom PolicySet definitions
      • Scope information
      • List unique assignments
      • List of Policy definitions used
    • Orphaned custom PolicySet definitions
      • Criteria: no Policy assignment exists for the PolicySet definition
    • Custom PolicySet definitions using deprecated built-in Policy definitions
    • Policy assignments of deprecated built-in Policy definition
    • Policy Exemptions
      • Lists all Exemptions (scopes: Management Groups, Subscriptions, ResourceGroups, Resources)
      • Enrich information on Exemption scope
      • Summary on expired Exemptions
    • Policy assignments orphaned
      • Policy assignments's Policy definition does not exist / likely Management Group scoped Policy defintion - Management Group deleted
    • Policy assignments throughout the entirety of scopes (Management Groups, Subscriptions and Resource Groups)
      • Core information on Policy assignments
        • NonCompliance Message on Policy assignment for a PolicySet will only show the default non-compliance message
      • Advanced/enriched information on Policy assignments
        • Policy assignment scope (at scope/inheritance)
        • Indicates if scope is excluded from Policy assignment
        • Indicates if Exemption applies for scope
        • Policy/Resource Compliance (Policy: NonCompliant, Compliant; Resource: NonCompliant, Compliant, Conflicting)
        • Related RBAC Role assignments (if Policy effect is DeployIfNotExists (DINE) or Modify)
        • Resolved Managed Identity (if Policy effect is DeployIfNotExists (DINE) or Modify)
        • System metadata 'createdOn, createdBy, updatedOn, updatedBy' ('createdBy', 'updatedBy' identity is fully resolved)
        • Parameters used
  • Role-Based Access Control (RBAC)
    • Custom Role definitions
      • List assignable scopes
      • System metadata 'createdOn, createdBy, updatedOn, updatedBy' ('createdBy', 'updatedBy' identity is fully resolved)
    • Orphaned custom Role definitions
      • List of custom Role definitions that matches the following criteria:
        • Role definition is not used in any Role assignment
        • Role is not used in a Policy definition´s rule (roleDefinitionIds)
    • Orphaned Role assignments
      • List of Role assignments that matches the following criteria:
        • Role definition was deleted although and assignment existed
        • Role assignmet's target identity (User, Group, ServicePrincipal) was deleted
    • Role assignments throughout the entirety of scopes (Management Groups, Subscriptions, Resource Groups and Resources)
      • Core information on Role assignments
      • Advanced information on Role assignments
        • Role assignment scope (at scope / inheritance)
        • For Role Assignments on Groups the AAD Group members are fully resolved. With this capability AzGovViz can ultimately provide holistic insights on permissions granted
        • For Role Assignments on Groups the AAD Group members count (transitive) will be reported
        • For identity-type == 'ServicePrincipal' the type (Application (internal/external) / ManagedIdentity (System assigned/User assigned)) will be revealed
        • For identity-type == 'User' the userType (Member/Guest) will be revealed
        • Related Policy assignments (Policy assignment that leverages the DeployIfNotExists (DINE) or Modify effect)
        • System metadata 'createdOn, createdBy' ('createdBy' identity is fully resolved)
        • Determine if the Role assignment is 'standing' or PIM (Privileged Identity Management) managed
        • Determine if the Role assignmet's Role definition is capable to write Role assignments
    • Role assignments ClassicAdministrators
    • Security & Best practice analysis
      • Existence of custom Role definition that reflect 'Owner' permissions
      • Report all Role definitions that are capable to write Role assignements, list all Role assignments for those Role definitions
      • Role assignments for 'Owner' permissions on identity-type == 'ServicePrincipal'
      • Role assignments for 'Owner' permissions on identity-type != 'Group'
      • Role assignments for 'User Access Administrator' permissions on identity-type != 'Group'
      • High priviledge Role assignments for 'Guest Users' (Owner & User Access Administrator)
  • Blueprints
    • Blueprint scopes and assignments
    • Orphaned Blueprints
  • Management Groups
    • Management Group count, level/depth, MG children, Sub children
    • Hierarchy Settings | Default Management Group Id
    • Hierarchy Settings | Require authorization for Management Group creation
  • Subscriptions, Resources & Defender
    • Subscription insights
      • QuotaId, State, Tags, Microsoft Defender for Cloud Secure Score, Cost, Management Group path, Role assignment limit, enabled Preview features
    • Tag Name usage
      • Insights on usage of Tag Names on Subscriptions, ResourceGroups and Resources
    • Resources
      • Resource Types
        • ResourceType count per location
        • Resource Provider
          • Resource Provider state aggregation throughout all Subscriptions
          • Explicit Resource Provider state per Subscription
        • Resource Locks
          • Aggregated insights for Lock and respective Lock-type usage on Subscriptions, ResourceGroups and Resources
        • Orphaned Resources (ARG)
    • Microsoft Defender for Cloud
      • Summary of Microsoft Defender for Cloud coverage by plan (count of Subscription per plan/tier)
      • Summary of Microsoft Defender for Cloud plans coverage by Subscription (plan/tier)
      • Highlight the usage of deprecated Defender plans (e.g. Container Registry & Kubernetes)
    • UserAssigned Managed Identities assigned to Resources / vice versa
      • Summary of all UserAssigned Managed Identities assigned to Resources
      • Summary of Resources that have an UserAssigned Managed Identity assigned
    • PSRule for Azure
      • Well-Architected Framework aligned best practice analysis for resources, including guidance for remediation
  • Diagnostics
    • Management Groups Diagnostic settings report
      • Management Group, Diagnostic setting name, target type (LA, SA, EH), target Id, Log Category status
    • Subscriptions Diagnostic settings report
      • Subscription, Diagnostic setting name, target type (LA, SA, EH), target Id, Log Category status
    • Resources Diagnostic capabilty report (1st party Resource types only)
      • ResourceType capability for Resource Diagnostics including
        • ResourceType count and information if capable for logs including list of available og categories
        • ResourceType count and information if capable for metrics
    • Lifecyle recommendations for existing Azure Policy definitions that configure Resource diagnostics of type=Log
      • Check if Policy definitions hold the latest set of applicable log categories
      • Recommendation to create Policy definition for ResourceType if supported
      • Lists all PolicyDefinitions that deploy Resource diagnostics of type=log, lists Policy assignments and PolicySet assignments if the Policy defintion is used in a PolicySet definition
  • Limits
    • Tenant approaching ARM limits:
      • Custom Role definitions
      • PolicySet definitions
    • Management Groups approaching ARM limits:
      • Policy assignment limit
      • Policy / PolicySet definition scope limit
      • Role assignment limit
    • Subscriptions approaching ARM limits:
      • ResourceGroup limit
      • Subscription Tags limit
      • Policy assignment limit
      • Policy / PolicySet definition scope limit
      • Role assignment limit
  • Azure Active Directory (AAD)
    • Insights on those Service Principals where a Role assignment exists (scopes: Management Group, Subscription, ResourceGroup, Resource):
      • Type=ManagedIdentity
        • Core information on the Service Principal such as related Ids, use case information and Role assignments
        • For UserManaged Identities the count of assignment to Resources is reported
        • Orphaned Managed Identity - Policy assignment related Managed Identities / the related Policy assignment does not exist
        • UserAssigned Managed Identity - count of Resources that it is assigned to
      • Type=Application
        • Secrets and Certificates expiry information & warning
        • Report on external Service Principals
  • Consumption
    • Aggregated consumption insights throughout the entirety of scopes (Management Groups, Subscriptions)
  • Change tracking
    • Policy
      • Created/Updated Policy and PolicySet definitions (system metadata 'createdOn, createdBy, updatedOn, updatedBy')
      • Created/Updated Policy assignments (system metadata 'createdOn, createdBy, updatedOn, updatedBy')
    • RBAC
      • Created/Updated Role definitions (system metadata 'createdOn, createdBy, updatedOn, updatedBy')
      • Created Role assignments (system metadata 'createdOn, createdBy)
    • Resources
      • Aggregated insights on Created/Changed Resources

Screenshots

HTML file

HierarchyMap
alt text
TenantSummary
alt text
DefinitionInsights
alt text ScopeInsights
alt text
*IDs from screenshot are randomized

markdown in Azure DevOps Wiki as Code

alt text *IDs from screenshot are randomized

Note: there is some fixing ongoing at the mermaid project to optimize the graphical experience:
mermaid-js/mermaid#1177

Outputs

  • CSV file
  • HTML file
    • the HTML file uses Java Script and CSS files which are hosted on various CDNs (Content Delivery Network). For details review the BuildHTML region in the PowerShell script file.
    • Browsers tested: Edge, new Edge and Chrome
  • MD (Markdown) file
    • for use with Azure DevOps Wiki leveraging the Mermaid plugin
  • JSON folder (demo-output) containing
    • all Policy and Role assignments (Scopes: Tenant, Management Groups and Subscriptions)
    • all BuiltIn and Custom Policy/Set definitions (Scopes: Management Groups and Subscriptions)
    • all BuiltIn and Custom Role definitions
    • JSON file of ManagementGroup Hierarchy including all Custom Policy/Set and RBAC definitions, Policy and Role assignments and some more relevant information
    • Tenant tree including all Policy and Role assignments AND all Custom Policy/Set and Role definitions
      alt text

AzGovViz Setup Guide

💡 Although 30 minutes of troubleshooting can save you 5 minutes reading the documentation :) ..
Check the detailed Setup Guide

Technical documentation

Permissions overview

alt text

Required permissions in Azure

This permission is mandatory in each and every scenario!

Scenario Permissions
ANY
Console / Azure DevOps / GitHub Actions ..
Reader Role assignment on Management Group

Required permissions in Azure Active Directory

Scenario Permissions
A
Console | Member user account
No AAD permissions required
B
Console | Guest user account
If the tenant is hardened (AAD External Identities / Guest user access = most restrictive) then Guest User must be assigned the AAD Role 'Directory readers'
💡 Compare member and guest default permissions
💡 Restrict Guest permissions
C
Console | Service Principal | Managed Identity
Capability API Permissions
Get AAD
Users
Service Principal's App registration
grant with Microsoft Graph permissions:
Application permissions / User / User.Read.All
💡 Get user
Get AAD
Groups
Service Principal's App registration
grant with Microsoft Graph permissions:
Application permissions / Group / Group.Read.All
💡 Get group
Get AAD
SP/App
Service Principal's App registration
grant with Microsoft Graph permissions:
Application permissions / Application / Application.Read.All
💡 Get servicePrincipal, Get application
Optional: AAD Role 'Directory readers' could be used instead of API permissions (more 'read' than required)
D
Azure DevOps / Github Actions | ServicePrincipal
Capability API Permissions
Get AAD
Users
Azure DevOps Service Connection's App registration
grant with Microsoft Graph permissions:
Application permissions / User / User.Read.All
💡 Get user
Get AAD
Groups
Azure DevOps Service Connection's App registration
grant with Microsoft Graph permissions:
Application permissions / Group / Group.Read.All
💡 Get group
Get AAD
SP/App
Azure DevOps Service Connection's App registration
grant with Microsoft Graph permissions:
Application permissions / Application / Application.Read.All
💡 Get servicePrincipal, Get application
Optional: AAD Role 'Directory readers' could be used instead of API permissions (more 'read' than required)

Screenshot Azure Portal
alt text

PowerShell

Parameters

  • -ManagementGroupId Management Group Id (Root Management Group Id equals your Tenant Id)
  • -CsvDelimiter - The world is split into two kinds of delimiters - comma and semicolon - choose yours (default is semicolon ';')
  • -OutputPath
  • -AzureDevOpsWikiAsCode - Use this parameter only when running AzGovViz in a Azure DevOps Pipeline Based on environment variables the script will detect the code run platform
  • -DoNotShowRoleAssignmentsUserData - Scrub personally identifiable information (PII)
  • -LimitCriticalPercentage - Limit warning level, default is 80%
  • -HierarchyTreeOnly -HierarchyMapOnly - Output only the HierarchyMap for Management Groups including linked Subscriptions
  • -SubscriptionQuotaIdWhitelist - Process only Subscriptions with defined QuotaId(s). Example: .\AzGovVizParallel.ps1 -SubscriptionQuotaIdWhitelist MSDN_,Enterprise_
  • -NoResourceProvidersDetailed - Disables output for ResourceProvider states for all Subscriptions in the TenantSummary section, in large Tenants this can become time consuming
  • -NoMDfCSecureScore - Disables Microsoft Defender for Cloud Secure Score request for Subscriptions and Management Groups.
  • -DisablePolicyComplianceStates -NoPolicyComplianceStates - Will not query policy compliance states. You may want to use this parameter to accellerate script execution or when receiving error 'ResponseTooLarge'.
  • -NoResourceDiagnosticsPolicyLifecycle - Disables Resource Diagnostics Policy Lifecycle recommendations
  • -NoAADGroupsResolveMembers - Disables resolving Azure Active Directory Group memberships
  • -NoAADGuestUsers - Disables resolving Azure Active Directory User type (Guest or Member)
  • -NoServicePrincipalResolve -NoAADServicePrincipalResolve - Disables resolving ServicePrincipals
  • -ServicePrincipalExpiryWarningDays -AADServicePrincipalExpiryWarningDays - Define warning period for Service Principal secret and certificate expiry; default is 14 days
  • -NoAzureConsumption - Azure Consumption data should not be collected/reported
  • -DoAzureConsumption - Azure Consumption data should be collected/reported
  • -AzureConsumptionPeriod - Define for which time period Azure Consumption data should be gathered; default is 1 day
  • -NoAzureConsumptionReportExportToCSV - Azure Consumption data should not be exported (CSV)
  • -NoScopeInsights - Q: Why would you want to do this? A: In larger tenants the ScopeInsights section blows up the html file (up to unusable due to html file size). Use -LargeTenant to further reduce the output.
  • -ThrottleLimit - leveraging PowerShell´s parallel capability you can define the ThrottleLimit (default=5)
  • -DoTranscript - Log the console output
  • -SubscriptionId4AzContext - Define the Subscription Id to use for AzContext (default is to use a random Subscription Id)
  • -PolicyAtScopeOnly - Removing 'inherited' lines in the HTML file for 'Policy Assignments'; use this parameter if you run against a larger tenants. Note using parameter -LargeTenant will set -PolicyAtScopeOnly $true
  • -RBACAtScopeOnly - Removing 'inherited' lines in the HTML file for 'Role Assignments'; use this parameter if you run against a larger tenants. Note using parameter -LargeTenant will set -RBACAtScopeOnly $true
  • -CsvExport -NoCsvExport - Do not export enriched data for 'Role assignments', 'Policy assignments' data and 'all Resources' (subscriptionId, managementGroup path, resourceType, id, name, location, tags, createdTime, changedTime)
  • -PolicyIncludeResourceGroups -DoNotIncludeResourceGroupsOnPolicy - Do not include Policy assignments on ResourceGroups
  • -RBACIncludeResourceGroupsAndResources -DoNotIncludeResourceGroupsAndResourcesOnRBAC - Do not include Role assignments on ResourceGroups and Resources
  • -ChangeTrackingDays - Define the period for Change tracking on newly created and updated custom Policy, PolicySet and RBAC Role definitions and Policy/RBAC Role assignments (default is '14')
  • -FileTimeStampFormat- Define the time format for the output files (default is yyyyMMdd_HHmmss)
  • -JsonExport -NoJsonExport - Do not enable export of ManagementGroup Hierarchy including all MG/Sub Policy/RBAC definitions, Policy/RBAC assignments and some more relevant information to JSON
  • -JsonExportExcludeResourceGroups - JSON Export will not include ResourceGroups (Policy & Role assignments)
  • -JsonExportExcludeResources- JSON Export will not include Resources (Role assignments)
  • -LargeTenant - A large tenant is a tenant with more than ~500 Subscriptions - the HTML output for large tenants simply becomes too big. Using this parameter the following parameters will be set: -PolicyAtScopeOnly $true, -RBACAtScopeOnly $true, -NoResourceProvidersDetailed $true, -NoScopeInsights $true
  • -HtmlTableRowsLimit - Although the parameter -LargeTenant was introduced recently, still the html output may become too large to be processed properly. The new parameter defines the limit of rows - if for the html processing part the limit is reached then the html table will not be created (csv and json output will still be created). Default rows limit is 20.000
  • -AADGroupMembersLimit - Defines the limit (default=500) of AAD Group members; For AAD Groups that have more members than the defined limit Group members will not be resolved
  • -NoResources - Will speed up the processing time but information like Resource diagnostics capability, resource type stats, UserAssigned Identities assigned to Resources is excluded (featured for large tenants)
  • -StatsOptOut - Opt out sending stats
  • -NoSingleSubscriptionOutput - Single Scope Insights output per Subscription should not be created
  • -ManagementGroupsOnly - Collect data only for Management Groups (Subscription data such as e.g. Policy assignments etc. will not be collected)
  • -ShowMemoryUsage - Shows memory usage at memory intense sections of the scripts, this shall help you determine if the the worker is well sized for AzGovViz
  • -ExcludedResourceTypesDiagnosticsCapable - Resource Types to be excluded from processing analysis for diagnostic settings capability (default: microsoft.web/certificates)
  • PSRule
    • -DoPSRule - Execute PSRule. Results are integrated in the HTML output, plus PSRule results are exported to CSV
    • -PSRuleVersion - Define the PSRule..Rules.Azure PowerShell module version, if undefined then 'latest' will be used

API reference

AzGovViz polls the following APIs

Endpoint API version API name
MS Graph beta /groups/aadGroupId/transitiveMembers
MS Graph v1.0 /applications
MS Graph v1.0 /directoryObjects/getByIds
MS Graph v1.0 /users
MS Graph v1.0 /groups
MS Graph v1.0 /servicePrincipals
ARM 2021-05-01-preview /resourceId/providers/Microsoft.Insights/diagnosticSettingsCategories
ARM 2018-11-01-preview /scopeId/providers/Microsoft.Blueprint/blueprints/blueprintName
ARM 2021-06-01 /providers/Microsoft.Authorization/policyDefinitions
ARM 2021-06-01 /providers/Microsoft.Authorization/policySetDefinitions
ARM 2018-07-01 /providers/Microsoft.Authorization/roleDefinitions
ARM 2020-02-01 /providers/Microsoft.Management/getEntities
ARM 2021-06-01 /providers/Microsoft.Management/managementGroups/managementGroupId/providers/Microsoft.Authorization/policyAssignments
ARM 2021-06-01 /providers/Microsoft.Management/managementGroups/managementGroupId/providers/Microsoft.Authorization/policyDefinitions
ARM 2020-07-01-preview /providers/Microsoft.Management/managementGroups/managementGroupId/providers/Microsoft.Authorization/policyExemptions
ARM 2021-06-01 /providers/Microsoft.Management/managementGroups/managementGroupId/providers/Microsoft.Authorization/policySetDefinitions
ARM 2015-07-01 /providers/Microsoft.Management/managementGroups/managementGroupId/providers/Microsoft.Authorization/roleAssignments
ARM 2020-10-01 /providers/Microsoft.Management/managementGroups/managementGroupId/providers/Microsoft.Authorization/roleAssignmentScheduleInstances
ARM 2015-07-01 /providers/Microsoft.Management/managementGroups/managementGroupId/providers/Microsoft.Authorization/roleDefinitions
ARM 2018-11-01-preview /providers/Microsoft.Management/managementGroups/managementGroupId/providers/Microsoft.Blueprint/blueprints
ARM 2019-11-01 /providers/Microsoft.Management/managementGroups/managementGroupId/providers/Microsoft.CostManagement/query
ARM 2020-01-01-preview /providers/Microsoft.Management/managementGroups/managementGroupId/providers/microsoft.insights/diagnosticSettings
ARM 2019-10-01 /providers/Microsoft.Management/managementGroups/managementGroupId/providers/Microsoft.PolicyInsights/policyStates/latest/summarize
ARM 2020-05-01 /providers/Microsoft.Management/managementGroups/managementGroupId
ARM 2020-02-01 /providers/Microsoft.Management/managementGroups/tenantId/settings
ARM 2020-05-01 /providers/Microsoft.Management/managementGroups
ARM 2021-03-01 /providers/Microsoft.ResourceGraph/resources
ARM 2016-09-01 /subscriptions/subscriptionId/providers/Microsoft.Authorization/locks
ARM 2021-06-01 /subscriptions/subscriptionId/providers/Microsoft.Authorization/policyAssignments
ARM 2021-06-01 /subscriptions/subscriptionId/providers/Microsoft.Authorization/policyDefinitions
ARM 2020-07-01-preview /subscriptions/subscriptionId/providers/Microsoft.Authorization/policyExemptions
ARM 2021-06-01 /subscriptions/subscriptionId/providers/Microsoft.Authorization/policySetDefinitions
ARM 2015-07-01 /subscriptions/subscriptionId/providers/Microsoft.Authorization/roleAssignments
ARM 2020-10-01 /subscriptions/subscriptionId/providers/Microsoft.Authorization/roleAssignmentScheduleInstances
ARM 2019-08-01-preview /subscriptions/subscriptionId/providers/Microsoft.Authorization/roleAssignmentsUsageMetrics
ARM 2015-07-01 /subscriptions/subscriptionId/providers/Microsoft.Authorization/roleDefinitions
ARM 2018-11-01-preview /subscriptions/subscriptionId/providers/Microsoft.Blueprint/blueprintAssignments
ARM 2018-11-01-preview /subscriptions/subscriptionId/providers/Microsoft.Blueprint/blueprints
ARM 2019-11-01 /subscriptions/subscriptionId/providers/Microsoft.CostManagement/query
ARM 2021-05-01-preview /subscriptions/subscriptionId/providers/Microsoft.Insights/diagnosticSettings
ARM 2019-10-01 /subscriptions/subscriptionId/providers/Microsoft.PolicyInsights/policyStates/latest/summarize
ARM 2020-06-01 /subscriptions/subscriptionId/providers/Microsoft.Resources/tags/default
ARM 2018-06-01 /subscriptions/subscriptionId/providers/Microsoft.Security/pricings
ARM 2020-01-01 /subscriptions/subscriptionId/providers/Microsoft.Security/securescores
ARM 2019-10-01 /subscriptions/subscriptionId/providers
ARM 2021-04-01 /subscriptions/subscriptionId/resourcegroups
ARM 2021-04-01 /subscriptions/subscriptionId/resources
ARM 2020-01-01 /subscriptions
ARM 2020-01-01 /tenants

Integrate with AzOps

Did you know you can run AzOps from Azure DevOps? Check AzOps Accellerator.
You can integrate AzGovViz (same project as AzOps).

  pipelines:
    - pipeline: 'Push'
      source: 'AzOps - Push'
      trigger:
        branches:
          include:
            - master

Integrate PSRule for Azure

Let´s use PSRule for Azure and leverage over 260 pre-built rules to validate Azure resources based on the Microsoft Well-Architected Framework (WAF) principles.
PSRule for Azure is listed as security monitoring tool in the Microsoft Well-Architected Framework.

Parameter: -DoPSRule (e.g. .\pwsh\AzGovVizParallel.ps1 -DoPSRule)

Outputs:

  • HTML (summarized)
    • TenantSummary
    • ScopeInsights
      • Management Group (all resources below that scope)
      • Subscription
  • CSV (detailed, per resource)

TenantSummary HTML output example:
alt text

Stats

In order to better understand the AzGovViz usage and to optimize the product accordingly some stats will be ingested to Azure Application Insights. Results of stats analysis may be shared at a later stage.

How/What?

If the script is run in Azure DevOps then the Repository Id and executing principal´s object Id will be used to create an unique identifier.
If the script is not run in Azure DevOps then the Tenant Id and executing principal´s object Id will be used to create an unique identifier.

SHA384/512 hashed combination of

  • portion of the repositoryId/tenantId
    • if repositoryId/tenantId startsWith a letter then use characters 3-8 (6 characters) of the first GUID´s block, combine them with the third GUID`s block of the principal´s objectId (4 characters), SHA512 hash them as identifier0
    • if repositoryId/tenantId startsWith a number then use characters 7-12 (6 characters) of the last GUID`s block, combine them with the second GUID´s block of the principal´s objectId (4 characters), SHA384 hash them as identifier0
  • portion of the executing principal´s objectId
    • if objectId startsWith a letter then use characters 3-8 (6 characters) of the first GUID´ block, combine them with the third GUID´ block of the repositoryId/tenantId (4 characters), SHA512 hash them as identifier1
    • if objectId startsWith a number then use characters 7-12 (6 characters) of the last GUID´ block, combine them with the second GUID´ block of the repositoryId/tenantId (4 characters), SHA384 hash them as identifier1

Combine identifier0 and identifier1

  • if objectId startsWith a letter then combine identifiers -> 'identifier0 + identifier1', SHA512 hash them as final identifier and remove dashes (string of 128 characters)
  • if objectId startsWith a number then combine identifiers -> 'identifier1 + identifier0', SHA512 hash them as final identifier and remove dashes (string of 128 characters)

To conclude the approach: taking 6 or 4 characters from tenantId/respositoryId and objectId of the executing principal to create a unique identifier, which may not be backward resolveable.

alt text

The following data will be ingested to Azure Application Insights:

    "accType": "ServicePrincipal / User (member) / User (Guest)",
    "azCloud": "Azure environment e.g. AzureCloud, ChinaCloud, etc.",
    "identifier": "8c62a7..53d08c0 (string of 128 characters)",
    "platform": "Console / AzureDevOps",
    "productVersion": "used AzGovViz version",
    "psAzAccountsVersion": "used Az.Accounts PS module version",
    "psVersion": "used PowerShell version",
    "scopeUsage": "childManagementGroup / rootManagementGroup",
    "statsCountErrors": "count of encountered errors",
    "statsCountSubscriptions": "less than 100 / more than 100 (no exact numbers)",
    "statsParametersDoNotIncludeResourceGroupsAndResourcesOnRBAC": "true / false",
    "statsParametersDoNotIncludeResourceGroupsOnPolicy": "true / false",
    "statsParametersDoNotShowRoleAssignmentsUserData": "true / false",
    "statsParametersHierarchyMapOnly": "true / false",
    "statsParametersLargeTenant": "true / false",
    "statsParametersNoASCSecureScore" "true / false",
    "statsParametersNoAzureConsumption": "true / false",
    "statsParametersNoJsonExport": "true / false",
    "statsParametersNoPolicyComplianceStates": "true / false",
    "statsParametersNoResourceProvidersDetailed": "true / false",
    "statsParametersNoResources": "true / false",
    "statsParametersPolicyAtScopeOnly": "true / false",
    "statsParametersRBACAtScopeOnly": "true / false",
    "statsTry": "count of try sending to Application Insights"

Azure Application Insights data:

alt text

If you do not want to contribute to stats for AzGovViz then you can use the parameter:
-StatsOptOut

If you have any concerns or see a risk sending stats please file an issue.

Thank you for your support!

Security

AzGovViz creates very detailed information about your Azure Governance setup. In your organization's best interest the outputs should be protected from not authorized access!

Known issues

Working with Git and Windows cloning from your AzDO repository you may experience the following error:

fatal: cannot create directory at 'output/JSON_...': Filename too long

To work around that issue you may want to enable longpaths support.
Note the caveats!

git config --system core.longpaths true

Facts

Disabled Subscriptions and Subscriptions where Quota Id starts with with "AAD_" are being skipped, all others are queried. More information on Subscription Quota Id / Offer numbers: Supported Microsoft Azure offers.

ARM Limits are not acquired programmatically, these are hardcoded. The links used to check related limits are commented in the param section of the script.

Contributions

Please feel free to contribute.

Thanks to so many supporters - testing, giving feedback, making suggestions, presenting use-case, posting/blogging articles, refactoring code - THANK YOU!

Thanks Stefan Stranger (Microsoft) for providing me with his AzGovViz outputs executed on his implementation of EnterpriseScale. Make sure you read Stefan´s Blog Article: Enterprise-Scale - Policy Driven Governance

Thanks Frank Oltmanns-Mack (Microsoft) for providing me with his AzGovViz outputs executed on his implementation of EnterpriseScale.

Carlos Mendible (Microsoft) gracias por tu contribución on the project - run AzGovViz with GitHub Codespaces.

Special thanks to Tim Wanierke, Brooks Vaughn and Friedrich Weinmann (Microsoft).

And another big thanks to Wayne Meyer (Microsoft) for constant support and building bridges.

Kudos to the TableFilter Project Team!

Kudos to LorDOniX for JSON-viewer!

Kudos to Bernie White and PSRule for Azure team!

AzAdvertizer

alt text

Also check https://www.azadvertizer.net - AzAdvertizer helps you to keep up with the pace by providing overview and insights on new releases and changes/updates for Azure Governance capabilities such as Azure Policy's Policy definitions, initiatives (Set definitions), aliases and Azure RBAC's Role definitions and resource provider operations.

AzADServicePrincipalInsights

Also check https://aka.ms/AzADServicePrincipalInsights - What about your Azure Active Directory Service Principals? Get deep insights and track your Service Principals with AzADServicePrincipalInsights. Create a HTML overview, export to CSV and JSON and use it for further processing...

alt text

Closing Note

Please note that while being developed by a Microsoft employee, AzGovViz is not a Microsoft service or product. AzGovViz is a personal/community driven project, there are none implicit or explicit obligations related to this project, it is provided 'as is' with no warranties and confer no rights.

About

AzGovViz (Azure Governance Visualizer) is a PowerShell script that captures Azure Governance related information such as Azure Policy, RBAC (a lot more) by polling Azure ARM and Microsoft Graph APIs. From the collected data AzGovViz provides visibility on your HierarchyMap, creates a TenantSummary, creates DefinitionInsights and builds granular …

Topics

Resources

License

Stars

Watchers

Forks