This add-on collects Message Trace data from Microsoft Office 365 including the following:
The Microsoft API used by the add-on currently supports both Basic Authentication (username and password) and Modern Authentication (OAuth).
Create an Azure AD App Registration
Assign Azure AD roles to the application
The supported roles for the application to access the Reporting Web Service are:
For general instructions about assigning roles in Azure AD, see View and assign administrator roles in Azure Active Directory.
Specify the permissions your app requires to access the Reporting Web Service
Note: Basic Authentication has been deprecated by Microsoft. Using Modern Authentication (OAuth) is recommended for data collection.
If using Basic Authentication, creating a new role for the user account with the following permissions is recommended:
Unless otherwise noted, all supported add-ons can be safely installed to all tiers of a distributed Splunk platform deployment. See Where to install Splunk add-ons in Splunk Add-ons for more information.
This table provides a reference for installing this specific add-on to a distributed deployment of Splunk Enterprise.
|Splunk platform component||Supported||Required||Comments|
|Search Heads||Yes||Yes||This add-on contains search-time knowledge. It is recommended to turn visibility off on your search heads to prevent data duplication errors that can result from running inputs on your search heads instead of (or in addition to) on your data collection node.|
|Heavy Forwarders||Yes||No (but recommended)||It is recommended to install this add-on on a heavy forwarder for data collection. Data collection should be configured in only 1 place to avoid duplicates.|
|Indexers||Yes||No||Not required as the parsing operations occur on the forwarders.|
|Universal Forwarders||No||No||Universal forwarders are not supported for data collection because the modular inputs require Python and the Splunk REST handler.|
Ensure the prerequisites are met above.
Connect to Exchange Online
From the Azure portal, start a cloud shell (PowerShell)
$Credential = Get-Credential
$ExchangeSession = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri "https://outlook.office365.com/powershell-liveid" -Credential $credential -Authentication "Basic" -AllowRedirection
Create/set the policy
New-AuthenticationPolicy -Name "Allow Basic Auth for Reporting Web Service"
Set-AuthenticationPolicy -Identity "Allow Basic Auth for Reporting Web Service" -AllowBasicAuthReportingWebServices:$true
Check the policy settings
Get-AuthenticationPolicy -Identity "Allow Basic Auth for Reporting Web Service" | fl AllowBasicAuth*
(You should see AllowBasicAuthReportingWebServices : True in the list returned)
Next, grant a specific user the created policy (the username is LegacyUser in this case):
Set-User -Identity LegacyUser -AuthenticationPolicy "Allow Basic Auth for Reporting Web Service"
Finally, check if all went well:
Get-User -Identity LegacyUser | fl auth*
You should see something like this:
AuthenticationPolicy : Allow Basic Auth for Reporting Web Service
Name : LegacyUser
nameparameter to the
default/app.conffor Splunk Cloud Self Service installs
6.0.6to address potential credential corruption issues
Data collection improvements
Updates for Python3 insepection.
As a Splunkbase app developer, you will have access to all Splunk development resources and receive a 10GB license to build an app that will help solve use cases for customers all over the world. Splunkbase has 1000+ apps from Splunk, our partners and our community. Find an app for most any data source and user need, or simply create your own with help from our developer portal.