Merge pull request #21 from maester365/merill-patch-1

Added Invoke-MtGraphRequest
maester365 · Jan 14, 2024 · 1e5ec40 · 1e5ec40
2 parents b2e1735 + 7ea6c94
commit 1e5ec40
Show file tree

Hide file tree

Showing 14 changed files with 194 additions and 165 deletions.
diff --git a/src/Maester.psd1 b/src/Maester.psd1
@@ -8,129 +8,130 @@
 
 @{
 
-# Script module or binary module file associated with this manifest.
-RootModule = 'Maester.psm1'
+    # Script module or binary module file associated with this manifest.
+    RootModule           = 'Maester.psm1'
 
-# Version number of this module.
-ModuleVersion = '0.0.10'
+    # Version number of this module.
+    ModuleVersion        = '0.0.10'
 
-# Supported PSEditions
-CompatiblePSEditions = 'Core', 'Desktop'
+    # Supported PSEditions
+    CompatiblePSEditions = 'Core', 'Desktop'
 
-# ID used to uniquely identify this module
-GUID = '502a7fe7-b1ae-4bf5-98db-00831b14ed6f'
+    # ID used to uniquely identify this module
+    GUID                 = '502a7fe7-b1ae-4bf5-98db-00831b14ed6f'
 
-# Author of this module
-Author = 'Microsoft Identity'
+    # Author of this module
+    Author               = 'Microsoft Identity'
 
-# Company or vendor of this module
-CompanyName = 'Microsoft Corporation'
+    # Company or vendor of this module
+    CompanyName          = 'Microsoft Corporation'
 
-# Copyright statement for this module
-Copyright = 'Microsoft Corporation. All rights reserved.'
+    # Copyright statement for this module
+    Copyright            = 'Microsoft Corporation. All rights reserved.'
 
-# Description of the functionality provided by this module
-Description = 'This cmdlets in this module help you write Pester tests for your Microsoft 365 tenant configuration.'
+    # Description of the functionality provided by this module
+    Description          = 'This cmdlets in this module help you write Pester tests for your Microsoft 365 tenant configuration.'
 
-# Minimum version of the PowerShell engine required by this module
-PowerShellVersion = '5.1'
+    # Minimum version of the PowerShell engine required by this module
+    PowerShellVersion    = '5.1'
 
-# Name of the PowerShell host required by this module
-# PowerShellHostName = ''
+    # Name of the PowerShell host required by this module
+    # PowerShellHostName = ''
 
-# Minimum version of the PowerShell host required by this module
-# PowerShellHostVersion = ''
+    # Minimum version of the PowerShell host required by this module
+    # PowerShellHostVersion = ''
 
-# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
-# DotNetFrameworkVersion = ''
+    # Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
+    # DotNetFrameworkVersion = ''
 
-# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
-# ClrVersion = ''
+    # Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
+    # ClrVersion = ''
 
-# Processor architecture (None, X86, Amd64) required by this module
-# ProcessorArchitecture = ''
+    # Processor architecture (None, X86, Amd64) required by this module
+    # ProcessorArchitecture = ''
 
-# Modules that must be imported into the global environment prior to importing this module
-RequiredModules = @(@{ModuleName = 'Microsoft.Graph.Authentication'; GUID = '883916f2-9184-46ee-b1f8-b6a2fb784cee'; ModuleVersion = '2.2.0'; })
+    # Modules that must be imported into the global environment prior to importing this module
+    RequiredModules      = @(@{ModuleName = 'Microsoft.Graph.Authentication'; GUID = '883916f2-9184-46ee-b1f8-b6a2fb784cee'; ModuleVersion = '2.2.0'; })
 
-# Assemblies that must be loaded prior to importing this module
-# RequiredAssemblies = @()
+    # Assemblies that must be loaded prior to importing this module
+    # RequiredAssemblies = @()
 
-# Script files (.ps1) that are run in the caller's environment prior to importing this module.
-# ScriptsToProcess = @()
+    # Script files (.ps1) that are run in the caller's environment prior to importing this module.
+    # ScriptsToProcess = @()
 
-# Type files (.ps1xml) to be loaded when importing this module
-# TypesToProcess = @()
+    # Type files (.ps1xml) to be loaded when importing this module
+    # TypesToProcess = @()
 
-# Format files (.ps1xml) to be loaded when importing this module
-# FormatsToProcess = @()
+    # Format files (.ps1xml) to be loaded when importing this module
+    # FormatsToProcess = @()
 
-# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
-NestedModules = @()
+    # Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
+    NestedModules        = @()
 
-# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
-FunctionsToExport = 'Get-MtConditionalAccessPolicies', 
-               'Test-MtAppManagementPolicyEnabled', 'Test-MtCaAllAppsExists', 
-               'Test-MtCaDeviceComplianceExists', 'Test-MtCaEmergencyAccessExists', 
-               'Test-MtCaMfaForAdmins', 'Test-MtCaMfaForAllUsers', 
-               'Test-MtConditionalAccessWhatIf'
+    # Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
+    FunctionsToExport    = 'Get-MtConditionalAccessPolicies',
+    'Invoke-MtGraphRequest', 'Clear-MtGraphCache',
+    'Test-MtAppManagementPolicyEnabled', 'Test-MtCaAllAppsExists',
+    'Test-MtCaDeviceComplianceExists', 'Test-MtCaEmergencyAccessExists',
+    'Test-MtCaMfaForAdmins', 'Test-MtCaMfaForAllUsers',
+    'Test-MtConditionalAccessWhatIf'
 
-# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
-CmdletsToExport = @()
+    # Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
+    CmdletsToExport      = @()
 
-# Variables to export from this module
-# VariablesToExport = @()
+    # Variables to export from this module
+    # VariablesToExport = @()
 
-# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
-AliasesToExport = @()
+    # Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
+    AliasesToExport      = @()
 
-# DSC resources to export from this module
-# DscResourcesToExport = @()
+    # DSC resources to export from this module
+    # DscResourcesToExport = @()
 
-# List of all modules packaged with this module
-# ModuleList = @()
+    # List of all modules packaged with this module
+    # ModuleList = @()
 
-# List of all files packaged with this module
-# FileList = @()
+    # List of all files packaged with this module
+    # FileList = @()
 
-# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
-PrivateData = @{
+    # Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
+    PrivateData          = @{
 
-    PSData = @{
+        PSData = @{
 
-        # Tags applied to this module. These help with module discovery in online galleries.
-        Tags = 'Microsoft','365','Cloud','Test','Pester','Entra','AzureAD','Automation','Regression','DevOps'
+            # Tags applied to this module. These help with module discovery in online galleries.
+            Tags       = 'Microsoft', '365', 'Cloud', 'Test', 'Pester', 'Entra', 'AzureAD', 'Automation', 'Regression', 'DevOps'
 
-        # A URL to the license for this module.
-        LicenseUri = 'https://raw.githubusercontent.com/microsoft/maester/main/LICENSE'
+            # A URL to the license for this module.
+            LicenseUri = 'https://raw.githubusercontent.com/microsoft/maester/main/LICENSE'
 
-        # A URL to the main website for this project.
-        ProjectUri = 'https://github.com/microsoft/maester'
+            # A URL to the main website for this project.
+            ProjectUri = 'https://github.com/microsoft/maester'
 
-        # A URL to an icon representing this module.
-        # IconUri = ''
+            # A URL to an icon representing this module.
+            # IconUri = ''
 
-        # ReleaseNotes of this module
-        # ReleaseNotes = ''
+            # ReleaseNotes of this module
+            # ReleaseNotes = ''
 
-        # Prerelease string of this module
-        # Prerelease = ''
+            # Prerelease string of this module
+            # Prerelease = ''
 
-        # Flag to indicate whether the module requires explicit user acceptance for install/update/save
-        # RequireLicenseAcceptance = $false
+            # Flag to indicate whether the module requires explicit user acceptance for install/update/save
+            # RequireLicenseAcceptance = $false
 
-        # External dependent modules of this module
-        # ExternalModuleDependencies = @()
+            # External dependent modules of this module
+            # ExternalModuleDependencies = @()
 
-    } # End of PSData hashtable
+        } # End of PSData hashtable
 
- } # End of PrivateData hashtable
+    } # End of PrivateData hashtable
 
-# HelpInfo URI of this module
-# HelpInfoURI = ''
+    # HelpInfo URI of this module
+    # HelpInfoURI = ''
 
-# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
-# DefaultCommandPrefix = ''
+    # Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
+    # DefaultCommandPrefix = ''
 
 }
 
diff --git a/src/internal/Get-CacheValue.ps1 b/src/internal/Get-CacheValue.ps1
diff --git a/src/internal/Invoke-MtGraphRequestCache.ps1 b/src/internal/Invoke-MtGraphRequestCache.ps1
@@ -0,0 +1,45 @@
+<#
+.SYNOPSIS
+    Enhanced version of Invoke-MgGraphRequest that supports caching.
+#>
+Function Invoke-MtGraphRequestCache {
+    [CmdletBinding()]
+    param(
+        [Parameter(Mandatory = $true)]
+        [Uri] $Uri,
+        [Parameter(Mandatory = $false)]
+        [string] $Method = 'GET',
+        [Parameter(Mandatory = $false)]
+        [string] $OutputType,
+        [Parameter(Mandatory = $false)]
+        [System.Collections.IDictionary] $Headers,
+        # Specify if this request should skip cache and go directly to Graph.
+        [Parameter(Mandatory = $false)]
+        [switch] $DisableCache
+    )
+
+    $results = $null
+    $isBatch = $uri.AbsoluteUri.EndsWith('$batch')
+    $isInCache = $MtGraphCache.ContainsKey($Uri.AbsoluteUri)
+    $cacheKey = $Uri.AbsoluteUri
+    $isMethodGet = $Method -eq 'GET'
+
+    if (!$DisableCache -and !$isBatch -and $isInCache -and $isMethodGet) {
+        # Don't read from cache for batch requests.
+        Write-Verbose ("Checking cache: $($cacheKey)")
+        $results = $MtGraphCache[$cacheKey]
+    }
+
+    if (!$results) {
+        $results = Invoke-MgGraphRequest -Method $Method -Uri $Uri -Headers $Headers -OutputType $OutputType
+        if (!$isBatch -and $isMethodGet) {
+            # Update cache
+            if ($isInCache) {
+                $MtGraphCache[$cacheKey] = $results
+            } else {
+                $MtGraphCache.Add($cacheKey, $results)
+            }
+        }
+    }
+    return $results
+}
diff --git a/src/internal/Set-CacheValue.ps1 b/src/internal/Set-CacheValue.ps1
diff --git a/src/public/Clear-MtGraphCache.ps1 b/src/public/Clear-MtGraphCache.ps1
@@ -0,0 +1,9 @@
+
+<#
+.SYNOPSIS
+    Resets the local cache of Graph API calls. Use this if you need to force a refresh of the cache in the current session.
+
+#>
+function Clear-MtGraphCache {
+    $MtGraphCache.Clear()
+}
diff --git a/src/public/Get-MtConditionalAccessPolicies.ps1 b/src/public/Get-MtConditionalAccessPolicies.ps1
@@ -10,20 +10,8 @@
 
 Function Get-MtConditionalAccessPolicies {
   [CmdletBinding()]
-  param(
-    [switch]$Force
-  )
+  param()
 
-  $uri = 'https://graph.microsoft.com/beta/identity/conditionalAccess/policies'
-  $result = Get-CacheValue $uri
+  return Invoke-MtGraphRequest -RelativeUri 'identity/conditionalAccess/policies' -ApiVersion beta
 
-  if (!$result -or $Force) {
-    $result = Invoke-GraphRequest -Uri 'https://graph.microsoft.com/beta/identity/conditionalAccess/policies' -OutputType PSObject
-    if ($result) {
-      Set-CacheValue -Key $uri -Value $result
-    }
-
-  }
-
-  return $result
 }