API Service Graph Connector for Azure API Management
Use the ServiceNow® API Service Graph Connector for Azure API Management to import API details from an Azure API Management application into the Configuration Management Database (CMDB).
Request apps on the Store
Visit the ServiceNow Store to view all the available apps, and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the ServiceNow Store version history release notes.
Key features
Import data into a normalized data model for consistency across other technologies.
The API Insights workspace provides a centralized interface where you can analyze and interact with API data, without needing direct access to Azure API Management, enhancing visibility, governance, and collaboration across the API estate. To learn more, see API Insights.
Supported ServiceNow versions
- Yokohama
- Zurich
- Australia
Use cases
You can use the API Service Graph Connector for Azure API Management to:
- Maintain an end-to-end inventory of exposed and backend APIs, identifying what APIs are published, used, and by whom.
- Track APIs from customer-facing endpoints to the underlying services, identifying impacted endpoints when services change or fail and creating incidents for reported issues.
- Address vulnerabilities and security incidents related to API endpoints, and create compliance requirements to measure against.
Configuring a connection for the connector
You can configure a connection for the connector by using the SGC Central view in the CMDB Workspace. The view enables you to discover and install connectors, and then effectively manage the full life cycle of creating, editing, monitoring, and debugging connections. To configure the connector using SGC Central, see Configure API Service Graph Connector for Azure API Management using SGC Central.
Important: Unless there are configuration issues, use SGC Central to configure the connection. The guided setup method for configuration is being deprecated.
Data mapping
Data from the Azure API Management data sources is mapped and transformed into the CMDB Configuration Item (CI) class definitions using the Robust Transform Engine (RTE). Data is inserted into the CMDB using the Identification and Reconciliation Engine (IRE).
When you complete setting up the connection, you can configure the integration to periodically pull data from an Azure API Management application.
The following table lists the data sources in the order they run, the staging tables, and the target tables as CMDB CI and non-CMDB classes for an Azure API Management application.
| Data source | Staging table | Target tables |
|---|---|---|
| API Management Services | SGA Azure API Management \[sn\_azure\_api\_gw\_sga\_azure\_api\_management\] | Azure API ManagementAzure Subscription Cloud Service Account Resource Group DNS Alias |
| Managed API | SGA Azure Managed API \[sn\_azure\_api\_gw\_sga\_azure\_managed\_api\] | Managed API |
| API Frontend Backend | SGA Azure API Frontend Backend \[sn\_azure\_api\_gw\_sga\_azure\_api\_frontend\_backend\_import\] | API FrontendAPI Backend |
| API GraphQL Frontend Backend | SGA Azure API GraphQL Frontend Backend \[sn\_azure\_api\_gw\_sga\_azure\_api\_graphql\_frontend\_backend\] | API FrontendAPI Backend |
| API Consumer | SGA Azure API Consumer \[sn\_azure\_api\_gw\_sga\_azure\_api\_consumer\] | API Consumer |
| API Product | SGA Azure API Product \[sn\_azure\_api\_gw\_sga\_azure\_api\_product\] | API Product Bundle |
| API Consumer Subscription | SGA Azure API Consumer Subscription \[sn\_azure\_api\_gw\_sga\_azure\_api\_subscription\] | API Consumer Subscription |
| API Tag | API Tag \[sn\_azure\_api\_gw\_api\_tag\] | Key Value |
| API Consumer Access | SGA Azure API Consumer Access \[sn\_azure\_api\_gw\_sga\_azure\_managed\_api\] | API Consumer Access |
For more information on where data is saved when pulling data from an Azure API Management application, see Target tables for storing API Service Graph Connector for Azure API Management data.
You can use the IntegrationHub ETL app to view the data maps. See IntegrationHub ETL for more information.
Record removal process
The connector supports soft deletion for CMDB CI classes only, meaning records are not permanently removed from the system. Instead, any CMDB CI records not discovered during the last scheduled job run are marked as Non-Operational.