Merge pull request #17 from AsBuiltReport/dev

v0.1.7 release
AsBuiltReport · Oct 12, 2024 · a6d1559 · a6d1559
2 parents 6966050 + 8ab7159
commit a6d1559
Show file tree

Hide file tree

Showing 40 changed files with 2,475 additions and 1,468 deletions.
diff --git a/.github/workflows/Release.yml b/.github/workflows/Release.yml
@@ -8,7 +8,7 @@ jobs:
   publish-to-gallery:
     runs-on: windows-2019
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set PSRepository to Trusted for PowerShell Gallery
         shell: pwsh
         run: |
@@ -29,7 +29,7 @@ jobs:
     needs: publish-to-gallery
     runs-on: ubuntu-latest
     steps:
-      - uses: Eomm/why-don-t-you-tweet@v1
+      - uses: Eomm/why-don-t-you-tweet@v2
         # We don't want to tweet if the repository is not a public one
         if: ${{ !github.event.repository.private }}
         with:

diff --git a/AsBuiltReport.Microsoft.Azure.json b/AsBuiltReport.Microsoft.Azure.json
@@ -9,7 +9,8 @@
         "ShowTableCaptions": true
     },
     "Options": {
-        "ShowSectionInfo": true
+        "ShowSectionInfo": true,
+        "ShowTags": true
     },
     "Filter": {
         "Subscription": ["*"]
@@ -24,7 +25,10 @@
         "KeyVault": 1,
         "LoadBalancer": 1,
         "NetworkSecurityGroup": 1,
-        "PolicyAssignment": 1,
+        "Policy": {
+			"Assignments": 1,
+			"Definitions": 0
+		},
         "RecoveryServicesVault": 1,
         "RouteTable": 1,
         "SiteRecovery": 1,
@@ -42,7 +46,9 @@
         },
         "StorageAccount": {
             "ProvisioningState": true,
-            "EnableHttpsTrafficOnly": true,
+            "StorageAccountKeyAccess": true,
+            "SecureTransfer": true,
+            "BlobAnonymousAccess": true,
             "PublicNetworkAccess": true,
             "MinimumTlsVersion": true
         },

diff --git a/AsBuiltReport.Microsoft.Azure.psd1 b/AsBuiltReport.Microsoft.Azure.psd1
@@ -12,7 +12,7 @@
 RootModule = 'AsBuiltReport.Microsoft.Azure.psm1'
 
 # Version number of this module.
-ModuleVersion = '0.1.6'
+ModuleVersion = '0.1.7'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()
@@ -27,7 +27,7 @@ Author = 'Tim Carman'
 # CompanyName = 'Unknown'
 
 # Copyright statement for this module
-Copyright = '(c) 2023 Tim Carman. All rights reserved.'
+Copyright = '(c) 2024 Tim Carman. All rights reserved.'
 
 # Description of the functionality provided by this module
 Description = 'A PowerShell module to generate an as built report on the configuration of Microsoft Azure.'
@@ -54,7 +54,7 @@ Description = 'A PowerShell module to generate an as built report on the configu
 RequiredModules = @(
         @{
             ModuleName = 'AsBuiltReport.Core';
-            ModuleVersion = '1.3.0'
+            ModuleVersion = '1.4.0'
         }
     )
 

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,48 +1,67 @@
 # :arrows_clockwise: Microsoft Azure As Built Report Changelog
 
+## [[0.1.7](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.Azure/releases/tag/v0.1.7)] - 2024-10-13
+
+### Added
+* Add support for Azure Policy definitions
+* Add Try/Catch blocks for improved error handling
+
+### Fixed
+* Fix issue with Azure Subscription Lookup Hashtable
+* Fix issue with Azure Policy assignments (Fix [#16](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.Azure/issues/16))
+
+### Changed
+* Performance improvements
+* Update GitHub Action release workflow
+* Improve reporting for Azure Tenant
+* Improve reporting for Azure Policy assignments
+* Improve reporting for Key Vaults
+* Improve reporting for Storage Accounts
+* Improve reporting for Network Security Groups
+
 ## [[0.1.6](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.Azure/releases/tag/v0.1.6)] - 2023-11-14
 
 ### Added
-* Added initial support for Route Tables (@howardhaooooo)
+* Add initial support for Route Tables (@howardhaooooo)
 
 ## [[0.1.5](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.Azure/releases/tag/v0.1.5)] - 2023-05-24
 
 ### Added
-* Added initial support for Storage Account (@rebelinux)
+* Add initial support for Storage Account (@rebelinux)
 
 ### Fixed
-* Fixed issue with Az module version check (Fix [#10](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.Azure/issues/10))
+* Fix issue with Az module version check (Fix [#10](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.Azure/issues/10))
 
 ## [[0.1.4](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.Azure/releases/tag/v0.1.4)] - 2023-03-19
 
 ### Added
-* Added function to check for Microsoft Azure PowerShell module
-* Added `ShowSectionInfo` option to provide information about Azure resources
+* Add function to check for Microsoft Azure PowerShell module
+* Add `ShowSectionInfo` option to provide information about Azure resources
 
 ## [[0.1.3](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.Azure/releases/tag/v0.1.3)] - 2023-03-17
 
 ### Added
-* Added examples to `README.md`
-* Added module information and version checks to verbose messaging
+* Add examples to `README.md`
+* Add module information and version checks to verbose messaging
 ### Changed
 * Further improvements to section headings & TOC structure
-* Updated Required Privileges information in `README.md`
+* Update Required Privileges information in `README.md`
 
 ### Fixed
-* Fixes [#4](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.Azure/issues/4)
-* Fixes [#5](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.Azure/issues/5)
-* Fixes [#6](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.Azure/issues/6)
+* Fix [#4](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.Azure/issues/4)
+* Fix [#5](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.Azure/issues/5)
+* Fix [#6](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.Azure/issues/6)
 
 ## [[0.1.2](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.Azure/releases/tag/v0.1.2)] - 2023-02-23
 
 ### Changed
-* Improved section heading & TOC structure
-* Removed Microsoft logo from default report style due to [licensing requirements](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks)
-* Changed default report style font to 'Segoe Ui' to align with [Microsoft guidelines](https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/f/font-font-style)
-* Improved bug and feature request templates
+* Improve section heading & TOC structure
+* Remove Microsoft logo from default report style due to [licensing requirements](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks)
+* Change default report style font to 'Segoe Ui' to align with [Microsoft guidelines](https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/f/font-font-style)
+* Improve bug and feature request templates
 
 ### Fixed
-* Fixes [#1](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.Azure/issues/1)
+* Fix [#1](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.Azure/issues/1)
 
 ## [0.1.1] - 2022-02-14
 

diff --git a/README.md b/README.md
@@ -87,10 +87,10 @@ The least privileged roles required to generate a Microsoft Azure As Built Repor
 <!-- ********** Add installation for any additional PowerShell module(s) ********** -->
 Open a PowerShell terminal window and install each of the required modules.
 
-:warning: Microsoft Az 9.4.0 or higher is required. Please ensure older Az modules have been uninstalled.
+:warning: Microsoft Az 12.0.0 or higher is required. Please ensure older Az modules have been uninstalled.
 
 ```powershell
-install-module Az -MinimumVersion 9.4.0
+install-module Az -MinimumVersion 12.0.0
 install-module AsBuiltReport.Microsoft.Azure
 ```
 
@@ -143,6 +143,7 @@ The **Options** schema allows certain options within the report to be toggled on
 | Sub-Schema         | Setting      | Default | Description                                                                                                                                                                              |
 |--------------------|--------------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | ShowSectionInfo | true / false | true | Toggle to enable/disable information relating to Azure resources within each section. |
+| ShowTags | true / false | true | Toggle to enable/disable the display of Azure resource tags. <br><br> _**Note:** Reporting of tags is not currently available on all Azure resources. Tags will only be displayed for Azure resources when the relevant section [InfoLevel](#infolevel) is configured to 2 or higher._ |
 
 ### Filter
 The **Filter** schema allows report content to be filtered to specific Azure subscriptions within a tenant.
@@ -189,7 +190,9 @@ The table below outlines the default and maximum **InfoLevel** settings for each
 | IpGroup               |        1        |        2        |
 | KeyVault              |        1        |        1        |
 | LoadBalancer          |        1        |        2        |
-| PolicyAssignment      |        1        |        1        |
+| NetworkSecurityGroup  |        1        |        2        |
+| Policy > Assignments  |        1        |        2        |
+| Policy > Definitions  |        0        |        1        |
 | RecoveryServicesVault |        1        |        2        |
 | RouteTable            |        1        |        2        |
 | SiteRecovery          |        1        |        1        |
@@ -205,7 +208,7 @@ The **ExpressRoute** schema is used to configure health checks for Azure Express
 
 | Sub-Schema    | Setting      | Default | Description | Highlight                                                                                         |
 |---------------|--------------|---------|-------------|---------------------------------------------------------------------------------------------------|
-| CircuitStatus | true / false | true    | Highlights ExpressRoute circuits which are not enabled | ![Critical](https://via.placeholder.com/15/FEDDD7/FEDDD7.png) ExpressRoute circuit is not enabled |
+| CircuitStatus | true / false | true    | Highlights ExpressRoute circuits which are disabled | ![Critical](https://via.placeholder.com/15/FEDDD7/FEDDD7.png) ExpressRoute circuit is disabled |
 
 #### SiteRecovery
 The **SiteRecovery** schema is used to configure health checks for Azure Site Recovery.
@@ -218,20 +221,22 @@ The **SiteRecovery** schema is used to configure health checks for Azure Site Re
 #### StorageAccount
 The **StorageAccount** schema is used to configure health checks for Azure Storage Account.
 
-| Sub-Schema             | Setting      | Default | Description | Highlight                                                                                          |
-|------------------------|--------------|---------|-------------|----------------------------------------------------------------------------------------------------|
-| ProvisioningState      | true / false | true    |             | ![Critical](https://via.placeholder.com/15/FEDDD7/FEDDD7.png) Provisioning is in a critical state  |
-| EnableHttpsTrafficOnly | true / false | true    |             | ![Warning](https://via.placeholder.com/15/FFF4C7/FFF4C7.png)                                       |
-| PublicNetworkAccess    | true / false | true    |             | ![Warning](https://via.placeholder.com/15/FFF4C7/FFF4C7.png)                                       |
-| MinimumTlsVersion      | true / false | true    |             | ![Warning](https://via.placeholder.com/15/FFF4C7/FFF4C7.png)                                       |
+| Sub-Schema              | Setting      | Default | Description | Highlight                                                                                          |
+|-------------------------|--------------|---------|-------------|----------------------------------------------------------------------------------------------------|
+| ProvisioningState       | true / false | true    | Highlights storage accounts which are in a critical state            | ![Critical](https://via.placeholder.com/15/FEDDD7/FEDDD7.png) Provisioning is in a critical state  |
+| StorageAccountKeyAccess | true / false | true    | Highlights storage accounts which have storage account key access enabled            | ![Warning](https://via.placeholder.com/15/FFF4C7/FFF4C7.png) Storage account key access is enabled                                      |
+| SecureTransfer            | true / false | true    | Highlights storage accounts which do not have secure transfer enabled           | ![Warning](https://via.placeholder.com/15/FFF4C7/FFF4C7.png) Secure transfer is disabled                                       |
+| BlobAnonymousAccess     | true / false | true    | Highlights storage accounts which have Blob anonymous read access enabled            | ![Warning](https://via.placeholder.com/15/FFF4C7/FFF4C7.png) Anonymous read access is enabled                                       |
+| PublicNetworkAccess     | true / false | true    | Highlights storage accounts which have public network access enabled            | ![Warning](https://via.placeholder.com/15/FFF4C7/FFF4C7.png) Public network access is enabled                                     |
+| MinimumTlsVersion       | true / false | true    | Highlights storage accounts which have TLS 1.0 or TLS 1.1 configured            | ![Warning](https://via.placeholder.com/15/FFF4C7/FFF4C7.png) TLS version 1.0 or 1.1 configured                                      |
 
 #### VirtualMachine
 The **VirtualMachine** schema is used to configure health checks for Azure Virtual Machines.
 
 | Sub-Schema      | Setting      | Default | Description                                                                             | Highlight                                                                                                                                                                                                               |
 |-----------------|--------------|---------|-----------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | Status          | true / false | true    | Highlights VMs which are not in a running state                                         | ![Warning](https://via.placeholder.com/15/FFF4C7/FFF4C7.png) VM is in a deallocated state                                                                                                                               |
-| DiskEncryption  | true / false | true    | Highlights VMs which do not have disk encryption enabled                                | ![Warning](https://via.placeholder.com/15/FFF4C7/FFF4C7.png) Disk encryption is not enabled                                                                                                                             |
+| DiskEncryption  | true / false | true    | Highlights VMs which do not have disk encryption enabled                                | ![Warning](https://via.placeholder.com/15/FFF4C7/FFF4C7.png) Disk encryption is disabled                                                                                                                             |
 | BootDiagnostics | true / false | true    | Highlights VMs which do not have boot diagnostics enabled with a custom storage account | ![Critical](https://via.placeholder.com/15/FEDDD7/FEDDD7.png) Boot diagnostics is disabled <br> ![Warning](https://via.placeholder.com/15/FFF4C7/FFF4C7.png) Boot diagnostics is enabled with a managed storage account |
 | BackupEnabled   | true / false | true    | Highlights VMs which do not have Azure Backup enabled                                   | ![Warning](https://via.placeholder.com/15/FFF4C7/FFF4C7.png) Backup is disabled                                                                                                                                         |
 ## :computer: Examples