jsn / ServiceNow, simplified.
AustraliaREFERENCE GUIDE

Microsoft Foundry Hub pattern-based discovery

ServiceNow documentation·8 min readView source ↗
On this page

Microsoft Foundry Hub pattern-based discovery

AI Agent Topology Mapping discovers Microsoft Foundry Hub assistants and models during horizontal discovery.

Request new or enhanced Patterns on the ServiceNow® Store

Visit the ServiceNow Store to view all the available updates 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.

Microsoft Foundry Hub data model

The following diagram illustrates the tables and relationships that the AI Agent Topology Mapping application creates when discovering Microsoft Foundry Hub resources.

[Omitted image “microsoft-foundry-hub-data-model.png”] Alt text: Microsoft Foundry Hub data model

Discovery requirements

  • Verify the REST API permissions

    Download the Cloud Discovery patterns spreadsheet so you can grant user permissions required for running the Discovery patterns. In addition to permissions, the spreadsheet also includes useful information such as pattern names, types, CI Classes, and links to vendor documentation. New patterns are available quarterly, so check periodically to be sure you have the latest version of the spreadsheet.

  • Verify that the applications are up to date

    Discovering these resources may require updating to the latest version of the following applications from the ServiceNow Store:

    • AI Agent Topology Mapping

    • Discovery and Service Mapping Patterns

    • Visibility Content

    • CMDB CI Class Models

    • Data Foundation Model (at least version 1.13.2)

  • Activate the cloud-related CI relationships

    To include discovered components into service instances, enable CI relationships used in tag-based discovery by Service Mapping. These CI relationships are available from the 1.0.68 release on the ServiceNow Store. For operational steps, see Tag-based discovery configuration.

  • Azure Availability Set

    Wait for the Clean-Up job for Availability zone to clear availability set record schedule job to delete all the pre-populated Configuration Items (CIs) in the cmdb_ci_azure_availability_set table.

  • Azure Availability Zone

    To run a discovery with Azure Availability Zone, register the subscription ID to the AvailabilityZonePeering feature with AZ CLI using az feature register -n AvailabilityZonePeering --namespace Microsoft.Resources to use the Check Zone Peering API. Check the status with az feature show -n AvailabilityZonePeering --namespace Microsoft.Resources before running discovery.

  • Set up Azure service accounts

    Enable Cloud Discovery to access your Azure environment.

    Discovering Azure GovCloud (US) accounts requires using a datacenter URL when setting up an Azure service account. For more information, see Set up Azure service accounts.

  • Create an Azure cloud discovery schedule

    For more information, see Create an Azure Discovery schedule in Discovery Admin Workspace.

  • (Optional) Discover datacenters only for new subscriptions

    Starting with Zurich Patch 2, you can discover datacenters only for new subscriptions added since the last discovery. For more information, see Discover datacenters only for new cloud accounts.

  • (Optional) Populate Service Account and Logical Datacenter fields in cloud CIs

    Starting with Discovery and Service Mapping Patterns version 1.30.2, you can improve query performance by populating Service Account and Logical Datacenter fields directly in cloud CIs. For more information, see Improved query performance with direct field population in CI tables.

Data collection

The AI Agent Topology Mapping application includes the following patterns for Microsoft Foundry Hub discovery:

  • Azure - AI Foundry Hub Agents

  • Azure - AI Foundry Hub Project

  • Azure - AI Foundry Models

The Azure - AI Foundry Hub Agents pattern collects AI System Digital Assets and AI Prompt Digital Assets. You can view this information in the Related Links section of the CI record by navigating to All > Configuration > Azure > Azure AI Foundry Agents and selecting the relevant record.

The Azure - AI Foundry Models pattern collects AI Model Digital Assets. You can view this information in the Related Links section of the CI record by navigating to All > Configuration > Azure > Azure AI Foundry Models and selecting the relevant record.

The AI Agent Topology Mapping application populates data in both CMDB and non-CMDB tables.

Data stored in non-CMDB tables

The AI Agent Topology Mapping application populates data in non-CMDB tables when running the Microsoft Foundry Hub patterns.

If you have the AI Control Tower application, you can view the information in the AI Control Tower Workspace.

Field Description Display name [display_name] Display name of the Microsoft Foundry Hub assistant. External record reference [external_ref_id] Unique identifier of the Microsoft Foundry Hub assistant. Asset type [model_category] Asset type of the assistant. Value is set to Agentic AI. State [install_status] State of the assistant. Value is set to Deployed. Vendor [vendor] Vendor of the assistant. Value is set to Azure. Model [model] References the AI System Component Product Model [cmdb_ai_system_component_product_model] table. AI prompts [ai_prompts] References the AI Prompt Digital Asset [alm_ai_prompt_digital_asset] table. AI models [ai_models] References the AI Model Digital Asset [alm_ai_model_digital_asset] table. Configuration Item [ci] References the AI Function [cmdb_ci_function_ai] table. Field Description Name [name] Name of the Microsoft Foundry Hub assistant. Short description [short_description] Description of the Microsoft Foundry Hub assistant. Status [status] Operational status of the assistant. Value is set to PREPARED. Manufacturer [manufacturer] Name of the company defined in the glide.appcreator.company.friendly_name system property. Model categories [cmdb_model_category] Model category. Value is set to Agentic AI. Field Description Prompt information [prompt_info] Instruction text defined for the Microsoft Foundry Hub assistant. Asset type [model_category] Asset type of the prompt. Value is set to AI prompt. Vendor [vendor] Vendor of the prompt. Value is set to Azure. Model [model] References the AI Prompt Product Model [cmdb_ai_prompt_product_model] table. Configuration Item [ci] References the AI Function [cmdb_ci_function_ai] table. Field Description Name [name] Name of the Microsoft Foundry Hub assistant, used to identify the associated prompt model. Manufacturer [manufacturer] Name of the company defined in the glide.appcreator.company.friendly_name system property. Model categories [cmdb_model_category] Model category. Value is set to AI prompt. Field Description Display name [display_name] Name of the foundation model. External record reference [external_ref_id] Resource identifier of the foundation model. Asset type [model_category] Asset type of the model. Value is set to AI model. Vendor [vendor] Provider of the foundation model. Model [model] References the AI Model Product Model [cmdb_ai_model_product_model] table. Configuration Item [ci] References the AI Model Deployment [cmdb_ci_ai_model_deployment] table. Field Description Name [name] Name of the foundation model. Model number [model_number] Model ID assigned by Microsoft Foundry. Version [version] Version of the foundation model. Description [description] Description of the foundation model. Manufacturer [manufacturer] Provider of the foundation model. Model categories [cmdb_model_category] Model category. Value is set to AI model.

Data stored in CMDB tables

The AI Agent Topology Mapping application populates data in the CMDB when running the Microsoft Foundry Hub patterns.

Field Description Name [name] Name of the Microsoft Foundry Hub assistant. Object ID [object_id] Unique identifier of the Microsoft Foundry Hub assistant. Description [short_description] Description of the Microsoft Foundry Hub assistant. Manufacturer [manufacturer] Cloud provider of the resource. Value is set to Azure. Operational status [operational_status] Operational status of the resource. Default value is Operational. Install Status [install_status] Install status of the resource. Default value is Installed. Comments [comments] Resource type identifier. Value is set to Azure::FoundryHub::Agent.

<table id=“table_ai_project”><thead><tr><th>

Field

</th><th>

Description

</th></tr></thead><tbody><tr><td>

Name [name]

</td><td>

Name of the Microsoft Foundry Hub project.

</td></tr><tr><td>

Object ID [object_id]

</td><td>

Unique identifier of the Microsoft Foundry Hub project.

</td></tr><tr><td>

Comments [comments]

</td><td>

Azure region where the Microsoft Foundry Hub project is deployed.

</td></tr><tr><td>

Operational status [operational_status]

</td><td>

Operational status of the resource. Default value is Operational.

</td></tr><tr><td>

Install Status [install_status]

</td><td>

Install status of the resource. Default value is Installed.

</td></tr><tr><td>

Azure Project Kind [azure_project_kind]

</td><td>

Resource kind of the Microsoft Foundry Hub project. For example: Project.

</td></tr><tr><td>

Attributes [attributes]

</td><td>

Resource type identifier. Value is set to Azure::FoundryHub::Project.

</td></tr></tbody> </table><table id=“table_ai_model_deployment”><thead><tr><th>

Field

</th><th>

Description

</th></tr></thead><tbody><tr><td>

Name [name]

</td><td>

Name of the AI model available in Microsoft Foundry Hub.

</td></tr><tr><td>

Object ID [object_id]

</td><td>

Resource identifier of the AI model.

</td></tr><tr><td>

Description [short_description]

</td><td>

Description of the AI model.

</td></tr><tr><td>

Model number [model_number]

</td><td>

Model name, used as an identifier.

</td></tr><tr><td>

Manufacturer [manufacturer]

</td><td>

Provider of the AI model. For example: Microsoft, Anthropic, or OpenAI.

</td></tr><tr><td>

Attributes [attributes]

</td><td>

Lifecycle status of the model as reported by the API. For example: Stable or Deprecated.

</td></tr><tr><td>

Comments [comments]

</td><td>

Azure resource type identifier. Value is set to Microsoft.CognitiveServices/locations/models.

</td></tr><tr><td>

Operational status [operational_status]

</td><td>

Operational status of the resource. Default value is Operational.

</td></tr><tr><td>

Install Status [install_status]

</td><td>

Install status of the resource. Default value is Installed.

</td></tr></tbody> </table>## Dependency Views map

On the Dependency Views map, you can view discovered Microsoft Foundry Hub resources and the relationships between them.

Note: The following relationships are stored in the Asset-CI Relationship [cmdb_rel_asset_ci] table and aren’t represented in the Dependency View map:

  • The Deployed as::Deployment of relationship between AI Function [cmdb_ci_function_ai] and AI System Digital Asset [alm_ai_system_digital_asset].

  • The Used by::Uses relationship between AI Model Deployment [cmdb_ci_ai_model_deployment] and AI Model Digital Asset [alm_ai_model_digital_asset].

[Omitted image “microsoft-foundry-hub-dependency-view.png”] Alt text: Microsoft Foundry Hub CIs and connections on a Dependency Views map

CI relationships and references

The Microsoft Foundry Hub patterns create the following relationships and references to support Microsoft Foundry Hub discovery. References link to records in other tables and don’t appear in the CI Relationship [cmdb_rel_ci] table.

CI/Table Relationship CI/Table AI Function [cmdb_ci_function_ai] Hosted on::Hosts Azure Datacenter [cmdb_ci_azure_datacenter] Azure AI Project [cmdb_ci_azure_ai_project] Contains::Contained by AI Function [cmdb_ci_function_ai] Resource Group [cmdb_ci_resource_group] Contains::Contained by AI Function [cmdb_ci_function_ai] AI Function [cmdb_ci_function_ai] Deployed as::Deployment of AI System Digital Asset [alm_ai_system_digital_asset] Azure AI Project [cmdb_ci_azure_ai_project] Hosted on::Hosts Azure Datacenter [cmdb_ci_azure_datacenter] Resource Group [cmdb_ci_resource_group] Contains::Contained by Azure AI Project [cmdb_ci_azure_ai_project] AI Function [cmdb_ci_function_ai] Depends on::Used by AI Model Deployment [cmdb_ci_ai_model_deployment] AI Model Deployment [cmdb_ci_ai_model_deployment] Hosted on::Hosts Azure Datacenter [cmdb_ci_azure_datacenter] AI Model Deployment [cmdb_ci_ai_model_deployment] Used by::Uses AI Model Digital Asset [alm_ai_model_digital_asset] CI/Table Field Referenced CI/Table AI System Digital Asset [alm_ai_system_digital_asset] Model [model] AI System Component Product Model [cmdb_ai_system_component_product_model] AI System Digital Asset [alm_ai_system_digital_asset] AI prompts [ai_prompts] AI Prompt Digital Asset [alm_ai_prompt_digital_asset] AI System Digital Asset [alm_ai_system_digital_asset] AI models [ai_models] AI Model Digital Asset [alm_ai_model_digital_asset] AI System Digital Asset [alm_ai_system_digital_asset] Configuration Item [ci] AI Function [cmdb_ci_function_ai] AI Prompt Digital Asset [alm_ai_prompt_digital_asset] Model [model] AI Prompt Product Model [cmdb_ai_prompt_product_model] AI Prompt Digital Asset [alm_ai_prompt_digital_asset] Configuration Item [ci] AI Function [cmdb_ci_function_ai] AI Model Digital Asset [alm_ai_model_digital_asset] Model [model] AI Model Product Model [cmdb_ai_model_product_model] AI Model Digital Asset [alm_ai_model_digital_asset] Configuration Item [ci] AI Model Deployment [cmdb_ci_ai_model_deployment] Key Value [cmdb_key_value] Configuration item [configuration_item] Azure AI Project [cmdb_ci_azure_ai_project]

Azure tag discovery

The Azure - AI Foundry Hub Project pattern collects tags and populates them in the Key Value [cmdb_key_value] table.

Field Description Key [key] Tag name. Value [value] Tag value. Configuration item [configuration_item] References the Azure AI Project [cmdb_ci_azure_ai_project] table.

Parent Topic:AI Agent Topology Mapping reference

Related topics

Microsoft Azure Cloud discovery using patterns

Keep exploring.

Find another answer, or bring this documentation into your own tools.

Search the library →Read via the REST API ↗