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

  • Release version: Zurich
  • Updated July 31, 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 documentation describes the target tables used by the API Service Graph Connector for Azure API Management in ServiceNow, detailing how data collected from Azure API Management applications is organized and stored. After configuring the connection, the integration periodically imports data into various CMDB and non-CMDB tables that represent Azure API Management components and their relationships.

    Show full answer Show less

    Key Tables and Attributes

    • Cloud Service Account [cmdbcicloudserviceaccount]: Stores account-level data like account ID, name, object ID, datacenter type, and operational status. It maintains containment relationships with Resource Groups and Azure Subscriptions.
    • Azure Subscription [cmdbciazuresubscription]: Contains subscription details such as name, object ID, and operational status.
    • Azure API Management [cmdbciazureapimgmt]: Captures API management service details including ID, name, FQDN, gateway URL, operational status, and version. It relates to API Product Bundles, Consumer Subscriptions, DNS Aliases, Managed APIs, and Resource Groups.
    • Resource Group [cmdbciresourcegroup]: Holds resource group information like name, object ID, and operational status.
    • DNS Alias [cmdbcidnsalias]: Stores DNS alias names associated with API management components.
    • Managed API [cmdbcimanagedapi]: Contains detailed API metadata such as ID, version, base URL, description, FQDN, lifecycle stage, operational status, and type. It links to API Frontends, API Backends, and API Consumer Subscriptions.
    • API Frontend [cmdbciapifrontend]: Details API frontend endpoints including version, host, method, path, URL, description, and operational status.
    • API Backend [cmdbciapibackend]: Stores backend endpoint data applicable mainly to GraphQL APIs, including host, ID, method, path, URL, name, and operational status.
    • API Consumer [apiconsumer]: Records consumer information such as ID, discovered state, email, provider, registration date, and username.
    • API Product Bundle [cmdbciapiproductbundle]: Represents API product bundles with attributes like ID, discovered access and approval types, state, name, and operational status. It contains Managed APIs and is linked to Consumer Subscriptions.
    • API Consumer Subscription [cmdbciapiconsumersubscription]: Stores subscription details including ID, creation date, discovered scope, name, operational status, and references to API Consumers.
    • API Consumer Access [apiconsumeraccess]: Captures access details of consumers to API product bundles and subscriptions, including access type and validity.
    • Key Value [cmdbkeyvalue]: Used for storing key-value pairs related to API consumer access.

    Relationships

    The tables are interconnected to represent the hierarchical and functional relationships in Azure API Management:

    • Cloud Service Accounts contain Resource Groups and Azure Subscriptions.
    • Azure API Management instances provide API Product Bundles, Consumer Subscriptions, DNS Aliases, and Managed APIs.
    • Managed APIs use API Frontends, API Backends, and are linked to Consumer Subscriptions.
    • API Product Bundles contain Managed APIs and are used by Consumer Subscriptions.
    • API Consumer Subscriptions reference API Consumers and are linked to Consumer Access records.

    Practical Implications for ServiceNow Customers

    By understanding these tables and their relationships, ServiceNow customers can effectively manage and visualize their Azure API Management environment within the CMDB. This setup enables comprehensive tracking of API services, subscriptions, consumers, and related resources, enhancing governance, operational insight, and integration capabilities.

    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