Azure Cognitive Search
Developmentazure-cognitive-searchAzure Cognitive Search is an Agent Skill for development published in the MicrosoftDocs/Agent-Skills repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Expert knowledge for Azure AI Search development including troubleshooting, best practices, decision making, architecture & design patterns, limits & quotas, security, configuration, integrations & coding patterns, and deployment. Use when building indexes/indexers, AI enrichment skillsets, semantic/vector search, or secure multi-region deployments, and other Azure AI Search related development tasks. Not for Azure Cosmos DB (use azure-cosmos-db), Azure Data Explorer (use azure-data-explorer), Azure SQL Database (use azure-sql-database), Azure Synapse Analytics (use azure-synapse-analytics).
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/MicrosoftDocs/Agent-Skills/blob/HEAD/skills/azure-cognitive-search/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/azure-cognitive-search, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
Azure AI Search Skill
This skill provides expert guidance for Azure AI Search. Covers troubleshooting, best practices, decision making, architecture & design patterns, limits & quotas, security, configuration, integrations & coding patterns, and deployment. It combines local quick-reference content with remote documentation fetching capabilities.
How to Use This Skill
IMPORTANT for Agent: Use the Category Index below to locate relevant sections. For categories with line ranges (e.g.,
L35-L120), useread_filewith the specified lines. For categories with file links (e.g.,[security.md](security.md)), useread_fileon the linked reference file
IMPORTANT for Agent: If
metadata.generated_atis more than 3 months old, suggest the user pull the latest version from the repository. Ifmcp_microsoftdocstools are not available, suggest the user install it: Installation Guide
This skill requires network access to fetch documentation content:
- Preferred: Use
mcp_microsoftdocs:microsoft_docs_fetchwith query stringfrom=learn-agent-skill. Returns Markdown. - Fallback: Use
fetch_webpagewith query stringfrom=learn-agent-skill&accept=text/markdown. Returns Markdown.
Category Index
| Category | Lines | Description |
|---|---|---|
| Troubleshooting | L37-L48 | Diagnosing and fixing Azure AI Search indexer and skillset errors, debug sessions, OData filter issues, private link problems, and storage/metrics-related failures. |
| Best Practices | L49-L67 | Design, performance, cost, and reliability best practices for Azure AI Search: AI enrichment, custom skills, indexing/updates, vectors/chunking, concurrency, blob changes, and query/index tuning. |
| Decision Making | L68-L82 | Guidance on planning and upgrading Azure AI Search: migrations (skills, APIs, SDKs), capacity and region choices, pricing tiers, cost management, and connector selection. |
| Architecture & Design Patterns | L83-L88 | Designing Azure AI Search architectures for multitenancy vs isolated indexes, and planning resilient multi-region deployments, failover, and data locality. |
| Limits & Quotas | L89-L99 | Limits, quotas, and scheduling for indexers and services, including billing/free enrichment, tier caps, vector index size, and how to manage and run indexers with .NET. |
| Security | L100-L136 | Securing Azure AI Search: RBAC/keys, Entra auth, policies, encryption/CMK, network isolation (firewalls, private endpoints), and securing indexer connections and document-level/query-time access. |
| Configuration | L137-L219 | Configuring Azure AI Search behavior: indexes, indexers, analyzers, vectorization, skillsets/enrichment, semantic ranking, retrieval/answer synthesis, logging, and query/OData options. |
| Integrations & Coding Patterns | L220-L305 | Integrating Azure AI Search with data sources, indexers, skills, vectorization, query syntax, semantic ranking, and knowledge bases for agentic and organizational retrieval. |
| Deployment | L306-L314 | Deploying and moving Azure AI Search services: ARM/Bicep/Terraform provisioning, region moves and feature availability, and deploying search apps to Static Web Apps. |
Troubleshooting
Best Practices
Decision Making
Architecture & Design Patterns
| Topic | URL |
|---|---|
| Design multitenant and isolated content in Azure AI Search | https://learn.microsoft.com/en-us/azure/search/search-modeling-multitenant-saas-applications |
| Design multi-region architectures for Azure AI Search | https://learn.microsoft.com/en-us/azure/search/search-multi-region |
Limits & Quotas
| Topic | URL |
|---|---|
| Billing limits and free quotas for Azure AI Search enrichment | https://learn.microsoft.com/en-us/azure/search/cognitive-search-attach-cognitive-services |
| Manage Azure AI Search indexer runs and resets | https://learn.microsoft.com/en-us/azure/search/search-howto-run-reset-indexers |
| Configure Azure AI Search indexer schedules and limits | https://learn.microsoft.com/en-us/azure/search/search-howto-schedule-indexers |
| Understand indexer execution quotas on Serverless and S3 HD | https://learn.microsoft.com/en-us/azure/search/search-indexer-high-density-serverless-overview |
| Azure AI Search service limits by tier | https://learn.microsoft.com/en-us/azure/search/search-limits-quotas-capacity |
| Create and load Azure AI Search index with .NET | https://learn.microsoft.com/en-us/azure/search/tutorial-csharp-create-load-index |
| Understand Azure AI Search vector index size limits | https://learn.microsoft.com/en-us/azure/search/vector-search-index-size |
Security
Configuration
Integrations & Coding Patterns
Deployment
| Topic | URL |
|---|---|
| Deploy Azure AI Search with ARM templates | https://learn.microsoft.com/en-us/azure/search/search-get-started-arm |
| Deploy Azure AI Search using Bicep | https://learn.microsoft.com/en-us/azure/search/search-get-started-bicep |
| Provision Azure AI Search with Terraform | https://learn.microsoft.com/en-us/azure/search/search-get-started-terraform |
| Move Azure AI Search services across regions | https://learn.microsoft.com/en-us/azure/search/search-howto-move-across-regions |
| Check Azure AI Search regional feature availability | https://learn.microsoft.com/en-us/azure/search/search-region-support |
| Deploy Azure AI Search app to Static Web Apps | https://learn.microsoft.com/en-us/azure/search/tutorial-csharp-deploy-static-web-app |