API Service Graph Connector for Azure API Management
Summarize
Summary of API Service Graph Connector for Azure API Management
The ServiceNow API Service Graph Connector for Azure API Management enables customers to import detailed API information from Azure API Management applications directly into the ServiceNow Configuration Management Database (CMDB). This integration helps maintain a unified and normalized view of APIs across environments, improving governance, visibility, and operational management of API ecosystems.
Show less
Key Features
- Normalized Data Model: Imported API data is standardized for consistency across different technologies within the CMDB.
- API Insights Workspace: Provides a centralized interface to analyze and interact with API data without requiring direct access to Azure API Management, facilitating better collaboration and governance.
- Support for Multiple ServiceNow Versions: Compatible with Yokohama, Zurich, and Australia releases.
Use Cases
- Maintain a comprehensive inventory of both exposed and backend APIs, including details on API publishing and usage.
- Track APIs from customer-facing endpoints to underlying services to identify impacted components and automate incident creation for issues.
- Manage vulnerabilities and security incidents related to API endpoints and enforce compliance requirements.
Configuration
Connections for the connector are configured using the SGC Central view within the CMDB Workspace. This interface supports discovery, installation, and full lifecycle management of connectors including creation, editing, monitoring, and debugging. It is important to note that the previously available guided setup method is deprecated, and SGC Central should be used for all configurations.
Data Mapping and Integration
Data from Azure API Management is mapped and transformed into CMDB Configuration Item (CI) classes using the Robust Transform Engine (RTE) and inserted with the Identification and Reconciliation Engine (IRE). The connector periodically synchronizes data from Azure API Management into various CMDB tables representing API Management Services, Managed APIs, Frontend and Backend APIs, API Consumers, API Products, Subscriptions, Tags, and Access.
The IntegrationHub ETL app can be used to view and manage data maps for this integration.
Record Removal Process
The connector employs a soft deletion approach for CMDB CI records. Instead of permanently deleting records, any CI not discovered during the most recent scheduled data sync is marked as Non-Operational. This helps retain historical data while reflecting the current state of the API environment.
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
- 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.
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.
| Data source | Staging table | Target tables |
|---|---|---|
| API Management Services | SGA Azure API Management [sn_azure_api_gw_sga_azure_api_management] | Azure API Management |
| 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 Frontend |
| API GraphQL Frontend Backend | SGA Azure API GraphQL Frontend Backend [sn_azure_api_gw_sga_azure_api_graphql_frontend_backend] | API Frontend |
| 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.