Merge pull request #156 from CriticalSolutionsNetwork/Bugfix--Fix-SPO-output-for-Get-SPOSite

fix: Fix SPO output for Get-SPOSite

CHANGELOG.md

@@ -4,6 +4,20 @@ The format is based on and uses the types of changes according to [Keep a Change
 
 ## [Unreleased]
 
+### Fixed
+
+- Get-SPOSite command to return all but voided output for no code runs (Ex: PowerAutomate)
+
+## [0.1.27] - 2025-01-13
+
+### Added
+
+- Added additional error handling to connect function to identify problematic steps when they occur.
+- Added new method of verifying spo tenant for Connect-SPOService branch of connect function.
+- Added method to avoid "assembly already loaded" error in PNP Powershell function on first run, subsequent runs in the same session will still throw the error.
+
+## [0.1.26] - 2024-08-04
+
 ### Added
 
 - Added `New-M365SecurityAuditAuthObject` function to create a new authentication object for the security audit for app-based authentication.
@@ -19,7 +33,6 @@ The format is based on and uses the types of changes according to [Keep a Change
 
 - Fixed test 1.3.1 as notification window for password expiration is no longer required.
 
-
 ## [0.1.24] - 2024-07-07
 
 ### Added

README copy.md

@@ -1,5 +1,6 @@
 # M365FoundationsCISReport Module
 [![PSScriptAnalyzer](https://github.com/CriticalSolutionsNetwork/M365FoundationsCISReport/actions/workflows/powershell.yml/badge.svg)](https://github.com/CriticalSolutionsNetwork/M365FoundationsCISReport/actions/workflows/powershell.yml)
+[![pages-build-deployment](https://github.com/CriticalSolutionsNetwork/M365FoundationsCISReport/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/CriticalSolutionsNetwork/M365FoundationsCISReport/actions/workflows/pages/pages-build-deployment)
 ## License
 
 This PowerShell module is based on CIS benchmarks and is distributed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. This means:
@@ -76,11 +77,12 @@ Sync-CISExcelAndCsvData -ExcelPath "path\to\excel.xlsx" -CsvPath "path\to\data.c
 Grant-M365SecurityAuditConsent -UserPrincipalNameForConsent 'user@example.com'
 
 # Example 8: (PowerShell 7.x Only) Creating a new authentication object for the security audit for app-based authentication.
-$authParams = New-M365SecurityAuditAuthObject -ClientCertThumbPrint "ABCDEF1234567890ABCDEF1234567890ABCDEF12" `
-                                                            -ClientId "12345678-1234-1234-1234-123456789012" `
-                                                            -TenantId "12345678-1234-1234-1234-123456789012" `
-                                                            -OnMicrosoftUrl "yourcompany.onmicrosoft.com" `
-                                                            -SpAdminUrl "https://yourcompany-admin.sharepoint.com"
+$authParams = New-M365SecurityAuditAuthObject `
+  -ClientCertThumbPrint "ABCDEF1234567890ABCDEF1234567890ABCDEF12" `
+  -ClientId "12345678-1234-1234-1234-123456789012" `
+  -TenantId "12345678-1234-1234-1234-123456789012" `
+  -OnMicrosoftUrl "yourcompany.onmicrosoft.com" `
+  -SpAdminUrl "https://yourcompany-admin.sharepoint.com"
 Invoke-M365SecurityAudit -AuthParams $authParams -TenantAdminUrl "https://yourcompany-admin.sharepoint.com"
 ```
 

README.md

@@ -1,5 +1,6 @@
 # M365FoundationsCISReport Module
 [![PSScriptAnalyzer](https://github.com/CriticalSolutionsNetwork/M365FoundationsCISReport/actions/workflows/powershell.yml/badge.svg)](https://github.com/CriticalSolutionsNetwork/M365FoundationsCISReport/actions/workflows/powershell.yml)
+[![pages-build-deployment](https://github.com/CriticalSolutionsNetwork/M365FoundationsCISReport/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/CriticalSolutionsNetwork/M365FoundationsCISReport/actions/workflows/pages/pages-build-deployment)
 ## License
 
 This PowerShell module is based on CIS benchmarks and is distributed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. This means:
@@ -76,11 +77,12 @@ Sync-CISExcelAndCsvData -ExcelPath "path\to\excel.xlsx" -CsvPath "path\to\data.c
 Grant-M365SecurityAuditConsent -UserPrincipalNameForConsent 'user@example.com'
 
 # Example 8: (PowerShell 7.x Only) Creating a new authentication object for the security audit for app-based authentication.
-$authParams = New-M365SecurityAuditAuthObject -ClientCertThumbPrint "ABCDEF1234567890ABCDEF1234567890ABCDEF12" `
-                                                            -ClientId "12345678-1234-1234-1234-123456789012" `
-                                                            -TenantId "12345678-1234-1234-1234-123456789012" `
-                                                            -OnMicrosoftUrl "yourcompany.onmicrosoft.com" `
-                                                            -SpAdminUrl "https://yourcompany-admin.sharepoint.com"
+$authParams = New-M365SecurityAuditAuthObject `
+  -ClientCertThumbPrint "ABCDEF1234567890ABCDEF1234567890ABCDEF12" `
+  -ClientId "12345678-1234-1234-1234-123456789012" `
+  -TenantId "12345678-1234-1234-1234-123456789012" `
+  -OnMicrosoftUrl "yourcompany.onmicrosoft.com" `
+  -SpAdminUrl "https://yourcompany-admin.sharepoint.com"
 Invoke-M365SecurityAudit -AuthParams $authParams -TenantAdminUrl "https://yourcompany-admin.sharepoint.com"
 ```
 

helpers/Build-Help.ps1

@@ -5,10 +5,10 @@ Import-Module .\output\module\M365FoundationsCISReport\*\*.psd1
 
 
 <#
-    $ver = "v0.1.26"
+    $ver = "v0.1.28"
     git checkout main
     git pull origin main
-    git tag -a $ver -m "Release version $ver refactor Update"
+    git tag -a $ver -m "Release version $ver bugfix Update"
     git push origin $ver
     "Fix: PR #37"
     git push origin $ver
@@ -53,8 +53,8 @@ Register-SecretVault -Name ModuleBuildCreds -ModuleName `
 "SecretManagement.JustinGrote.CredMan" -ErrorAction Stop
 
 
-Set-Secret -Name "GalleryApiToken" -Vault ModuleBuildCreds
-Set-Secret -Name "GitHubToken" -Vault ModuleBuildCreds
+#Set-Secret -Name "GalleryApiToken" -Vault ModuleBuildCreds
+#Set-Secret -Name "GitHubToken" -Vault ModuleBuildCreds
 
 
 $GalleryApiToken = Get-Secret -Name "GalleryApiToken" -Vault ModuleBuildCreds -AsPlainText

source/Private/Assert-ModuleAvailability.ps1

@@ -20,6 +20,17 @@ function Assert-ModuleAvailability {
                 else {
                     Write-Verbose "$ModuleName module is already at required version or newer."
                 }
+                if ($ModuleName -eq "Microsoft.Graph") {
+                    # "Preloading Microsoft.Graph assembly to prevent type-loading issues..."
+                    Write-Verbose "Preloading Microsoft.Graph assembly to prevent type-loading issues..."
+                    try {
+                        # Run a harmless cmdlet to preload the assembly
+                        Get-MgGroup -Top 1 -ErrorAction SilentlyContinue | Out-Null
+                    }
+                    catch {
+                        Write-Verbose "Could not preload Microsoft.Graph assembly. Error: $_"
+                    }
+                }
                 if ($SubModules.Count -gt 0) {
                     foreach ($subModule in $SubModules) {
                         Write-Verbose "Importing submodule $ModuleName.$subModule..."
@@ -30,11 +41,9 @@ function Assert-ModuleAvailability {
                     Write-Verbose "Importing module $ModuleName..."
                     Import-Module -Name $ModuleName -RequiredVersion $RequiredVersion -ErrorAction Stop -WarningAction SilentlyContinue | Out-Null
                 }
-
         }
         catch {
             throw "Assert-ModuleAvailability:`n$_"
         }
     }
-
-}
+}

source/Private/Connect-M365Suite.ps1

@@ -2,135 +2,144 @@ function Connect-M365Suite {
     [OutputType([void])]
     [CmdletBinding()]
     param (
-        [Parameter(
-            Mandatory = $false
-        )]
+        [Parameter(Mandatory = $false)]
         [string]$TenantAdminUrl,
-        [Parameter(
-            Mandatory = $false
-        )]
-        [CISAuthenticationParameters]$AuthParams, # Custom authentication parameters
-        [Parameter(
-            Mandatory
-        )]
+
+        [Parameter(Mandatory = $false)]
+        [CISAuthenticationParameters]$AuthParams,
+
+        [Parameter(Mandatory)]
         [string[]]$RequiredConnections,
-        [Parameter(
-            Mandatory = $false
-        )]
+
+        [Parameter(Mandatory = $false)]
         [switch]$SkipConfirmation
     )
-    if (!$SkipConfirmation) {
-        $VerbosePreference = "Continue"
-    }
-    else {
-        $VerbosePreference = "SilentlyContinue"
-    }
+
+    $VerbosePreference = if ($SkipConfirmation) { 'SilentlyContinue' } else { 'Continue' }
     $tenantInfo = @()
     $connectedServices = @()
+
     try {
-        if ($RequiredConnections -contains "Microsoft Graph" -or $RequiredConnections -contains "EXO | Microsoft Graph") {
-            Write-Verbose "Connecting to Microsoft Graph"
-            if ($AuthParams) {
-                # Use application-based authentication
-                Connect-MgGraph -CertificateThumbprint $AuthParams.ClientCertThumbPrint -AppId $AuthParams.ClientId -TenantId $AuthParams.TenantId -NoWelcome | Out-Null
+        if ($RequiredConnections -contains 'Microsoft Graph' -or $RequiredConnections -contains 'EXO | Microsoft Graph') {
+            try {
+                Write-Verbose 'Connecting to Microsoft Graph...'
+                if ($AuthParams) {
+                    Connect-MgGraph -CertificateThumbprint $AuthParams.ClientCertThumbPrint -AppId $AuthParams.ClientId -TenantId $AuthParams.TenantId -NoWelcome | Out-Null
+                }
+                else {
+                    Connect-MgGraph -Scopes 'Directory.Read.All', 'Domain.Read.All', 'Policy.Read.All', 'Organization.Read.All' -NoWelcome | Out-Null
+                }
+                $graphOrgDetails = Get-MgOrganization
+                $tenantInfo += [PSCustomObject]@{
+                    Service    = 'Microsoft Graph'
+                    TenantName = $graphOrgDetails.DisplayName
+                    TenantID   = $graphOrgDetails.Id
+                }
+                $connectedServices += 'Microsoft Graph'
+                Write-Verbose 'Successfully connected to Microsoft Graph.'
             }
-            else {
-                # Use interactive authentication with scopes
-                Connect-MgGraph -Scopes "Directory.Read.All", "Domain.Read.All", "Policy.Read.All", "Organization.Read.All" -NoWelcome | Out-Null
+            catch {
+                throw "Failed to connect to Microsoft Graph: $($_.Exception.Message)"
             }
-            $graphOrgDetails = Get-MgOrganization
-            $tenantInfo += [PSCustomObject]@{
-                Service    = "Microsoft Graph"
-                TenantName = $graphOrgDetails.DisplayName
-                TenantID   = $graphOrgDetails.Id
-            }
-            $connectedServices += "Microsoft Graph"
-            Write-Verbose "Successfully connected to Microsoft Graph.`n"
         }
-        if ($RequiredConnections -contains "EXO" -or $RequiredConnections -contains "AzureAD | EXO" -or $RequiredConnections -contains "Microsoft Teams | EXO" -or $RequiredConnections -contains "EXO | Microsoft Graph") {
-            Write-Verbose "Connecting to Exchange Online..."
-            if ($AuthParams) {
-                # Use application-based authentication
-                Connect-ExchangeOnline -AppId $AuthParams.ClientId -CertificateThumbprint $AuthParams.ClientCertThumbPrint -Organization $AuthParams.OnMicrosoftUrl -ShowBanner:$false | Out-Null
+
+        if ($RequiredConnections -contains 'EXO' -or $RequiredConnections -contains 'AzureAD | EXO' -or $RequiredConnections -contains 'Microsoft Teams | EXO' -or $RequiredConnections -contains 'EXO | Microsoft Graph') {
+            try {
+                Write-Verbose 'Connecting to Exchange Online...'
+                if ($AuthParams) {
+                    Connect-ExchangeOnline -AppId $AuthParams.ClientId -CertificateThumbprint $AuthParams.ClientCertThumbPrint -Organization $AuthParams.OnMicrosoftUrl -ShowBanner:$false | Out-Null
+                }
+                else {
+                    Connect-ExchangeOnline -ShowBanner:$false | Out-Null
+                }
+                $exoTenant = (Get-OrganizationConfig).Identity
+                $tenantInfo += [PSCustomObject]@{
+                    Service    = 'Exchange Online'
+                    TenantName = $exoTenant
+                    TenantID   = 'N/A'
+                }
+                $connectedServices += 'EXO'
+                Write-Verbose 'Successfully connected to Exchange Online.'
             }
-            else {
-                # Use interactive authentication
-                Connect-ExchangeOnline -ShowBanner:$false | Out-Null
+            catch {
+                throw "Failed to connect to Exchange Online: $($_.Exception.Message)"
             }
-            $exoTenant = (Get-OrganizationConfig).Identity
-            $tenantInfo += [PSCustomObject]@{
-                Service    = "Exchange Online"
-                TenantName = $exoTenant
-                TenantID   = "N/A"
-            }
-            $connectedServices += "EXO"
-            Write-Verbose "Successfully connected to Exchange Online.`n"
         }
-        if ($RequiredConnections -contains "SPO") {
-            Write-Verbose "Connecting to SharePoint Online..."
-            if ($AuthParams) {
-                # Use application-based authentication
-                Connect-PnPOnline -Url $AuthParams.SpAdminUrl -ClientId $AuthParams.ClientId -Tenant $AuthParams.OnMicrosoftUrl -Thumbprint $AuthParams.ClientCertThumbPrint | Out-Null
+
+        if ($RequiredConnections -contains 'SPO') {
+            try {
+                Write-Verbose 'Connecting to SharePoint Online...'
+                if ($AuthParams) {
+                    Connect-PnPOnline -Url $AuthParams.SpAdminUrl -ClientId $AuthParams.ClientId -Tenant $AuthParams.OnMicrosoftUrl -Thumbprint $AuthParams.ClientCertThumbPrint | Out-Null
+                }
+                else {
+                    Connect-SPOService -Url $TenantAdminUrl | Out-Null
+                }
+                $tenantName = if ($AuthParams) {
+                    (Get-PnPSite).Url
+                }
+                else {
+                    # Supress output from Get-SPOSite for powerautomate to avoid errors
+                    [void]($sites =  Get-SPOSite -Limit All)
+                    # Get the URL from the first site collection
+                    $url = $sites[0].Url
+                    # Use regex to extract the base URL up to the .com portion
+                    $baseUrl = [regex]::Match($url, 'https://[^/]+.com').Value
+                    # Output the base URL
+                    $baseUrl
+                }
+                $tenantInfo += [PSCustomObject]@{
+                    Service    = 'SharePoint Online'
+                    TenantName = $tenantName
+                }
+                $connectedServices += 'SPO'
+                Write-Verbose 'Successfully connected to SharePoint Online.'
             }
-            else {
-                # Use interactive authentication
-                Connect-SPOService -Url $TenantAdminUrl | Out-Null
+            catch {
+                throw "Failed to connect to SharePoint Online: $($_.Exception.Message)"
             }
-            # Assuming that Get-SPOCrossTenantHostUrl and Get-UrlLine are valid commands in your context
-            if ($AuthParams) {
-                $spoContext = Get-PnPSite
-                $tenantName = $spoContext.Url
-            }
-            else {
-                $spoContext = Get-SPOCrossTenantHostUrl
-                $tenantName = Get-UrlLine -Output $spoContext
-            }
-            $tenantInfo += [PSCustomObject]@{
-                Service    = "SharePoint Online"
-                TenantName = $tenantName
-            }
-            $connectedServices += "SPO"
-            Write-Verbose "Successfully connected to SharePoint Online.`n"
         }
-        if ($RequiredConnections -contains "Microsoft Teams" -or $RequiredConnections -contains "Microsoft Teams | EXO") {
-            Write-Verbose "Connecting to Microsoft Teams..."
-            if ($AuthParams) {
-                # Use application-based authentication
-                Connect-MicrosoftTeams -TenantId $AuthParams.TenantId -CertificateThumbprint $AuthParams.ClientCertThumbPrint -ApplicationId $AuthParams.ClientId | Out-Null
+
+        if ($RequiredConnections -contains 'Microsoft Teams' -or $RequiredConnections -contains 'Microsoft Teams | EXO') {
+            try {
+                Write-Verbose 'Connecting to Microsoft Teams...'
+                if ($AuthParams) {
+                    Connect-MicrosoftTeams -TenantId $AuthParams.TenantId -CertificateThumbprint $AuthParams.ClientCertThumbPrint -ApplicationId $AuthParams.ClientId | Out-Null
+                }
+                else {
+                    Connect-MicrosoftTeams | Out-Null
+                }
+                $teamsTenantDetails = Get-CsTenant
+                $tenantInfo += [PSCustomObject]@{
+                    Service    = 'Microsoft Teams'
+                    TenantName = $teamsTenantDetails.DisplayName
+                    TenantID   = $teamsTenantDetails.TenantId
+                }
+                $connectedServices += 'Microsoft Teams'
+                Write-Verbose 'Successfully connected to Microsoft Teams.'
             }
-            else {
-                # Use interactive authentication
-                Connect-MicrosoftTeams | Out-Null
+            catch {
+                throw "Failed to connect to Microsoft Teams: $($_.Exception.Message)"
             }
-            $teamsTenantDetails = Get-CsTenant
-            $tenantInfo += [PSCustomObject]@{
-                Service    = "Microsoft Teams"
-                TenantName = $teamsTenantDetails.DisplayName
-                TenantID   = $teamsTenantDetails.TenantId
-            }
-            $connectedServices += "Microsoft Teams"
-            Write-Verbose "Successfully connected to Microsoft Teams.`n"
         }
-        # Display tenant information and confirm with the user
+
         if (-not $SkipConfirmation) {
-            Write-Verbose "Connected to the following tenants:"
+            Write-Verbose 'Connected to the following tenants:'
             foreach ($tenant in $tenantInfo) {
-                Write-Verbose "Service: $($tenant.Service)"
-                Write-Verbose "Tenant Context: $($tenant.TenantName)`n"
-                #Write-Verbose "Tenant ID: $($tenant.TenantID)"
+                Write-Verbose "Service: $($tenant.Service) | Tenant: $($tenant.TenantName)"
             }
-            $confirmation = Read-Host "Do you want to proceed with these connections? (Y/N)"
-            if ($confirmation -notLike 'Y') {
-                Write-Verbose "Connection setup aborted by user."
+            $confirmation = Read-Host 'Do you want to proceed with these connections? (Y/N)'
+            if ($confirmation -notlike 'Y') {
                 Disconnect-M365Suite -RequiredConnections $connectedServices
-                throw "User aborted connection setup."
+                throw 'User aborted connection setup.'
             }
         }
     }
     catch {
-        $CatchError = $_
-        $VerbosePreference = "Continue"
-        throw $CatchError
+        $VerbosePreference = 'Continue'
+        throw "Connection failed: $($_.Exception.Message)"
     }
-    $VerbosePreference = "Continue"
-}
+    finally {
+        $VerbosePreference = 'Continue'
+    }
+}