Configure Service Graph Connector for Microsoft Azure using SGC Central

  • Release version: Washingtondc
  • Updated January 30, 2025
  • 6 minutes to read

    • Use the playbook available with the SGC Central application to set up the Service Graph Connector for Microsoft Azure for pulling in Microsoft Azure data into the CMDB.

    Before you begin

    Install Service Graph Connector for Microsoft Azure version 1.9.0 or later from the ServiceNow Store. For ServiceNow Store installation steps, see Install a ServiceNow Store application.
    Important:
    After the initial import of Azure data, the application performs a delta import of data. However, you can perform a full pull of data anytime later by disabling the delta synchronization and setting the sn_sg_azure_integ.is_delta_sync_enabled property to false. For more information, see Configuring data synchronization in Service Graph Connector for Microsoft Azure.

    Role required: cmdb_inst_admin or admin

    About this task

    The playbook experience for onboarding connectors is activated with SGC Central in the CMDB Workspace. To configure the SGC Central application, see Configuring SGC Central and for more information on how to interact with a playbook, see Interact with Playbook.

    The connector uses the Azure Management APIs for the complete pull of data from Azure. However, to pull delta changes from Azure, the Azure Resource Graph APIs are used. The domain name system (DNS) is Microsoft Azure Management, but the path is a resource graph.

    Procedure

    1. Navigate to Workspaces > CMDB Workspace.
    2. In the CMDB Workspace, select SGC Central.
    3. On the Overview page, select Create connection.
      Tip:
      Alternatively, you can select Create connection on the All connections page.
    4. On the Create connection window, select the Microsoft Azure connector type and then select Create connection.
    5. Complete the initial prerequisites when setting up a connection for the first time using a connector.
      Note:
      This step is required only during the first-time setup. See Perform initial setup tasks when creating a connection in SGC Central.
    6. Complete the prerequisites for setting up the Azure environment.
      1. Complete the instructions required for setting up the Azure environment.
        1. In the Prerequisites stage of the playbook, select the Review setup instructions activity.
        2. Obtain the OAuth credentials including client ID, client secret, and token URL from your Microsoft Azure administrator.
        3. For importing hardware data, grant the User.Read permission on the Microsoft Graph API in the Azure environment. Also, ensure that the IAM policy for the Azure subscription has the Reader role. See Assign a user as an administrator of an Azure subscription with conditions on the Microsoft Azure documentation site.
        4. For importing software data, grant the Data.Read permission on the Log Analytics API in the Azure environment. In addition, set up a Log Analytics workspace in the Azure environment.
        5. After completing the Review setup instructions activity, select Continue.
    7. Determine whether to import only hardware data or both hardware and software data.
      1. In the Setup stage of the playbook, select the Select services activity.
        If needed, expand the Setup stage to select an activity.
      2. Optional: To import both hardware and software data, select the Hardware and software check box.
        Note:
        Importing software data requires a hardware connection.

        If you need to import only hardware data, the Hardware only check box is already selected by default.

      3. Select Continue.
    8. Enter the connection details and test the API connection for importing hardware data.
      1. In the Setup stage of the playbook, select the Create and test hardware connection activity.
      2. On the form, fill in the fields.
        Table 1. Create and test hardware connection form
        Field Description
        Connection name Name to identify the hardware connection record.

        For example, SG-Azure hardware connection.
        Connection URL Base URL to connect to your Azure client application.
        Note:
        This field is automatically set to the URL to connect to the application. Leave the field value as is.
        OAuth client ID Application (client) ID of your Azure client application as noted in step 6.a.
        OAuth client secret Client secret of your Azure client application as noted in step 6.a.
        OAuth token URL Callback URL for the Azure client application.
        Based on the region of your Azure client application, enter the token URL in one of the following formats:
        • Global
          https://login.microsoftonline.com/<tenantid>/oauth2/v2.0/token
        • US Government
          https://login.microsoftonline.us/<tenantid>/oauth2/v2.0/token
        • China
          https://login.partner.microsoftonline.cn/<tenantid>/oauth2/v2.0/token
        • Germany
          https://login.microsoftonline.de/<tenantid>/oauth2/v2.0/token
        Where <tenantid> is the tenant ID of your Azure client application as noted in step 6.a.
      3. Select Create and test connection.
      4. Once the connection test is complete, select Continue.
    9. Configure the import schedule to import hardware data at regular intervals.
      1. In the Setup stage of the playbook, select the Configure hardware import schedule activity.
      2. Select Configure import schedule.
      3. Expand the Parent scheduled data import within the Import schedules list to select the Connection name-SG-Azure Subscriptions import schedule.
      4. In the Configure import schedule dialog box, select the Active check box, and then fill in the run schedule and time details.

        For more information, see Schedule a data import.

      5. Select Save.
        Alternatively, select Execute Now to execute the import schedule immediately.
      6. Select Continue.
    10. Enter the connection details and test the API connection for importing software data.

      The Create and test software connection activity for importing software data appears only when the Hardware and software check box is selected in step 7.b.

      1. In the Setup stage of the playbook, select the Create and test software connection activity.
      2. On the form, fill in the fields.
        Table 2. Create and test software connection form
        Field Description
        Software connection name Name to identify the software connection record.

        For example, SG-Azure software connection.
        Hardware connection name Name of the hardware connection record.
        Note:
        This field is automatically set to the hardware connection name specified in step 8.b.
        Connection URL Base URL to connect to the Log Analytics workspace in the following format: 
        https://api.loganalytics.io/v1/workspaces/<workspace_id>
        Where <workspace_id> is the ID of the Log Analytics workspace as noted in step 6.a.
        Note:
        This field is automatically set to the URL to connect to the Log Analytics workspace. Replace the <workspace_id> variable in the auto-generated URL with the workspace ID of your Log Analytics workspace.
        OAuth client ID Application (client) ID of your Azure client application as noted in step 6.a.
        OAuth client secret Client secret of your Azure client application as noted in step 6.a.
        OAuth token URL Token URL of your Azure client application.
        Based on the region of your Azure client application, enter the token URL in one of the following formats:
        • Global
          https://login.microsoftonline.com/<tenantid>/oauth2/v2.0/token
        • US Government
          https://login.microsoftonline.us/<tenantid>/oauth2/v2.0/token
        • China
          https://login.partner.microsoftonline.cn/<tenantid>/oauth2/v2.0/token
        • Germany
          https://login.microsoftonline.de/<tenantid>/oauth2/v2.0/token
        Where <tenantid> is the tenant ID of your Azure client application as noted in step 6.a.
      3. Select Create and test connection.
      4. Once the connection test is complete, select Continue.
    11. Configure the import schedule to import software data at regular intervals.

      The Configure software import schedule activity for importing software data appears only when the Hardware and software check box is selected in step 7.b.

      1. In the Setup stage of the playbook, select the Configure software import schedule activity.
      2. Expand the Parent scheduled data import within the Import schedules list to select the Connection name-SG-Azure TCP import schedule.
      3. In the Configure import schedule dialog box, select the Active check box, and then fill in the run schedule and time details.

        For more information, see Schedule a data import.

      4. Select Save.
        Alternatively, select Execute Now to execute the import schedule immediately.
      5. Repeat steps 11.b to 11.d for any other parent import schedule if not already set to active.
      6. Select Continue.
    12. In the Setup stage of the playbook, select the Connection setup complete activity to verify whether the connection was created.

    What to do next

    Select View all connections to review the connection details. The created connection appears in the Installed connections list.