Configure API Service Graph Connector for Azure API Management using the guided setup

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

    • Set up scheduled import jobs to pull in Azure API Management data into your CMDB.

    Before you begin

    Important:
    Unless there are configuration issues, use the SGC Central view in the CMDB Workspace to configure the connection for the connector, as the guided setup method is being deprecated.
    Dependencies and requirements:
    • The Integration Commons for CMDB store app, which is automatically installed. See Integration Commons for CMDB.
    • The CMDB CI class models store app, which is automatically installed. See CMDB CI Class Models store app.
    • The ITOM Discovery License plugin (com.snc.itom.discovery.license). You must activate this plugin.
    • ITOM Licensing plugin (com.snc.itom.license). See Request Discovery.
    Obtain the OAuth credentials from your Azure administrator. Make a note of the following details:
    • Application (client) ID
    • Client Secret
    • Directory (tenant) ID
    • Connection URL

    Role required: admin

    Procedure

    1. Verify that the application scope is set to the API Service Graph Connector for Azure API Management application by using the application picker.
      For more information, see Application picker.
    2. Navigate to All > Service Graph Connectors > Azure API Management > Setup.
    3. On the API Service Graph Connector for Azure API Management page, verify that the Quick Start option is selected and then select Continue.
    4. Configure the authentication credentials to send requests to the Azure API Management application.
      1. In the Configure the Connection and Credentials section of the API Service Graph Connector for Azure API Management page, select Start.
      2. Configure the connection.
        1. Select the Configure Azure authentication credentials task.
        2. Select Click Here to open the Connections page in a separate browser tab.
        3. Search for and select Edit for Azure API Management Connection.
        4. In the Connection Information section of the Edit Connection window, fill in the fields.
          Table 1. Connection Information
          Field Description
          Azure API Management Connection Name Name to identify the Azure API Management connection record.

          Azure API Management Connection is the default credential alias name. You can add multiple Azure API Management instances. However, try not to modify the default connection name.
          Connection URL Base URL to connect to the Azure API Management service.
          Based on the region of your Azure client application, enter the URL in one of the following formats:
          • Global
            https://management.azure.com
          • US Government
            htttps://management.usgovcloudapi.net
          • China
            https://management.chinacloudapi.cn
          • Germany
            https://management.microsoftazure.de/
        5. In the Credential Information section of the Edit Connection window, fill in the fields.
          Table 2. Credential Information
          Field Description
          OAuth Client ID Application (client) ID of your Azure client application as noted in the Before you begin section.
          OAuth Client Secret Client Secret of your Azure client application as noted in the Before you begin section.
          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 the Before you begin section.
        6. Select Edit and Get OAuth Token.
        7. Select Update.
        8. When the OAuth token flow is successfully completed, return to the guided setup page and set the Configure Azure authentication credentials task to complete by selecting the Mark as complete check box and then select Continue.
      3. Configure a connection to manage Azure resources via Azure API Management.
        1. Select the Configure Properties task.
        2. In the Service Graph Connection Properties related list, enter the values for the properties.
          Table 3. Service Graph Connection Properties
          Property Description
          CollectionPeriod(days) Duration in days for collecting API usage data.
          CollectUsageData Enable usage data collection to retrieve API usage data over a specified duration.
          Discovery Scope Discovery scope of the Azure client application. The available options are:
          Management Group
          Select Management Group when the ServiceNow service account has access to data within the Azure management group.
          Subscription
          Select Subscription when the ServiceNow service account has access to data within the Azure subscription only.
          ExcludeServices Azure API Management services that should be excluded from the connection.

          For multiple services, separate them with commas. All gateways except those listed in the ExcludeServices property are fetched.
          GetNestedGroupSubscriptions Enable retrieving data from all nested child subscriptions when Management Group is set as the discovery scope.

          Set the property to false to exclude nested child subscriptions.
          ManagementGroupId Management group IDs of Azure API Management services.

          For multiple management groups, separate them with commas.
          PartitionSize Partition size for Azure managed APIs if parallel loading is enabled.

          Accepts a numeric value greater than zero. If left empty, the value is automatically calculated.
          ResourceGroups Resource group name of Azure API Management services.

          For multiple resource groups, separate their names with commas. If you leave this field empty, the data sources within the connector import data from all the available resource groups.
          SubscriptionId Subscription IDs of Azure API Management services.

          For multiple subscription IDs, separate them with commas. If the discovery scope is set to Subscription and this field is left blank, all subscriptions for the specified tenant in the credentials are discovered.
          Tip:
          To enter a property value, double-click (or use the keyboard shortcut) to enter a value in the Value cell for the property.
        3. Set the Configure Properties task to complete by selecting the Mark as complete check box and then select Continue.
      4. Test the connection.
        1. Select the Test Connection task.
        2. Test the connection by selecting the Test Connection related link.

          Testing the connection might take a few moments. The page is refreshed to show the test results.

        3. When the Status field is set to Success, select Update.

          If any of the tests have errors, follow the suggestions for remediation.

        4. Set the Test Connection task to complete by selecting the Mark as complete check box and then select Continue.
    5. Optional: Integrate with multiple Azure API Management instances.
      1. In the Add Multiple Instances section of the API Service Graph Connector for Azure API Management page, select Start.
      2. Enable creating data sources for the new Azure API Management connection.
        1. Verify that you have edit permissions for the Datasource [sys_data_source] table.
        2. Select the Update Data Source Access task.
        3. To edit the record, select the Global application scope from the application picker.
        4. In the Application Access related list of the Data Source form that opens in another tab, select the Can create, Can update, and Can delete check boxes.
        5. Select Update.
        6. From the application picker, select the API Service Graph Connector for Azure API Management application scope.
        7. Set the Update Data Source Access task to complete by selecting the Mark as complete check box and then select Continue.
      3. Enable creating a scheduled import job for the new Azure API Management connection.
        1. Ensure that you have edit permissions for the Scheduled data import [scheduled_import_set] table.
        2. Select the Update Scheduled Data Import Access task.
        3. To edit the record, select the Global application scope from the application picker.
        4. In the Application Access related list of the Scheduled Data Import form, select the Can create, Can update, and Can delete check boxes.
        5. Select Update.
        6. From the application picker, select the API Service Graph Connector for Azure API Management application scope.
        7. Set the Update Scheduled Data Import Access task to complete by selecting the Mark as complete check box and then select Continue.
      4. Clear the cache on the Data Source [sys_data_source] and Scheduled Data Imports [scheduled_import_set] tables.
        1. Select the Clear Cache for Data Source and Scheduled Data Imports tables task.
        2. In the Run script text box of the background script page, enter the following script:
          GlideTableManager.invalidateTable("sys_data_source");
GlideCacheManager.flushTable("sys_data_source");
GlideTableManager.invalidateTable("scheduled_import_set");
GlideCacheManager.flushTable("scheduled_import_set");
GlideTableManager.invalidateTable("sys_db_object");
GlideCacheManager.flushTable("sys_db_object");
        3. Select Run Script to run the background script in the global scope.

          The script may take several minutes to execute.

        4. After the script is executed, select Close.
        5. From the application picker, select the API Service Graph Connector for Azure API Management application scope.
        6. Set the Clear Cache for Data Source and Scheduled Data Imports tables task to complete by selecting Mark as Complete.
      5. Add another connection for the new Azure API Management instance.
        1. Verify that the application scope is set to the API Service Graph Connector for Azure API Management application by using the application picker.
        2. Select the Add Another Connection task and then select Click Here.
        3. On the Connections page that opens in another browser tab, select Add Connection.
        4. In the Create Connection window, fill in the connection, credentials, and subscription ID details.
        5. Select Create and Get OAuth Token.
        6. Close the Connections page and return to the guided setup page tab.
        7. Set the Add Another Connection task to complete by selecting the Mark as complete check box and then select Continue.
      6. Add properties for the new connection.
        1. Verify that the application scope is set to the API Service Graph Connector for Azure API Management application by using the application picker.
        2. Select the Add Properties to New Connections task.
        3. From the Name column, select the connection name you created in step 5.e.
        4. In the Service Graph Connection Properties related list, enter the values for the properties.

          For more information on properties, see 4.c.ii.

          Tip:
          To enter a property value, double-click (or use the keyboard shortcut) to enter a value in the Value cell for the property.
        5. Set the Add Properties to New Connections task to complete by selecting the Mark as complete check box and then select Continue.
      7. Test the new connection.
        1. Select the Test New Connections task.
        2. From the Name column, select the connection name you created in step 5.e.
        3. Test the connection by selecting the Test Connection related link.

          Testing the connection might take a few moments. The page is refreshed to show the test results.

        4. When the Status field is set to Success, select Update.

          If any of the tests have errors, follow the suggestions for remediation.

        5. Set the Test New Connections task to complete by selecting the Mark as complete check box and then select Continue.
    6. Configure the scheduled job for the import of Azure API Management data.
      1. In the Set up Scheduled Import Jobs section of the API Service Graph Connector for Azure API Management page, select Start.
      2. Select the API Management Services scheduled job.
        For a multiple instance setup, select the scheduled import created with the connection in step 5.e.
      3. On the Scheduled Data Import form, verify the field values.

        For more information, see Schedule a data import.

      4. Select the Active check box to activate the scheduled job.
      5. In the Run field, select Periodically to specify how often the job will run.
      6. Select Update.
      7. Set the Set up Scheduled Import Jobs task to complete by selecting the Mark as complete check box and then select Continue.
    7. On the API Service Graph Connector for Azure API Management page, select Complete to save your changes.
    8. In the Complete setup dialog box, select Complete to complete the setup.
    9. In the message box that appears, select Done.