Target tables for storing API Service Graph Connector for 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 |
| 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 |
| 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 |
| 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] Remarque : 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 |
| 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 Remarque : Applicable to GraphQL APIs only. |
| Method | method Remarque : 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 |
| 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 |
| 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 |
| 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 |