Target tables for storing API Service Graph Connector for Azure API Management data

  • Release version: Yokohama
  • Updated May 1, 2025
  • 3 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Target tables for storing API Service Graph Connector for Azure API Management data

    This document outlines the key ServiceNow tables used to store data collected via the API Service Graph Connector for Azure API Management, as of the Yokohama release (updated May 1, 2025). After configuring the connector, data from an Azure API Management application is periodically pulled and stored in various tables extending theConfiguration item [cmdbci]class and other related non-CMDB classes. This enables a comprehensive configuration management database (CMDB) representation of Azure API Management components within ServiceNow.

    Show full answer Show less

    Key Tables and Attributes

    • Cloud Service Account [cmdbcicloudserviceaccount]: Stores cloud account details such as account ID, name, object ID, datacenter type, and operational status.
    • Azure Subscription [cmdbciazuresubscription]: Holds subscription-specific information including name, object ID, and operational status.
    • Azure API Management [cmdbciazureapimgmt]: Contains API Management instance data, including ID, name, fully qualified domain name, gateway URL, version, and operational status.
    • Resource Group [cmdbciresourcegroup]: Captures resource group details such as name, object ID, and operational status.
    • DNS Alias [cmdbcidnsalias]: Stores DNS alias names relevant to API Management resources.
    • Managed API [cmdbcimanagedapi]: Includes attributes like ID, version details, base URL, correlation ID, description, operational status, type, lifecycle stage, and model ID.
    • API Frontend [cmdbciapifrontend]: Contains data on API frontend elements such as API version, host, method, path, URL, description, and operational status.
    • API Backend [cmdbciapibackend]: Stores information on API backend components including host, ID, method, path, URL, name, and operational status, with notes on applicability to GraphQL APIs.
    • API Consumer [apiconsumer]: Holds consumer details like ID, discovered state, email, provider, registration date, and username.
    • API Product Bundle [cmdbciapiproductbundle]: Represents API product bundles with attributes including ID, discovered access and approval types, discovered state, name, and operational status.
    • API Consumer Subscription [cmdbciapiconsumersubscription]: Stores subscription-specific data such as ID, creation date, discovered scope, name, sys ID, associated API consumer, and operational status.
    • Key Value [cmdbkeyvalue]: Contains key-value pairs relevant to API configurations.
    • API Consumer Access [apiconsumeraccess]: Captures access details including API consumer, access type, API product bundle, state, API consumer subscription, API, and validity period.

    Relationships Between Tables

    The connector establishes important relationships to model dependencies and associations within Azure API Management:

    • Cloud Service Account contains Resource Groups and Azure Subscriptions.
    • Azure API Management provides API Product Bundles, API Consumer Subscriptions, Managed APIs, and DNS Aliases; it also uses API Consumers.
    • Managed API uses API Frontends, API Backends, and API Consumer Subscriptions (the latter applies when the discovered scope is set to "api").
    • API Frontend uses API Backend endpoints.
    • API Product Bundles contain Managed APIs and are used by API Consumer Subscriptions.
    • API Consumer Subscription references API Consumer Access records.

    Practical Implications for ServiceNow Customers

    By leveraging these tables and their relationships, customers can achieve a detailed and structured CMDB representation of their Azure API Management environment. This facilitates:

    • Improved visibility into API assets and their configurations.
    • Accurate tracking of API consumers, subscriptions, and access permissions.
    • Enhanced operational status monitoring across Azure API Management components.
    • Better management of API lifecycle stages, versions, and dependencies.

    Understanding the populated attributes and table relationships helps customers tailor their integrations, reporting, and automation workflows within ServiceNow to align with their Azure API Management data.

    When you complete setting up the connection, you can configure the integration to periodically pull data from an Azure API Management application. The data is saved in tables that extend from the Configuration item [cmdb_ci] classes and other non-CMDB classes.

    Cloud Service Account [cmdb_ci_cloud_service_account]

    The following attributes in the Cloud Service Account [cmdb_ci_cloud_service_account] table are populated by collected data:
    Attribute label Attribute name
    Account Id account_id
    Name name
    Object ID object_id
    Datacenter Type datacenter_type
    Operational status operational_status
    Table 1. Relationship created for Cloud Service Account
    Parent class Relationship type Child class
    Cloud Service Account [cmdb_ci_cloud_service_account] Contains::Contained by Resource Group [cmdb_ci_resource_group]

    Azure Subscription [cmdb_ci_azure_subscription]

    The following attributes in the Azure Subscription [cmdb_ci_azure_subscription] table are populated by collected data:
    Attribute label Attribute name
    Name name
    Object ID object_id
    Operational status operational_status

    Azure API Management [cmdb_ci_azure_api_mgmt]

    The following attributes in the Azure API Management [cmdb_ci_azure_api_mgmt] table are populated by collected data:
    Attribute label Attribute name
    ID id
    Name name
    Fully qualified domain name fqdn
    Gateway URL gateway_url
    Operational status operational_status
    Version version
    Table 2. Relationships created for Azure API Management
    Parent class Relationship type Child class
    Azure API Management [cmdb_ci_azure_api_mgmt] Provides::Provided by API Product Bundle [cmdb_ci_api_product_bundle]
    Azure API Management [cmdb_ci_azure_api_mgmt] Provides::Provided by API Consumer Subscription [cmdb_ci_api_consumer_subscription]
    Azure API Management [cmdb_ci_azure_api_mgmt] Uses::Used by DNS Alias [cmdb_ci_dns_alias]
    Azure API Management [cmdb_ci_azure_api_mgmt] Provides::Provided by Managed API [cmdb_ci_managed_api]
    Azure API Management [cmdb_ci_azure_api_mgmt] Reference API Consumer [api_consumer]

    Resource Group [cmdb_ci_resource_group]

    The following attributes in the Resource Group [cmdb_ci_resource_group] table are populated by collected data:
    Attribute label Attribute name
    Name name
    Object ID object_id
    Operational status operational_status

    DNS Alias [cmdb_ci_dns_alias]

    The following attributes in the DNS Alias [cmdb_ci_dns_alias] table are populated by collected data:
    Attribute label Attribute name
    Name name

    Managed API [cmdb_ci_managed_api]

    The following attributes in the Managed API [cmdb_ci_managed_api] table are populated by collected data:
    Attribute label Attribute name
    ID id
    Minor Version minor_version
    Name name
    Version version
    Base URL base_url
    Correlation ID correlation_id
    Description short_description
    Fully qualified domain name fqdn
    Operational status operational_status
    Type type
    Life Cycle Stage Status life_cycle_stage_status
    Life Cycle Stage life_cycle_stage
    Model ID model_id
    Table 3. Relationships created for Managed API
    Parent class Relationship type Child class
    Managed API [cmdb_ci_managed_api] Uses::Used by API Frontend [cmdb_ci_api_frontend]
    Managed API [cmdb_ci_managed_api] Uses::Used by API Backend [cmdb_ci_api_backend]
    Managed API [cmdb_ci_managed_api] Uses::Used by API Consumer Subscription [cmdb_ci_api_consumer_subscription]
    Note:
    Applies only when the Discovered Scope [discovered_scope] attribute value is set to api.

    API Frontend [cmdb_ci_api_frontend]

    The following attributes in the API Frontend [cmdb_ci_api_frontend] table are populated by collected data:
    Attribute label Attribute name
    API Minor Version api_minor_version
    API Version api_version
    Host host
    Method method
    Path path
    URL url
    Description short_description
    Name name
    Operational status operational_status
    Table 4. Relationship created for API Frontend
    Parent class Relationship type Child class
    API Frontend [cmdb_ci_api_frontend] Use End Point To::Use End Point From API Backend [cmdb_ci_api_backend]

    API Backend [cmdb_ci_api_backend]

    The following attributes in the API Backend [cmdb_ci_api_backend] table are populated by collected data:
    Attribute label Attribute name
    Host host
    ID id
    Note:
    Applicable to GraphQL APIs only.
    Method method
    Note:
    Applicable to GraphQL APIs only.
    Path path
    URL url
    Name name
    Operational status operational_status

    API Consumer [api_consumer]

    The following attributes in the API Consumer [api_consumer] table are populated by collected data:
    Attribute label Attribute name
    ID id
    Discovered State discovered_state
    Email email
    Provider provider
    Registration Date registration_date
    Username username

    API Product Bundle [cmdb_ci_api_product_bundle]

    The following attributes in the API Product Bundle [cmdb_ci_api_product_bundle] table are populated by collected data:
    Attribute label Attribute name
    ID id
    Discovered Access Type discovered_access_type
    Discovered Approval Type discovered_approval_type
    Discovered State discovered_state
    Name name
    Operational status operational_status
    Table 5. Relationships created for API Product Bundle
    Parent class Relationship type Child class
    API Product Bundle [cmdb_ci_api_product_bundle] Contains::Contained by Managed API [cmdb_ci_managed_api]
    API Product Bundle [cmdb_ci_api_product_bundle] Used by::Uses API Consumer Subscription [cmdb_ci_api_consumer_subscription]

    API Consumer Subscription [cmdb_ci_api_consumer_subscription]

    The following attributes in the API Consumer Subscription [cmdb_ci_api_consumer_subscription] table are populated by collected data:
    Attribute label Attribute name
    ID id
    Creation Date creation_date
    Discovered Scope discovered_scope
    Name name
    Sys ID sys_id
    API Consumer api_consumer
    Operational status operational_status
    Table 6. Relationship created for API Consumer Subscription
    Parent class Relationship type Child class
    API Consumer Subscription [cmdb_ci_api_consumer_subscription] Reference API Consumer Access [api_consumer_access]

    Key Value [cmdb_key_value]

    The following attributes in the Key Value [cmdb_key_value] table are populated by collected data:
    Attribute label Attribute name
    Key key
    Value value

    API Consumer Access [api_consumer_access]

    The following attributes in the API Consumer Access [api_consumer_access] table are populated by collected data:
    Attribute label Attribute name
    API Consumer api_consumer
    Access type access_type
    API Product Bundle api_product_bundle
    State state
    API Consumer Subscription api_consumer_subscription
    API api
    Valid to valid_to