azure-cognitive-search

# 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 indexer/skillset errors, filter and metric issues, permission-filtered results, and private link or storage discrepancies. | | Best Practices | L49-L66 | Best practices for designing, scaling, and troubleshooting enrichment/indexing pipelines, optimizing vector search, performance, and costs, and safely updating Azure AI Search resources. | | Decision Making | L67-L82 | Guidance on choosing regions, tiers, pricing, capacity, connectors, and SDK/API versions, plus how to plan costs and migrate Azure AI Search services and apps to newer APIs. | | Architecture & Design Patterns | L83-L88 | 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 | L89-L98 | Limits, quotas, and capacity planning for Azure AI Search: billing/free enrichment, indexer schedules/concurrency/runtime, service capacity limits, and vector index size/throughput constraints. | | Security | L99-L141 | Securing Azure AI Search: RBAC/Entra ID, keys, encryption, network isolation, indexer auth to data sources (SQL, Storage, SharePoint, Cosmos, Functions), and document-level/label-based access control. | | Configuration | L142-L234 | Configuring Azure AI Search: data sources, index schemas, analyzers, skillsets, enrichment, vectorization, semantic ranker, monitoring, and agentic retrieval/knowledge base setup. | | Integrations & Coding Patterns | L235-L310 | Patterns and code for integrating Azure AI Search: indexers, skills, vectorization, query syntax (Lucene/OData), semantic ranking, filters, pagination, and app/Power BI integrations. | | Deployment | L311-L318 | 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 | | Troubleshoot Azure AI Search indexer issues without errors | https://learn.microsoft.com/en-us/azure/search/search-indexer-troubleshooting | | Diagnose and fix Azure AI Search collection filter errors | 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 search results | 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 | | Use narrow vector data types to reduce Azure AI Search storage | https://learn.microsoft.com/en-us/azure/search/vector-search-how-to-assign-narrow-data-types | | Chunk large documents for Azure AI Search vector retrieval | https://learn.microsoft.com/en-us/azure/search/vector-search-how-to-chunk-documents | | Choose vector optimization and compression in Azure AI Search | https://learn.microsoft.com/en-us/azure/search/vector-search-how-to-configure-compression-storage | | Truncate text-embedding-3 dimensions using MRL in Azure AI Search | https://learn.microsoft.com/en-us/azure/search/vector-search-how-to-truncate-dimensions | ### Decision Making | Topic | URL | |-------|-----| | Migrate Azure AI Search agentic retrieval to latest API | https://learn.microsoft.com/en-us/azure/search/agentic-retrieval-how-to-migrate | | Migrate from deprecated Azure AI Search skills | https://learn.microsoft.com/en-us/azure/search/cognitive-search-skill-deprecated | | Decide and migrate between Azure AI Search REST API versions | https://learn.microsoft.com/en-us/azure/search/search-api-migration | | Estimate Azure AI Search capacity for indexing and queries | https://learn.microsoft.com/en-us/azure/search/search-capacity-planning | | Create Azure AI Search services with appropriate region and tier | https://learn.microsoft.com/en-us/azure/search/search-create-service-portal | | Choose appropriate data source connectors for Azure AI Search | https://learn.microsoft.com/en-us/azure/search/search-data-sources-gallery | | Upgrade Azure AI Search .NET management SDKs | https://learn.microsoft.com/en-us/azure/search/search-dotnet-mgmt-sdk-migration | | Migrate Azure AI Search .NET apps to SDK v11 | https://learn.microsoft.com/en-us/azure/search/search-dotnet-sdk-migration-version-11 | | Upgrade Azure AI Search to higher capacity | https://learn.microsoft.com/en-us/azure/search/search-how-to-upgrade | | Choose Azure AI Search regions under high demand | https://learn.microsoft.com/en-us/azure/search/search-region-capacity | | Plan and manage Azure AI Search costs | https://learn.microsoft.com/en-us/azure/search/search-sku-manage-costs | | Choose Azure AI Search pricing model and tier | https://learn.microsoft.com/en-us/azure/search/search-sku-tier | ### 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 indexer execution, duration, and concurrency | 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 runtime quotas on Serverless and S3 HD | https://learn.microsoft.com/en-us/azure/search/search-indexer-high-density-serverless-overview | | Plan Azure AI Search capacity using service limits | https://learn.microsoft.com/en-us/azure/search/search-limits-quotas-capacity | | Understand Azure AI Search vector index limits | https://learn.microsoft.com/en-us/azure/search/vector-search-index-size | ### Security | Topic | URL | |-------|-----| | Manage access to Web Knowledge Source using Azure CLI | https://learn.microsoft.com/en-us/azure/search/agentic-knowledge-source-how-to-web-manage | | Use built-in Azure Policy definitions for Azure AI Search | https://learn.microsoft.com/en-us/azure/search/policy-reference | | Ingest RBAC scopes from Azure Blob sources | https://learn.microsoft.com/en-us/azure/search/search-blob-indexer-role-based-access | | Implement document-level access control in AI Search | https://learn.microsoft.com/en-us/azure/search/search-document-level-access-overview | | Configure keyless RBAC access to Azure AI Search | https://learn.microsoft.com/en-us/azure/search/search-get-started-rbac | | Configure SharePoint Online indexer permissions in Azure AI Search | https://learn.microsoft.com/en-us/azure/search/search-how-to-index-sharepoint-online | | Configure managed identity access to SQL Managed Instance | https://learn.microsoft.com/en-us/azure/search/search-how-to-index-sql-managed-instance-with-managed-identity | | Secure AI Search indexer connections to SQL Server VMs | https://learn.microsoft.com/en-us/azure/search/search-how-to-index-sql-server | | Configure managed identities and RBAC for Azure AI Search | https://learn.microsoft.com/en-us/azure/search/search-how-to-managed-identities | | Configure Azure AI Search indexer auth to Azure Functions | https://learn.microsoft.com/en-us/azure/search/search-howto-managed-identities-azure-functions | | Secure Cosmos DB indexer connections with managed identity | https://learn.microsoft.com/en-us/azure/search/search-howto-managed-identities-cosmos-db | | Configure managed identity access from Azure AI Search to Azure SQL | https://learn.microsoft.com/en-us/azure/search/search-howto-managed-identities-sql | | Configure managed identity access from Azure AI Search to Storage | https://learn.microsoft.com/en-us/azure/search/search-howto-managed-identities-storage | | Index ACL and RBAC metadata via Push API | https://learn.microsoft.com/en-us/azure/search/search-index-access-control-lists-and-rbac-push-api | | Ingest ADLS Gen2 ACL and RBAC metadata | https://learn.microsoft.com/en-us/azure/search/search-indexer-access-control-lists-and-role-based-access | | Connect Azure AI Search indexers to SQL Managed Instance privately | https://learn.microsoft.com/en-us/azure/search/search-indexer-how-to-access-private-sql | | Set IP firewall rules for Azure AI Search indexers | https://learn.microsoft.com/en-us/azure/search/search-indexer-howto-access-ip-restricted | | Configure shared private link access for Azure AI Search indexers | https://learn.microsoft.com/en-us/azure/search/search-indexer-howto-access-private | | Use trusted service exception for Azure AI Search indexers | https://learn.microsoft.com/en-us/azure/search/search-indexer-howto-access-trusted-service-exception | | Configure indexer access to protected resources | https://learn.microsoft.com/en-us/azure/search/search-indexer-securing-resources | | Ingest Purview sensitivity labels with indexers | https://learn.microsoft.com/en-us/azure/search/search-indexer-sensitivity-labels | | Ingest SharePoint ACL metadata with indexers | https://learn.microsoft.com/en-us/azure/search/search-indexer-sharepoint-access-control-lists | | Configure security and access for Azure AI Search | https://learn.microsoft.com/en-us/azure/search/search-manage | | Enforce ACL and RBAC at query time | https://learn.microsoft.com/en-us/azure/search/search-query-access-control-rbac-enforcement | | Enforce Purview sensitivity labels at query time in Azure AI Search | https://learn.microsoft.com/en-us/azure/search/search-query-sensitivity-labels | | Manage Azure AI Search admin and query API keys | https://learn.microsoft.com/en-us/azure/search/search-security-api-keys | | Apply security best practices to Azure AI Search | https://learn.microsoft.com/en-us/azure/search/search-security-best-practices | | Enable RBAC and Entra ID auth for Azure AI Search | https://learn.microsoft.com/en-us/azure/search/search-security-enable-roles | | Retrieve encryption key details for Azure AI Search resources | https://learn.microsoft.com/en-us/azure/search/search-security-get-encryption-keys | | Configure customer-managed encryption keys for Azure AI Search | https://learn.microsoft.com/en-us/azure/search/search-security-manage-encryption-keys | | Configure cross-tenant CMK encryption for AI Search | https://learn.microsoft.com/en-us/azure/search/search-security-managed-encryption-cross-tenant | | Join Azure AI Search to a network security perimeter | https://learn.microsoft.com/en-us/azure/search/search-security-network-security-perimeter | | Configure Azure AI Search RBAC with Entra ID | https://learn.microsoft.com/en-us/azure/search/search-security-rbac | | Configure client applications for keyless RBAC access to Azure AI Search | https://learn.microsoft.com/en-us/azure/search/search-security-rbac-client-code | | Implement document-level security trimming in Azure AI Search | https://learn.microsoft.com/en-us/azure/search/search-security-trimming-for-azure-search | | Use Azure Policy compliance controls for Azure AI Search | https://learn.microsoft.com/en-us/azure/search/security-controls-policy | | Configure IP firewall and trusted service access for Azure AI Search | https://learn.microsoft.com/en-us/azure/search/service-configure-firewall | | Configure private endpoints for Azure AI Search | https://learn.microsoft.com/en-us/azure/search/service-create-private-endpoint | | Index ADLS Gen2 permissions for secure queries | https://learn.microsoft.com/en-us/azure/search/tutorial-adls-gen2-indexer-acls | ### Configuration | Topic | URL | |-------|-----| | Configure Azure SQL knowledge sources for agentic retrieval | https://learn.microsoft.com/en-us/azure/search/agentic-knowledge-source-how-to-azure-sql |