Add User-Agent header with CIPP version to Graph requests

Set a default User-Agent header including the CIPP version for both GET and POST Graph API requests. The CIPP version is now stored globally in profile.ps1. Also, removed hardcoded User-Agent from Invoke-CIPPStandardAddDMARCToMOERA to use the new default behavior.

Author: JohnDuprey

Modules/CIPPCore/Public/GraphHelper/New-GraphGetRequest.ps1

@@ -47,6 +47,11 @@ function New-GraphGetRequest {
                 $headers[$key] = $extraHeaders[$key]
             }
         }
+
+        if (!$headers['User-Agent']) {
+            $headers['User-Agent'] = "CIPP/$($global:CippVersion ?? '1.0')"
+        }
+
         # Track consecutive Graph API failures
         $TenantsTable = Get-CippTable -tablename Tenants
         $Filter = "PartitionKey eq 'Tenants' and (defaultDomainName eq '{0}' or customerId eq '{0}')" -f $tenantid

Modules/CIPPCore/Public/GraphHelper/New-GraphPOSTRequest.ps1

@@ -28,6 +28,10 @@ function New-GraphPOSTRequest {
             }
         }
 
+        if (!$headers['User-Agent']) {
+            $headers['User-Agent'] = "CIPP/$($global:CippVersion ?? '1.0')"
+        }
+
         if (!$contentType) {
             $contentType = 'application/json; charset=utf-8'
         }

Modules/CIPPCore/Public/Standards/Invoke-CIPPStandardAddDMARCToMOERA.ps1

@@ -51,7 +51,7 @@ function Invoke-CIPPStandardAddDMARCToMOERA {
 
         $CurrentInfo = $Domains | ForEach-Object {
             # Get current DNS records that matches _dmarc hostname and TXT type
-            $RecordsResponse = New-GraphGetRequest -scope 'https://admin.microsoft.com/.default' -TenantID $Tenant -Uri "https://admin.microsoft.com/admin/api/Domains/Records?domainName=$($_.Name)" -extraHeaders @{'User-Agent' = 'CIPP/1.0' }
+            $RecordsResponse = New-GraphGetRequest -scope 'https://admin.microsoft.com/.default' -TenantID $Tenant -Uri "https://admin.microsoft.com/admin/api/Domains/Records?domainName=$($_.Name)"
             $AllRecords = $RecordsResponse | Select-Object -ExpandProperty DnsRecords
             $CurrentRecords = $AllRecords | Where-Object { $_.HostName -eq '_dmarc' -and $_.Type -eq 'TXT' }
             Write-Information "Found $($CurrentRecords.count) DMARC records for domain $($_.Name)"

profile.ps1

@@ -77,6 +77,8 @@ Set-Location -Path $PSScriptRoot
 $CurrentVersion = (Get-Content .\version_latest.txt).trim()
 $Table = Get-CippTable -tablename 'Version'
 Write-Information "Function App: $($env:WEBSITE_SITE_NAME) | API Version: $CurrentVersion | PS Version: $($PSVersionTable.PSVersion)"
+$global:CippVersion = $CurrentVersion
+
 $LastStartup = Get-CIPPAzDataTableEntity @Table -Filter "PartitionKey eq 'Version' and RowKey eq '$($env:WEBSITE_SITE_NAME)'"
 if (!$LastStartup -or $CurrentVersion -ne $LastStartup.Version) {
     Write-Information "Version has changed from $($LastStartup.Version ?? 'None') to $CurrentVersion"