Splunk® Data Stream Processor

Function Reference

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

Get data from Microsoft 365

Use the Microsoft 365 source function to get data from the Office 365 Management Activity API.

Prerequisites

Before you can use this function, you must create a connection. See Create a DSP connection to Microsoft 365 in the Connect to Data Sources and Destinations with the manual. When configuring this source function, set the connection_id argument to the ID of that connection.

Function output schema

This function outputs data pipeline events using the event schema.

The following is an example of a typical record from the read_from_microsoft_365 function:

{
"attributes": {
     "ClientIP":"123.45.12.345",
     "CreationTime":"2020-08-31T18:44:34",
     "Id":"23fe99c2-4f39-4d86-9162-0a36701bdc85",
     "ObjectId":"0f597bb3-f012-4d56-a22e-b36518dca7e6",
     "Operation":"UserLoggedIn",
     "OrganizationId":"2cd38a70-1d3f-4627-6230-fa389c77d35c",
     "RecordType":15,"ResultStatus":"Succeeded",
     "Scope":"",
     "UserId":"jsmith@a5w0u1wh2q71039m3oz61p.onmicrosoft.com",
     "UserKey":"11074000DE28A7D6@a630edad8160942nba2078.onmicrosoft.com",
     "UserType":0,"Workload":"AzureActiveDirectory"
     },
"body": {
     "Actor": [
          {
          "ID":"b247bcd5-a171-bcc4-ad6d-9a28ed37dbc5",
          "Type":0
          },
          {
          "ID":"jsmith@a5w0u1wh2q71039m3oz61p.onmicrosoft.com",
          "Type":5
          },
          {
          "ID":"11074000DE28A7D6","Type":3
          }
     ],
     "ActorContextId":"2cd38a70-1d3f-4627-6230-fa389c77d35c",
     "ActorIpAddress":"123.45.12.345",
     "ApplicationId":"a213rde3-cdbl-al7e-d8b2-56cab4cde10d",
     "AzureActiveDirectoryEventType":1,
     "ClientIP":"123.45.12.345",
     "CreationTime":"2020-08-31T18:44:34",
     "ExtendedProperties": [
          {
          "Name":"UserAgent",
          "Value":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/84.0.4147.135 Safari/537.36"
          },
          {
          "Name":"UserAuthenticationMethod",
          "Value":"1"
          },
          {
          "Name":"RequestType",
          "Value":"OAuth2:Authorize"
          },
          {
          "Name":"ResultStatusDetail",
          "Value":"Redirect"
          },
          {
          "Name":"KeepMeSignedIn",
          "Value":"False"
          }
     ],
     "Id":"23fe99c2-4f39-4d86-9162-0a36701bdc85",
     "InterSystemsId":"da1a0efb-2ceb-4acf-ce7d-123d17d3a5bc",
     "IntraSystemId":"cal7ab7b-dce1-4b7a-c45d-09dce216a123b",
     "ModifiedProperties":null,
     "ObjectId":"0f597bb3-f012-4d56-a22e-b36518dca7e6",
     "OrganizationId":"2ed28a74-1f6f-4829-8530-fe359c77d35c",
     "Operation":"UserLoggedIn",
     "RecordType":15,
     "ResultStatus":"Succeeded",
     "SupportTicketId":"",
     "Target": [
          {
          "ID":"0f597bb3-f012-4d56-a22e-b36518dca7e6",
          "Type":0
          }
     ],
     "TargetContextId":"2cd38a70-1d3f-4627-6230-fa389c77d35c",
     "UserId":"dspio@a830edad9050849nda3079.onmicrosoft.com",
     "UserKey":"11074000DE28A7D6@a630edad8160942nba2078.onmicrosoft.com",
     "UserType":0,
     "Version":1,
     "Workload":"AzureActiveDirectory"
     },
"host":"HJ73MW24BLNQ",
"id":"2823738566644596",
"nanos":312000,
"source":"Audit.AzureActiveDirectory",
"sourcetype":"o365:management:activity",
"timestamp":1598905880322
}

Required arguments

connection_id
Syntax: string
Description: The ID of your Microsoft 365 connection.
Example in Canvas View: my-microsoft-365-connection

Optional arguments

initial_position
Syntax: LATEST | TRIM_HORIZON
Description: The position in the data stream where you want to start reading data. Defaults to LATEST.
  • LATEST: Start reading data from the latest position on the data stream.
  • TRIM_HORIZON: Start reading data from the very beginning of the data stream.
Example in Canvas View: LATEST

SPL2 example

When working in the SPL View, you can write the function using arguments in this exact order:

| from read_from_microsoft_365("my-connection-id", "TRIM_HORIZON") |... ;

Alternatively, you can use named arguments to declare arguments in any order. The following SPL2 example uses named arguments to specify the initial_position argument before the connection_id argument:

| from read_from_microsoft_365(initial_position: "TRIM_HORIZON", connection_id: "my-connection-id") |... ;

If you want to use a mix of unnamed and named arguments in your functions, you must list all unnamed arguments in the correct order before providing the named arguments.

Limitations of the Microsoft 365 source function

The Microsoft 365 source function uses scheduled data collection jobs to ingest data. See Limitations of scheduled data collection jobs for information about limitations that apply to all scheduled data collection jobs.

Last modified on 19 April, 2021
PREVIOUS
Get data from Google Cloud Pub/Sub
  NEXT
Get data from Microsoft Azure Event Hubs

This documentation applies to the following versions of Splunk® Data Stream Processor: 1.2.0, 1.2.1


Was this documentation topic helpful?

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters