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:

• Users from the Microsoft Graph Users API Endpoint.
• Devices from the Microsoft Graph Identity and access API Endpoint.

If you want to explicitly allow the static IP addresses used for this Source on your firewall see our table of static IP addresses by deployment.

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.

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

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.

   

3. Then select App Registrations.

   

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.

   

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.

   

6. Within the Application configuration page, select Certificates and Secrets to create an Application Client Secret Key.

   

7. Copy the Client Secret Value (pictured below). It's needed later in Sumo Logic when creating the Microsoft Azure AD Inventory Source.

   

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	Application (work or school account)	User.Read.All, Directory.ReadAll
Devices	Application (work or school account)	Device.Read.All, Directory.ReadAll

Personal Microsoft accounts are not supported.

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 Sumo Logic, select Manage Data > Collection > Collection. 

2. On the Collectors page, click Add Source next to a Hosted Collector.

3. Select Microsoft Azure AD Inventory.

   

4. Enter a Name to display for the Source in the Sumo web application. The description is optional.

   

5. (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.

6. 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:

• _siemVendor: Microsoft
• _siemProduct: Azure AD
• _siemDataType: Inventory

7. (Optional) Fields. Click the +Add Field link to define the fields you want to associate, each field needs a name (key) and value.

   •  A green circle with a check mark is shown when the field exists in the Fields table schema.
   •  An orange triangle with an exclamation point is shown when the field doesn't exist in the Fields table schema. In this case, an option to automatically add 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 it is ignored, known as dropped.

8. 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.

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

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

11. 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 it quits.	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 it quits.	FirstPartyGenericError

Restarting your Source

If your Source encounters ThirdPartyConfig errors, you can restart it from either the Sumo Logic UI or Sumo Logic API.

UI

To restart your source in the Sumo Logic platform, follow the steps below:

1. Open the Collection page, and go to Manage Data > Collection > Collection.
2. Select the source and click the information icon on the right side of the row.
3. The API usage information popup is displayed. Click the Restart Source button on the bottom left.
   
4. Click Confirm to send the restart request.
   
5. The bottom left of the platform will provide a notification informing you the request was successful.
   

API

To restart your source using the Sumo Management API, follow the instructions below:

• Method: POST
• Example endpoint:

  https://api.sumologic.com/api/v1/collectors/{collector_id}/sources/{source_id}/action/restart

Sumo Logic endpoints like api.sumologic.com are different in deployments outside us1. For example, an API endpoint in Europe would begin api.eu.sumologic.com. A service endpoint in us2 (Western U.S.) would begin service.us2.sumologic.com. For more information, see Sumo Logic Endpoints.

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"
    }
}