Skip to main content
Sumo Logic

Microsoft Azure AD Inventory Source

The Microsoft Azure AD Inventory Source collects user and device data from the Microsoft Graph API Security endpoint. It securely stores the required authentication, scheduling, and state tracking information.

The Microsoft Azure AD Inventory API Source consumes:

States

A Microsoft Azure AD Inventory Source tracks errors, reports its health, and start-up progress. You’re informed, in real-time, if the Source is having trouble connecting, if there's an error requiring user action, or if it is healthy and collecting by utilizing Health Events.

A Microsoft Azure AD Inventory Source goes through the following states when created:

  1. Pending: Once the Source is submitted it is validated, stored, and placed in a Pending state.
  2. Started: A collection task is created on the Hosted Collector.
  3. Initialized: The task configuration is complete in Sumo Logic.
  4. Authenticated: The Source successfully authenticated with Azure.
  5. Collecting: The Source is actively collecting data from Azure.

If the Source has any issues during any one of these states it is placed in an Error state.

When you delete the Source it is placed in a Stopping state, when it has successfully stopped it is deleted from your Hosted Collector.

On the Collection page, the Health and Status for Sources is displayed. Use Health Events to investigate issues with collection.

Azure AD Inventory error.png

Hover your mouse over the status icon to view a tooltip with a count of the detected errors and warnings.

hover over health status icon.png

You can click on the status icon to open a Health Events panel with details on each detected issue.

Set up a Service Application

The Source requires the creation and registration of a service application within the Azure Active Directory portal.

The user creating the service application does not need to be an administrator. However, an administrator is needed to grant the application the appropriate permissions to the Users and Devices APIs.

Use the following steps to create a service application:

  1. Log in to the Azure Active Directory Portal
  2. Then select Azure Active Directory in the left menu.
    Azure AD step 2.png
  3. Then select App Registrations.
    Azure AD step 3 red box.png
  4. Then select New Registration. Go through the registration process, providing a name for the application. Selecting Accounts in this organizational directory only is sufficient.
    Azure new registration in step 4.png
  5. After the Application is registered (created), be sure to copy the Application (client) ID and the Directory (tenant) ID. These are used later as configuration parameters in Sumo Logic when creating the Microsoft Azure AD Inventory Source.
    Azure created app in step 5.png
  6. Within the Application configuration page, select Certificates and Secrets to create an Application Client Secret Key.
    Azure AD step 6.png
  7. Copy the Client Secret Value (pictured below). It's needed later in Sumo Logic when creating the Microsoft Azure AD Inventory Source.
    Azure AD step 7.png
  8. Request the appropriate permissions for the application. Click on API Permissions, then Add a permission and select Microsoft Graph.

    From there select (or search for) the following permissions. An Administrator must approve (grant) these permissions before the integration will function.
    API Account Type Permissions
    User Delegated (work or school account) User.ReadBasic.All, User.Read.All, User.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.All
    User Delegated (personal Microsoft account) Not supported.
    User Application User.Read.All, User.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All
    Devices Delegated (work or school account) Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.All
    Devices Delegated (personal Microsoft account) Not supported.
    Devices Application Device.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All

    azure ad step 8.png

Create a Microsoft Azure AD Inventory Source

When you create a Microsoft Azure AD Inventory Source, you add it to a Hosted Collector. Before creating the Source, identify the Hosted Collector you want to use or create a new Hosted Collector. For instructions, see Configure a Hosted Collector.

To configure a Microsoft Azure AD Inventory Source:

  1. In the Sumo Logic web app, select Manage Data > Collection > Collection
  1. On the Collectors page, click Add Source next to a Hosted Collector.
  1. Select Microsoft Azure AD Inventory.
    Microsoft Azure AD Inventory icon.png
  1. Enter a Name to display for the Source in the Sumo web application. The description is optional.
    Microsoft Azure AD sep 7 2021.png
  1. (Optional) For Source Category, enter any string to tag the output collected from the Source. Category metadata is stored in a searchable field called _sourceCategory.
  2. Forward to SIEM. Check the checkbox to forward your data to Cloud SIEM Enterprise. When configured with the Forward to SIEM option the following metadata fields are set:
Field Name Value
_siemVendor Microsoft
_siemProduct Azure AD
_dataType Inventory
  1. (Optional) Fields. Click the +Add link to add custom log metadata Fields.
    • Define the fields you want to associate, each field needs a name (key) and value. 
      • green check circle.png A green circle with a check mark is shown when the field exists and is enabled in the Fields table schema.
      • orange exclamation point.png An orange triangle with an exclamation point is shown when the field doesn't exist, or is disabled, in the Fields table schema. In this case, an option to automatically add or enable the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo that does not exist in the Fields schema or is disabled it is ignored, known as dropped. 
  2. Provide the Directory (tenant) ID and Application (client) ID you got after you registered (created) the Azure Application in step 5 of the setup section.

  3. Application Client Secret Value. Provide the Application Client Secret Value you created in step 7 of the setup section.

  4. Supported APIs to collect. Select one or more of the available APIs: Devices and Users.

  5. When you are finished configuring the Source click Submit.

Error types

When Sumo Logic detects an issue it is tracked by Health Events. The following table shows the three possible error types, the reason the error would occur, if the Source attempts to retry, and the name of the event log in the Health Event Index.

Type Reason Retries Retry Behavior Health Event Name
ThirdPartyConfig Normally due to an invalid configuration. You'll need to review your Source configuration and make an update. No retries are attempted until the Source is updated. Not applicable ThirdPartyConfigError
ThirdPartyGeneric Normally due to an error communicating with the third party service APIs. Yes The Source will retry for up to 90 minutes, after which retries will be attempted every 60 minutes. ThirdPartyGenericError
FirstPartyGeneric Normally due to an error communicating with the internal Sumo Logic APIs. Yes The Source will retry for up to 90 minutes, after which retries will be attempted every 60 minutes. FirstPartyGenericError

JSON configuration

Sources can be configured using UTF-8 encoded JSON files with the Collector Management API. See how to use JSON to configure Sources for details. 

Parameter Type Required? Description Access
config JSON Object Yes Contains the configuration parameters for the Source.  
schemaRef JSON Object Yes Set to {"type":"Microsoft Azure AD Inventory"}. not modifiable
sourceType String Yes Set to Universal. not modifiable

The following table shows the config parameters for a Microsoft Azure AD Inventory Source.

Parameter Type Required Default Description Access
name String Yes   Type a desired name of the Source. The name must be unique per Collector. This value is assigned to the metadata field _source. modifiable
description String No null Type a description of the Source. modifiable
category String No null Type a category of the source. This value is assigned to the metadata field _sourceCategory. See best practices for details. modifiable
fields JSON
Object
No   JSON map of key-value fields (metadata) to apply to the Collector or Source.

Use the boolean field _siemForward to enable forwarding to SIEM.
modifiable
tenant_id String Yes   Provide the Directory (tenant) ID you got after you registered (created) the Azure Application. modifiable
secret_key String Yes   Provide the Application Client Secret Value you created in Azure. modifiable
application_id String Yes   Provide the Application (client) ID you got after you registered (created) the Azure Application. modifiable
supported_apis Array of strings Yes   Define one or more of the available APIs to collect: Devices, and Users.

For example, for both you'd use:
["Devices","Users"]
modifiable

Microsoft Azure AD Inventory Source JSON example:

{
    "api.version": "v1",
    "source": {
        "schemaRef": {
            "type": "Microsoft Azure AD Inventory"
        },
        "config": {
            "name": "Azure AD Inventory",
            "tenant_id": "TenantID",
            "supported_apis": ["Devices", "Users"],
            "secret_key": "********",
            "application_id": "ApplicationID",
            "fields": {
                "_siemForward": false
            }
        },
        "sourceType": "Universal"
    }
}