Skip to main content
ClaudeWave
Skill741 repo starsupdated 5d ago

azure-cognitive-search

Azure AI Search is a cloud search service for indexing and querying structured or unstructured data. Use this skill when developing indexes, indexers, skillsets, vector configurations, semantic ranker queries, or retrieval-augmented generation systems on Azure AI Search. It provides expert guidance on architecture, best practices, security, troubleshooting, limits, and deployment patterns specific to Azure AI Search development tasks.

Install in Claude Code
Copy
git clone --depth 1 https://github.com/MicrosoftDocs/Agent-Skills /tmp/azure-cognitive-search && cp -r /tmp/azure-cognitive-search/skills/azure-cognitive-search ~/.claude/skills/azure-cognitive-search
Then start a new Claude Code session; the skill loads automatically.

SKILL.md

# 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`), use `read_file` with the specified lines. For categories with file links (e.g., `[security.md](security.md)`), use `read_file` on the linked reference file

> **IMPORTANT for Agent**: If `metadata.generated_at` is more than 3 months old, suggest the user pull the latest version from the repository. If `mcp_microsoftdocs` tools are not available, suggest the user install it: [Installation Guide](https://github.com/MicrosoftDocs/mcp/blob/main/README.md)

This skill requires **network access** to fetch documentation content:
- **Preferred**: Use `mcp_microsoftdocs:microsoft_docs_fetch` with query string `from=learn-agent-skill`. Returns Markdown.
- **Fallback**: Use `fetch_webpage` with query string `from=learn-agent-skill&accept=text/markdown`. Returns Markdown.

## Category Index

| Category | Lines | Description |
|----------|-------|-------------|
| Troubleshooting | L37-L48 | Diagnosing and fixing Azure AI Search issues: indexer errors/warnings, skillset debugging, OData filters, private link and SharePoint permission problems, and storage/metrics discrepancies. |
| Best Practices | L49-L67 | Best practices for designing, scaling, and troubleshooting Azure AI Search indexing and enrichment (incl. vectors, blobs, concurrency, performance, costs, and responsible GenAI Prompt skill use). |
| Decision Making | L68-L82 | Planning capacity, regions, tiers, pricing, and SDK/REST upgrades for Azure AI Search, including migrations, scaling, and handling regional capacity or cost constraints. |
| Architecture & Design Patterns | L83-L89 | Architectural patterns for Azure AI Search: combining vector and keyword search, designing multitenant or isolated indexes, and building resilient multi-region search deployments. |
| Limits & Quotas | L90-L99 | Limits, quotas, and scheduling for indexers and enrichment, including billing/free tiers, runtime and concurrency caps, vector index size limits, and capacity planning. |
| Security | L100-L140 | Securing Azure AI Search: RBAC, ACLs, keys, encryption, network isolation (VNet, private endpoints, firewalls), and indexer access to data sources with managed identities and policies. |
| Configuration | L141-L225 | Configuring Azure AI Search: data sources, index schemas, analyzers, skillsets/enrichment, vectorization, semantic ranker, query options, logging, and billing for agentic retrieval. |
| Integrations & Coding Patterns | L226-L309 | Patterns and code for integrating Azure AI Search with data sources, skills, vectorization, semantic ranking, and query syntaxes, plus building agentic retrieval and knowledge bases. |
| Deployment | L310-L317 | Deploying and moving Azure AI Search: ARM/Bicep/Terraform provisioning, cross-region migration, and deploying C# search apps to Azure Container Apps. |

### Troubleshooting
| Topic | URL |
|-------|-----|
| Troubleshoot Azure AI Search indexer errors and warnings | https://learn.microsoft.com/en-us/azure/search/cognitive-search-common-errors-warnings |
| Debug and troubleshoot Azure AI Search skillsets | https://learn.microsoft.com/en-us/azure/search/cognitive-search-how-to-debug-skillset |
| Debug Azure AI Search skillsets using portal sessions | https://learn.microsoft.com/en-us/azure/search/cognitive-search-tutorial-debug-sessions |
| Diagnose and fix Azure AI Search indexer issues | https://learn.microsoft.com/en-us/azure/search/search-indexer-troubleshooting |
| Troubleshoot OData collection filters in Azure AI Search | https://learn.microsoft.com/en-us/azure/search/search-query-troubleshoot-collection-filters |
| Troubleshoot shared private link resource issues in Azure AI Search | https://learn.microsoft.com/en-us/azure/search/troubleshoot-shared-private-link-resources |
| Troubleshoot SharePoint permission-filtered queries in Azure AI Search | https://learn.microsoft.com/en-us/azure/search/troubleshoot-sharepoint-query-permission-filtering |
| Diagnose Azure AI Search storage and metric discrepancies | https://learn.microsoft.com/en-us/azure/search/troubleshoot-storage-metrics |

### Best Practices
| Topic | URL |
|-------|-----|
| Design and troubleshoot AI enrichment pipelines in Azure AI Search | https://learn.microsoft.com/en-us/azure/search/cognitive-search-concept-troubleshooting |
| Scale and manage custom skills in Azure AI Search | https://learn.microsoft.com/en-us/azure/search/cognitive-search-custom-skill-scale |
| Apply responsible AI best practices for GenAI Prompt skill | https://learn.microsoft.com/en-us/azure/search/responsible-ai-best-practices-genai-prompt-skill |
| Handle changed and deleted blobs in Azure AI Search | https://learn.microsoft.com/en-us/azure/search/search-how-to-index-azure-blob-changed-deleted |
| Optimize large-scale indexing in Azure AI Search | https://learn.microsoft.com/en-us/azure/search/search-how-to-large-index |
| Apply optimistic concurrency for Azure AI Search resources | https://learn.microsoft.com/en-us/azure/search/search-howto-concurrency |
| Update or rebuild Azure AI Search indexes safely | https://learn.microsoft.com/en-us/azure/search/search-howto-reindex |
| Analyze Azure AI Search query and indexing performance | https://learn.microsoft.com/en-us/azure/search/search-performance-analysis |
| Optimize Azure AI Search query and indexing performance | https://learn.microsoft.com/en-us/azure/search/search-performance-tips |
| Optimize Azure AI Search Serverless costs | https://learn.microsoft.com/en-us/azure/search/serverless-cost-optimization |
azure-active-directory-b2cSkill

Expert knowledge for Azure Active Directory B2C development including troubleshooting, best practices, decision making, architecture & design patterns, limits & quotas, security, configuration, integrations & coding patterns, and deployment. Use when building B2C user flows/custom policies, configuring IdPs/MFA, securing APIs, automating CI/CD, or monitoring with Sentinel, and other Azure Active Directory B2C related development tasks. Not for Azure Role-based access control (use azure-rbac), Azure Information Protection (use azure-information-protection), Azure Security (use azure-security), Azure Sentinel (use azure-sentinel).

azure-advisorSkill

Expert knowledge for Azure Advisor development including best practices, decision making, limits & quotas, security, configuration, and integrations & coding patterns. Use when tuning Advisor alerts, digests, and states, bulk-fixing savings, or querying recommendations via Resource Graph, and other Azure Advisor related development tasks. Not for Cost Management (use azure-cost-management), Azure Monitor (use azure-monitor), Azure Policy (use azure-policy), Azure Security (use azure-security).

azure-ai-visionSkill

Expert knowledge for Azure AI Vision development including decision making, limits & quotas, configuration, integrations & coding patterns, and deployment. Use when using Image Analysis, Read OCR containers, smart-crop thumbnails, background removal, or video frame analysis, and other Azure AI Vision related development tasks. Not for Azure AI Custom Vision (use azure-custom-vision), Azure AI Video Indexer (use azure-video-indexer), Azure AI Document Intelligence (use azure-document-intelligence), Azure AI Immersive Reader (use azure-immersive-reader).

azure-aks-edge-essentialsSkill

Expert knowledge for Azure Kubernetes Service Edge Essentials development including troubleshooting, best practices, decision making, architecture & design patterns, limits & quotas, security, configuration, integrations & coding patterns, and deployment. Use when deploying AKS Edge/Hybrid with Arc, Azure Local, Windows Server nodes, IoT/OPC/ONVIF, or TPM workloads, and other Azure Kubernetes Service Edge Essentials related development tasks. Not for Azure Kubernetes Service (AKS) (use azure-kubernetes-service), Azure Container Apps (use azure-container-apps), Azure Red Hat OpenShift (use azure-redhat-openshift), Azure Stack Edge (use azure-stack-edge).

azure-analysis-servicesSkill

Expert knowledge for Azure Analysis Services development including troubleshooting. Use when resolving server connectivity, firewall/VNet, DNS, client connection, or network error issues, and other Azure Analysis Services related development tasks. Not for Azure Synapse Analytics (use azure-synapse-analytics), Azure SQL Database (use azure-sql-database), Azure SQL Managed Instance (use azure-sql-managed-instance), SQL Server on Azure Virtual Machines (use azure-sql-virtual-machines).

azure-anomaly-detectorSkill

Expert knowledge for Azure AI Anomaly Detector development including troubleshooting, best practices, limits & quotas, configuration, and deployment. Use when tuning Docker-based Anomaly Detector, ACI or IoT Edge deployments, univariate/multivariate APIs, or service limits, and other Azure AI Anomaly Detector related development tasks. Not for Azure AI Metrics Advisor (use azure-metrics-advisor), Azure Monitor (use azure-monitor), Azure Machine Learning (use azure-machine-learning).

azure-api-centerSkill

Expert knowledge for Azure Api Center development including best practices, security, configuration, integrations & coding patterns, and deployment. Use when configuring API Center instances, portal auth, GitHub-based lint/registration, portal self-hosting, or API sync, and other Azure Api Center related development tasks. Not for Azure API Management (use azure-api-management), Azure Resource Manager (use azure-resource-manager), Azure Portal (use azure-portal), Azure Monitor (use azure-monitor).

azure-api-managementSkill

Expert knowledge for Azure API Management development including troubleshooting, best practices, decision making, architecture & design patterns, limits & quotas, security, configuration, integrations & coding patterns, and deployment. Use when integrating APIM with AI backends, Entra/OAuth, VNet/gateways, self-hosted gateways, or multi-region scaling, and other Azure API Management related development tasks. Not for Azure App Service (use azure-app-service), Azure Functions (use azure-functions), Azure Logic Apps (use azure-logic-apps), Azure Service Bus (use azure-service-bus).