Export-QueryLogs

SharePoint Online: Exports query logs

Script

#Requires -Version 5.1
#Requires -Modules Microsoft.Online.SharePoint.PowerShell

[CmdletBinding()]
Param(
    [Parameter(Mandatory = $true)]
    [string]$LoginName,
    [Parameter(Mandatory = $true)]
    [string]$OutputFolder,
    [datetime]$StartTime
)

Process {
    try {
        $cmdArgs = @{ ErrorAction = 'Stop'; LoginName = $LoginName; OutputFolder = $OutputFolder }
        if (($null -ne $StartTime) -and ($StartTime.Year -gt 2018)) { $cmdArgs.Add('StartTime', $StartTime) }
        Export-SPOQueryLogs @cmdArgs | Out-Null
        [PSCustomObject]@{ Timestamp = Get-Date -Format "yyyy-MM-dd HH:mm:ss"; Status = "Success"; Message = "Query logs exported for '$LoginName' to '$OutputFolder'" }
    }
    catch { throw }
}

Customize

LoginName string

OutputFolder string

Target folder where the CSV file is generated

StartTime datetime

Point in time to export logs from