{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":31117,"path":"it-operations-management/itom-visibility/microsoft-foundry-hub-pattern.md","title":"Microsoft Foundry Hub pattern-based discovery","bundle":null,"doc_type":null,"release":"australia","body":"\n# Microsoft Foundry Hub pattern-based discovery\n\nAI Agent Topology Mapping discovers Microsoft Foundry Hub assistants and models during horizontal discovery.\n\n## Request new or enhanced Patterns on the ServiceNow® Store\n\nVisit the [ServiceNow Store](https://store.servicenow.com/sn_appstore_store.do#!/store/application/06a71b1367e4130051c9027e2685ef1e/1.6.0?referer=%2Fstore%2Fsearch%3Flistingtype%3Dallintegrations%25253Bancillary_app%25253Bcertified_apps%25253Bcontent%25253Bindustry_solution%25253Boem%25253Butility%25253Btemplate%26q%3DPatterns&sl=sh) 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](https://www.servicenow.com/docs/r/store-release-notes/sn-store-release-notes.html).\n\n## Microsoft Foundry Hub data model\n\nThe following diagram illustrates the tables and relationships that the AI Agent Topology Mapping application creates when discovering Microsoft Foundry Hub resources.\n\n\\[Omitted image \"microsoft-foundry-hub-data-model.png\"\\] Alt text: Microsoft Foundry Hub data model\n\n## Discovery requirements\n\n-   **Verify the REST API permissions**\n\n    Download the [Cloud Discovery patterns spreadsheet](https://downloads.docs.servicenow.com/resource/enus/api/servicenow-discovery-patterns-api-details.xlsx) 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.\n\n-   **Verify that the applications are up to date**\n\n    Discovering these resources may require updating to the latest version of the following applications from the ServiceNow Store:\n\n    -   AI Agent Topology Mapping\n    -   Discovery and Service Mapping Patterns\n    -   Visibility Content\n    -   CMDB CI Class Models\n    -   Data Foundation Model \\(at least version 1.13.2\\)\n-   **Activate the cloud-related CI relationships**\n\n    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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/service-mapping/tag_discovery_configuration.md).\n\n-   **Azure Availability Set**\n\n    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.\n\n-   **Azure Availability Zone**\n\n    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.\n\n-   **Set up Azure service accounts**\n\n    Enable Cloud Discovery to access your Azure environment.\n\n    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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/setup-azure-service-accounts.md).\n\n-   **Create an Azure cloud discovery schedule**\n\n    For more information, see [Create an Azure Discovery schedule in Discovery Admin Workspace](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/discovery/create-azure-schedule-DAW.md).\n\n-   **\\(Optional\\) Discover datacenters only for new subscriptions**\n\n    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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/discovery-and-service-mapping-patterns/discover-datacenter-only-new-account.md).\n\n-   **\\(Optional\\) Populate Service Account and Logical Datacenter fields in cloud CIs**\n\n    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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/discovery-and-service-mapping-patterns/query-service-account-ldc-fields.md).\n\n\n## Data collection\n\nThe AI Agent Topology Mapping application includes the following patterns for Microsoft Foundry Hub discovery:\n\n-   Azure - AI Foundry Hub Agents\n-   Azure - AI Foundry Hub Project\n-   Azure - AI Foundry Models\n\nThe 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** &gt; **Configuration** &gt; **Azure** &gt; **Azure AI Foundry Agents** and selecting the relevant record.\n\nThe 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** &gt; **Configuration** &gt; **Azure** &gt; **Azure AI Foundry Models** and selecting the relevant record.\n\nThe AI Agent Topology Mapping application populates data in both CMDB and non-CMDB tables.\n\n## Data stored in non-CMDB tables\n\nThe AI Agent Topology Mapping application populates data in non-CMDB tables when running the Microsoft Foundry Hub patterns.\n\nIf you have the AI Control Tower application, you can view the information in the AI Control Tower Workspace.\n\n|Field|Description|\n|-----|-----------|\n|Display name \\[display\\_name\\]|Display name of the Microsoft Foundry Hub assistant.|\n|External record reference \\[external\\_ref\\_id\\]|Unique identifier of the Microsoft Foundry Hub assistant.|\n|Asset type \\[model\\_category\\]|Asset type of the assistant. Value is set to **Agentic AI**.|\n|State \\[install\\_status\\]|State of the assistant. Value is set to **Deployed**.|\n|Vendor \\[vendor\\]|Vendor of the assistant. Value is set to **Azure**.|\n|Model \\[model\\]|References the AI System Component Product Model \\[cmdb\\_ai\\_system\\_component\\_product\\_model\\] table.|\n|AI prompts \\[ai\\_prompts\\]|References the AI Prompt Digital Asset \\[alm\\_ai\\_prompt\\_digital\\_asset\\] table.|\n|AI models \\[ai\\_models\\]|References the AI Model Digital Asset \\[alm\\_ai\\_model\\_digital\\_asset\\] table.|\n|Configuration Item \\[ci\\]|References the AI Function \\[cmdb\\_ci\\_function\\_ai\\] table.|\n\n|Field|Description|\n|-----|-----------|\n|Name \\[name\\]|Name of the Microsoft Foundry Hub assistant.|\n|Short description \\[short\\_description\\]|Description of the Microsoft Foundry Hub assistant.|\n|Status \\[status\\]|Operational status of the assistant. Value is set to **PREPARED**.|\n|Manufacturer \\[manufacturer\\]|Name of the company defined in the **glide.appcreator.company.friendly\\_name** system property.|\n|Model categories \\[cmdb\\_model\\_category\\]|Model category. Value is set to **Agentic AI**.|\n\n|Field|Description|\n|-----|-----------|\n|Prompt information \\[prompt\\_info\\]|Instruction text defined for the Microsoft Foundry Hub assistant.|\n|Asset type \\[model\\_category\\]|Asset type of the prompt. Value is set to **AI prompt**.|\n|Vendor \\[vendor\\]|Vendor of the prompt. Value is set to **Azure**.|\n|Model \\[model\\]|References the AI Prompt Product Model \\[cmdb\\_ai\\_prompt\\_product\\_model\\] table.|\n|Configuration Item \\[ci\\]|References the AI Function \\[cmdb\\_ci\\_function\\_ai\\] table.|\n\n|Field|Description|\n|-----|-----------|\n|Name \\[name\\]|Name of the Microsoft Foundry Hub assistant, used to identify the associated prompt model.|\n|Manufacturer \\[manufacturer\\]|Name of the company defined in the **glide.appcreator.company.friendly\\_name** system property.|\n|Model categories \\[cmdb\\_model\\_category\\]|Model category. Value is set to **AI prompt**.|\n\n|Field|Description|\n|-----|-----------|\n|Display name \\[display\\_name\\]|Name of the foundation model.|\n|External record reference \\[external\\_ref\\_id\\]|Resource identifier of the foundation model.|\n|Asset type \\[model\\_category\\]|Asset type of the model. Value is set to **AI model**.|\n|Vendor \\[vendor\\]|Provider of the foundation model.|\n|Model \\[model\\]|References the AI Model Product Model \\[cmdb\\_ai\\_model\\_product\\_model\\] table.|\n|Configuration Item \\[ci\\]|References the AI Model Deployment \\[cmdb\\_ci\\_ai\\_model\\_deployment\\] table.|\n\n|Field|Description|\n|-----|-----------|\n|Name \\[name\\]|Name of the foundation model.|\n|Model number \\[model\\_number\\]|Model ID assigned by Microsoft Foundry.|\n|Version \\[version\\]|Version of the foundation model.|\n|Description \\[description\\]|Description of the foundation model.|\n|Manufacturer \\[manufacturer\\]|Provider of the foundation model.|\n|Model categories \\[cmdb\\_model\\_category\\]|Model category. Value is set to **AI model**.|\n\n## Data stored in CMDB tables\n\nThe AI Agent Topology Mapping application populates data in the CMDB when running the Microsoft Foundry Hub patterns.\n\n|Field|Description|\n|-----|-----------|\n|Name \\[name\\]|Name of the Microsoft Foundry Hub assistant.|\n|Object ID \\[object\\_id\\]|Unique identifier of the Microsoft Foundry Hub assistant.|\n|Description \\[short\\_description\\]|Description of the Microsoft Foundry Hub assistant.|\n|Manufacturer \\[manufacturer\\]|Cloud provider of the resource. Value is set to **Azure**.|\n|Operational status \\[operational\\_status\\]|Operational status of the resource. Default value is **Operational**.|\n|Install Status \\[install\\_status\\]|Install status of the resource. Default value is **Installed**.|\n|Comments \\[comments\\]|Resource type identifier. Value is set to **Azure::FoundryHub::Agent**.|\n\n<table id=\"table_ai_project\"><thead><tr><th>\n\nField\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nName \\[name\\]\n\n</td><td>\n\nName of the Microsoft Foundry Hub project.\n\n</td></tr><tr><td>\n\nObject ID \\[object\\_id\\]\n\n</td><td>\n\nUnique identifier of the Microsoft Foundry Hub project.\n\n</td></tr><tr><td>\n\nComments \\[comments\\]\n\n</td><td>\n\nAzure region where the Microsoft Foundry Hub project is deployed.\n\n</td></tr><tr><td>\n\nOperational status \\[operational\\_status\\]\n\n</td><td>\n\nOperational status of the resource. Default value is **Operational**.\n\n</td></tr><tr><td>\n\nInstall Status \\[install\\_status\\]\n\n</td><td>\n\nInstall status of the resource. Default value is **Installed**.\n\n</td></tr><tr><td>\n\nAzure Project Kind \\[azure\\_project\\_kind\\]\n\n</td><td>\n\nResource kind of the Microsoft Foundry Hub project. For example: Project.\n\n</td></tr><tr><td>\n\nAttributes \\[attributes\\]\n\n</td><td>\n\nResource type identifier. Value is set to **Azure::FoundryHub::Project**.\n\n</td></tr></tbody>\n</table><table id=\"table_ai_model_deployment\"><thead><tr><th>\n\nField\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nName \\[name\\]\n\n</td><td>\n\nName of the AI model available in Microsoft Foundry Hub.\n\n</td></tr><tr><td>\n\nObject ID \\[object\\_id\\]\n\n</td><td>\n\nResource identifier of the AI model.\n\n</td></tr><tr><td>\n\nDescription \\[short\\_description\\]\n\n</td><td>\n\nDescription of the AI model.\n\n</td></tr><tr><td>\n\nModel number \\[model\\_number\\]\n\n</td><td>\n\nModel name, used as an identifier.\n\n</td></tr><tr><td>\n\nManufacturer \\[manufacturer\\]\n\n</td><td>\n\nProvider of the AI model. For example: Microsoft, Anthropic, or OpenAI.\n\n</td></tr><tr><td>\n\nAttributes \\[attributes\\]\n\n</td><td>\n\nLifecycle status of the model as reported by the API. For example: Stable or Deprecated.\n\n</td></tr><tr><td>\n\nComments \\[comments\\]\n\n</td><td>\n\nAzure resource type identifier. Value is set to **Microsoft.CognitiveServices/locations/models**.\n\n</td></tr><tr><td>\n\nOperational status \\[operational\\_status\\]\n\n</td><td>\n\nOperational status of the resource. Default value is **Operational**.\n\n</td></tr><tr><td>\n\nInstall Status \\[install\\_status\\]\n\n</td><td>\n\nInstall status of the resource. Default value is **Installed**.\n\n</td></tr></tbody>\n</table>## Dependency Views map\n\nOn the Dependency Views map, you can view discovered Microsoft Foundry Hub resources and the relationships between them.\n\n**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:\n\n-   The **Deployed as::Deployment of** relationship between AI Function \\[cmdb\\_ci\\_function\\_ai\\] and AI System Digital Asset \\[alm\\_ai\\_system\\_digital\\_asset\\].\n-   The **Used by::Uses** relationship between AI Model Deployment \\[cmdb\\_ci\\_ai\\_model\\_deployment\\] and AI Model Digital Asset \\[alm\\_ai\\_model\\_digital\\_asset\\].\n\n\\[Omitted image \"microsoft-foundry-hub-dependency-view.png\"\\] Alt text: Microsoft Foundry Hub CIs and connections on a Dependency Views map\n\n## CI relationships and references\n\nThe 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.\n\n|CI/Table|Relationship|CI/Table|\n|--------|------------|--------|\n|AI Function \\[cmdb\\_ci\\_function\\_ai\\]|Hosted on::Hosts|Azure Datacenter \\[cmdb\\_ci\\_azure\\_datacenter\\]|\n|Azure AI Project \\[cmdb\\_ci\\_azure\\_ai\\_project\\]|Contains::Contained by|AI Function \\[cmdb\\_ci\\_function\\_ai\\]|\n|Resource Group \\[cmdb\\_ci\\_resource\\_group\\]|Contains::Contained by|AI Function \\[cmdb\\_ci\\_function\\_ai\\]|\n|AI Function \\[cmdb\\_ci\\_function\\_ai\\]|Deployed as::Deployment of|AI System Digital Asset \\[alm\\_ai\\_system\\_digital\\_asset\\]|\n|Azure AI Project \\[cmdb\\_ci\\_azure\\_ai\\_project\\]|Hosted on::Hosts|Azure Datacenter \\[cmdb\\_ci\\_azure\\_datacenter\\]|\n|Resource Group \\[cmdb\\_ci\\_resource\\_group\\]|Contains::Contained by|Azure AI Project \\[cmdb\\_ci\\_azure\\_ai\\_project\\]|\n|AI Function \\[cmdb\\_ci\\_function\\_ai\\]|Depends on::Used by|AI Model Deployment \\[cmdb\\_ci\\_ai\\_model\\_deployment\\]|\n|AI Model Deployment \\[cmdb\\_ci\\_ai\\_model\\_deployment\\]|Hosted on::Hosts|Azure Datacenter \\[cmdb\\_ci\\_azure\\_datacenter\\]|\n|AI Model Deployment \\[cmdb\\_ci\\_ai\\_model\\_deployment\\]|Used by::Uses|AI Model Digital Asset \\[alm\\_ai\\_model\\_digital\\_asset\\]|\n\n|CI/Table|Field|Referenced CI/Table|\n|--------|-----|-------------------|\n|AI System Digital Asset \\[alm\\_ai\\_system\\_digital\\_asset\\]|Model \\[model\\]|AI System Component Product Model \\[cmdb\\_ai\\_system\\_component\\_product\\_model\\]|\n|AI System Digital Asset \\[alm\\_ai\\_system\\_digital\\_asset\\]|AI prompts \\[ai\\_prompts\\]|AI Prompt Digital Asset \\[alm\\_ai\\_prompt\\_digital\\_asset\\]|\n|AI System Digital Asset \\[alm\\_ai\\_system\\_digital\\_asset\\]|AI models \\[ai\\_models\\]|AI Model Digital Asset \\[alm\\_ai\\_model\\_digital\\_asset\\]|\n|AI System Digital Asset \\[alm\\_ai\\_system\\_digital\\_asset\\]|Configuration Item \\[ci\\]|AI Function \\[cmdb\\_ci\\_function\\_ai\\]|\n|AI Prompt Digital Asset \\[alm\\_ai\\_prompt\\_digital\\_asset\\]|Model \\[model\\]|AI Prompt Product Model \\[cmdb\\_ai\\_prompt\\_product\\_model\\]|\n|AI Prompt Digital Asset \\[alm\\_ai\\_prompt\\_digital\\_asset\\]|Configuration Item \\[ci\\]|AI Function \\[cmdb\\_ci\\_function\\_ai\\]|\n|AI Model Digital Asset \\[alm\\_ai\\_model\\_digital\\_asset\\]|Model \\[model\\]|AI Model Product Model \\[cmdb\\_ai\\_model\\_product\\_model\\]|\n|AI Model Digital Asset \\[alm\\_ai\\_model\\_digital\\_asset\\]|Configuration Item \\[ci\\]|AI Model Deployment \\[cmdb\\_ci\\_ai\\_model\\_deployment\\]|\n|Key Value \\[cmdb\\_key\\_value\\]|Configuration item \\[configuration\\_item\\]|Azure AI Project \\[cmdb\\_ci\\_azure\\_ai\\_project\\]|\n\n## Azure tag discovery\n\nThe Azure - AI Foundry Hub Project pattern collects tags and populates them in the Key Value \\[cmdb\\_key\\_value\\] table.\n\n|Field|Description|\n|-----|-----------|\n|Key \\[key\\]|Tag name.|\n|Value \\[value\\]|Tag value.|\n|Configuration item \\[configuration\\_item\\]|References the Azure AI Project \\[cmdb\\_ci\\_azure\\_ai\\_project\\] table.|\n\n**Parent Topic:**[AI Agent Topology Mapping reference](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/itom-visibility/ai-agent-topology-mapping-reference.md)\n\n**Related topics**  \n\n\n[Microsoft Azure Cloud discovery using patterns](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/discovery-and-service-mapping-patterns/azure-cloud-discovery-patterns.md)\n\n"}}