Microsoft Foundry (Classic) pattern-based discovery
Summarize
Summary of Microsoft Foundry (Classic) pattern-based discovery
The Microsoft Foundry (Classic) pattern-based discovery, part of the AI Agent Topology Mapping application, enables ServiceNow customers to discover Microsoft Foundry services, agents, projects, and models within their Azure cloud environments. This discovery enriches the Configuration Management Database (CMDB) and related tables with detailed information about AI resources, facilitating comprehensive asset visibility and management.
Show less
This discovery is integral for customers leveraging Microsoft Foundry AI services on Azure, allowing them to map and manage AI components and their relationships effectively.
Key Features
- Patterns for Microsoft Foundry AI discovery: Includes Azure - AI Foundry Agents, Azure - AI Service Foundry, Azure - AI Service Foundry Project, and Azure - AI Foundry Models patterns that collect detailed data on AI agents, services, projects, and models.
- Data Model and Tables: Populates both CMDB tables (e.g., AI Function, Azure AI Foundry, AI Model Deployment) and non-CMDB tables (e.g., AI System Digital Asset, AI Prompt Digital Asset, AI Model Digital Asset) to capture comprehensive AI resource data.
- CI Relationships and References: Establishes relationships such as Hosted on, Contains, Depends on, and Used by between AI components, Azure resource groups, datacenters, and deployments to provide a clear dependency map.
- Azure Tag Discovery: Captures Azure resource tags and stores them in the Key Value table, enhancing metadata and searchability for Azure AI Foundry services and projects.
- Integration with Service Mapping: Supports enabling cloud-related CI relationships for inclusion in service instances, enhancing service visibility.
- Operational Support: Supports discovery in Azure GovCloud (US), requires appropriate Azure service accounts and permissions, and includes optional features like discovering only new datacenters and improved query performance through direct field population.
Practical Implementation and Requirements
- Ensure that related applications such as AI Agent Topology Mapping, Discovery and Service Mapping Patterns, Visibility Content, and CMDB CI Class Models are updated to the latest versions from the ServiceNow Store.
- Activate cloud-related CI relationships to integrate discovered components with service instances using tag-based discovery.
- Configure Azure service accounts with necessary permissions, including handling specific Azure features like Availability Zone Peering for accurate discovery.
- Create and schedule Azure cloud discovery jobs, with options to focus on new subscriptions for efficient discovery cycles.
- Verify REST API permissions using the provided Cloud Discovery patterns spreadsheet to ensure the discovery patterns execute correctly.
Expected Results and Benefits
- Populated CMDB and related tables with accurate, detailed AI resource data, including agents, models, projects, and services from Microsoft Foundry.
- Clear visualization of resource dependencies and relationships through the Dependency Views map, aiding in impact analysis and operational management.
- Improved asset management with enriched metadata, including Azure tags and lifecycle states, enhancing governance and compliance.
- Integration with AI Control Tower workspace (if installed) for enhanced AI resource monitoring and management.
- Optimized discovery performance and scalability through optional features and updated patterns, supporting evolving cloud environments.
AI Agent Topology Mapping discovers Microsoft Foundry (Classic) services, agents, 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 data model
The following diagram illustrates the tables and relationships that the AI Agent Topology Mapping application creates when discovering Microsoft Foundry resources.
- 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].
Discovery requirements
- 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
- 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 availability set's Configuration Items (CI) 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.Resourcesto use the Check Zone Peering API. Check the status withaz feature show -n AvailabilityZonePeering --namespace Microsoft.Resourcesbefore running discovery. - Set up Azure service accounts
- Enable Cloud Discovery to access your Azure environment.
- 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.
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.
Data collection
- Azure - AI Foundry Agents
- Azure - AI Service Foundry
- Azure - AI Service Foundry Project
- Azure - AI Foundry Models
The Azure - AI Foundry Agents pattern collects AI System Digital Assets, AI Prompt Digital Assets, and Key Value information. You can view this information in the Related Links section of the CI record by navigating to 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 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 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 agent. |
| External record reference [external_ref_id] | Unique identifier of the Microsoft Foundry agent. |
| Model [model] | References the AI System Component Product Model [cmdb_ai_system_component_product_model] table. |
| Asset type [model_category] | Asset type of the agent. Value is set to Agentic AI. |
| State [install_status] | State of the agent. Value is set to Deployed. |
| 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 agent. |
| Short description [short_description] | Description of the Microsoft Foundry agent. |
| Status [status] | Operational status of the agent. Value is set to PREPARED. |
| Version [version] | Version of the Microsoft Foundry agent. |
| Manufacturer [manufacturer] | Cloud provider of the resource. Value is set to Azure. |
| 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 agent. |
| Model [model] | References the AI Prompt Product Model [cmdb_ai_prompt_product_model] table. |
| Asset type [model_category] | Asset type of the prompt. Value is set to AI prompt. |
| Configuration Item [ci] | References the AI Function [cmdb_ci_function_ai] table. |
| Field | Description |
|---|---|
| Name [name] | Name of the Microsoft Foundry agent, used to identify the associated prompt model. |
| Manufacturer [manufacturer] | Cloud provider of the resource. Value is set to Azure. |
| 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. |
| Model [model] | References the AI Model Product Model [cmdb_ai_model_product_model] table. |
| Asset type [model_category] | Asset type of the model. Value is set to AI model. |
| Vendor [vendor] | Provider of the foundation model. |
| 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 patterns.
| Field | Description |
|---|---|
| Name [name] | Name of the Microsoft Foundry agent. |
| Object ID [object_id] | Unique identifier of the Microsoft Foundry agent. |
| Description [short_description] | Description of the Microsoft Foundry agent. |
| 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::Foundry::Agent. |
| Field | Description |
|---|---|
| Name [name] | Name of the Microsoft Foundry service. |
| Object ID [object_id] | Unique identifier of the Microsoft Foundry service. |
| Description [short_description] | Description of the resource. Value is set to Azure Foundry Service. |
| 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. |
| Azure Service Type [azure_service_type] | Azure resource type. For example: microsoft.cognitiveservices/accounts. |
| Azure Service Kind [azure_service_kind] | Resource kind of the Microsoft Foundry service. For example: AIServices. |
| Field | Description |
|---|---|
| Name [name] | Name of the Microsoft Foundry project. |
| Object ID [object_id] | Unique identifier of the Microsoft Foundry project. |
| Comments [comments] | Azure region where the Microsoft Foundry project is deployed. |
| 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. |
| Model number [model_number] | Internal identifier of the Microsoft Foundry project. |
| Azure Project Kind [azure_project_kind] | Resource kind of the Microsoft Foundry project. For example: AIServices. |
| Field | Description |
|---|---|
| Name [name] | Name of the AI model available in Microsoft Foundry. |
| Object ID [object_id] | Resource identifier of the AI model. |
| Description [short_description] | Description of the AI model. |
| Model number [model_number] | Model name, used as an identifier. |
| Manufacturer [manufacturer] | Provider of the AI model. For example: Microsoft, Anthropic, or OpenAI. |
| Attributes [attributes] | Lifecycle status of the model as reported by the API. For example: Stable or Deprecated. |
| Comments [comments] | Azure resource type identifier. Value is set to Microsoft.CognitiveServices/locations/models. |
| 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. |
Dependency Views map
On the Dependency Views map, you can view discovered Microsoft Foundry resources and the relationships between them.
CI relationships
The Microsoft Foundry patterns create the following relationships and references to support Microsoft Foundry 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 Foundry [cmdb_ci_azure_ai_foundry] | Hosted on::Hosts | Azure Datacenter [cmdb_ci_azure_datacenter] |
| Resource Group [cmdb_ci_resource_group] | Contains::Contained by | Azure AI Foundry [cmdb_ci_azure_ai_foundry] |
| Azure AI Foundry [cmdb_ci_azure_ai_foundry] | Contains::Contained by | Azure AI Project [cmdb_ci_azure_ai_project] |
| 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 Foundry [cmdb_ci_azure_ai_foundry] |
| Key Value [cmdb_key_value] | Configuration item [configuration_item] | Azure AI Project [cmdb_ci_azure_ai_project] |
Azure tag discovery
The Azure - AI Service Foundry 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 Foundry [cmdb_ci_azure_ai_foundry] table. |
The Azure - AI Service Foundry 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. |