关于 azure-documentdb
该技能为使用 Azure DocumentDB 的开发者和架构师提供指导,内容涵盖配置、安全、部署和集成。它按运维与设计主题整理本地速查资料及远程文档。
主要功能
- 01排查查询、网络和复制问题
- 02规划索引与高可用性
- 03评估 MongoDB 迁移方案
- 04配置搜索、复制和事务
- 05查阅安全控制与配额
- 06部署、备份及升级集群
适用场景
- 01诊断查询性能或连接问题
- 02规划迁移 MongoDB 至 DocumentDB
- 03设计向量搜索或高可用系统
- 04配置安全集群和部署工作流
MCP 相关
该技能建议使用 mcp_microsoftdocs MCP 工具获取 Microsoft 文档,并以网页抓取作为备用方式。
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ microsoftdocs/ agent-skills --skill azure-documentdb安装后在 Claude Code 中输入/azure-documentdb确认已加载。
详细介绍
Azure DocumentDB 技能
此技能为 Azure DocumentDB 提供专业指导,涵盖故障排除、最佳实践、决策制定、架构与设计模式、限制与配额、安全性、配置、集成与编码模式,以及部署。它结合了本地快速参考内容与远程文档获取功能。
如何使用此技能
IMPORTANT for Agent:使用下方的类别索引查找相关章节。对于标注了行范围的类别(例如
L35-L120),使用read_file读取指定行。对于带文件链接的类别(例如[security.md](security.md)),使用read_file读取链接的参考文件。
IMPORTANT for Agent:如果
metadata.generated_at的时间距今超过 3 个月,请建议用户从仓库拉取最新版本。如果mcp_microsoftdocs工具不可用,请建议用户安装该工具:安装指南
此技能需要网络访问才能获取文档内容:
- 首选:使用
mcp_microsoftdocs:microsoft_docs_fetch,并将查询字符串设为from=learn-agent-skill。返回 Markdown。 - 备用:使用
fetch_webpage,并将查询字符串设为from=learn-agent-skill&accept=text/markdown。返回 Markdown。
类别索引
| 类别 | 行 | 描述 |
|---|---|---|
| 故障排除 | L37-L46 | 诊断并解决 DocumentDB 问题:查询性能、CMK 加密、复制,以及常见连接/网络错误(包括与迁移相关的问题)。 |
| 最佳实践 | L47-L57 | 关于 DocumentDB 索引与查询、安全更改索引,以及配置跨区域复制和高可用性以实现可靠、高性能数据访问的最佳实践。 |
| 决策制定 | L58-L73 | 指导如何选择 DocumentDB 或 MongoDB/Atlas、规划 MongoDB 迁移、选择连接方式与跨区域故障转移,以及在 .NET、Go、TS 和 Python 中选择最佳向量索引/搜索算法。 |
| 架构与设计模式 | L74-L85 | 关于扩展、高可用性/灾难恢复、分片、多云设置,以及在 Azure DocumentDB 上构建 Go/TypeScript AI Agent(包括自主旅行)的模式。 |
| 限制与配额 | L86-L99 | DocumentDB 的限制、配额和配置约束:计算/存储层、免费层上限、SSD 性能、索引/文本索引限制、文档/批次大小、诊断和功能可用性。 |
| 安全性 | L100-L111 | 保护 DocumentDB 集群:静态加密和客户密钥加密、防火墙和公共访问控制、Private Link、Entra ID RBAC、本机用户/权限,以及安全最佳实践。 |
| 配置 | L112-L132 | 配置 DocumentDB 功能:搜索(BM25、向量、模糊、短语、地理)、MongoDB 兼容性、更改流、复制/扩展、事务、Data API、警报和监控。 |
| 集成与编码模式 | L133-L155 | 将 Azure DocumentDB 与语言、驱动程序、RAG 工具和向量搜索集成的模式与代码示例,以及迁移(Mongo/Cassandra)和 MERN、AI 广告等应用场景。 |
| 部署 | L156-L162 | 部署和管理 DocumentDB 集群的指南:从本地开发到 Azure、备份/还原、版本升级,以及使用 Bicep 和 Terraform 进行 IaC 部署。 |
故障排除
| 主题 | URL |
|---|---|
| 排查常见的 Azure DocumentDB 问题 | https://learn.microsoft.com/en-us/azure/documentdb/faq |
| 排查 Azure DocumentDB 中的 CMK 加密问题 | https://learn.microsoft.com/en-us/azure/documentdb/how-to-database-encryption-troubleshoot |
| 使用 DocumentDB 中的 explain() 诊断查询性能 | https://learn.microsoft.com/en-us/azure/documentdb/how-to-read-explain-output |
| 排查常见的 Azure DocumentDB 错误和连接问题 | https://learn.microsoft.com/en-us/azure/documentdb/troubleshoot-common-issues |
| 排查 DocumentDB 迁移的网络连接问题 | https://learn.microsoft.com/en-us/azure/documentdb/troubleshoot-connectivity |
| 排查 Azure DocumentDB 复制问题 | https://learn.microsoft.com/en-us/azure/documentdb/troubleshoot-replication |
最佳实践
| 主题 | URL |
|---|---|
| 在 Azure DocumentDB 中安全地使用后台索引 | https://learn.microsoft.com/en-us/azure/documentdb/background-indexing |
| 在 DocumentDB 中应用跨区域复制最佳实践 | https://learn.microsoft.com/en-us/azure/documentdb/cross-region-replication |
| 在 DocumentDB 中实施 HA 和复制最佳实践 | https://learn.microsoft.com/en-us/azure/documentdb/high-availability-replication-best-practices |
| 为 Azure DocumentDB 集合应用索引最佳实践 | https://learn.microsoft.com/en-us/azure/documentdb/how-to-create-indexes |
| 探索 Azure DocumentDB 中的实用索引场景 | https://learn.microsoft.com/en-us/azure/documentdb/how-to-index |
| 在 DocumentDB 中安全地将非有序索引迁移为有序索引 | https://learn.microsoft.com/en-us/azure/documentdb/how-to-migrate-ordered-indexes |
| 使用 Index Advisor 优化 Azure DocumentDB 查询 | https://learn.microsoft.com/en-us/azure/documentdb/index-advisor |
决策
架构与设计模式
| 主题 | URL |
|---|---|
| 为 Azure DocumentDB 工作负载应用自动缩放行为 | https://learn.microsoft.com/en-us/azure/documentdb/autoscale |
| 了解 Azure DocumentDB 的高可用性和灾难恢复内部机制 | https://learn.microsoft.com/en-us/azure/documentdb/availability-disaster-recovery-under-hood |
| 规划 Azure DocumentDB 集群的高可用性 | https://learn.microsoft.com/en-us/azure/documentdb/high-availability |
| 使用 Azure DocumentDB 设计多云架构 | https://learn.microsoft.com/en-us/azure/documentdb/multi-cloud |
| 为 Azure DocumentDB 设计分片策略 | https://learn.microsoft.com/en-us/azure/documentdb/partitioning |
| 使用 DocumentDB 实现基于 Go 的 AI Agent | https://learn.microsoft.com/en-us/azure/documentdb/quickstart-agent-go |
| 使用 DocumentDB 向量搜索构建 TypeScript AI Agent | https://learn.microsoft.com/en-us/azure/documentdb/quickstart-agent-nodejs |
| 使用 DocumentDB 设计自主旅行 Agent | https://learn.microsoft.com/en-us/azure/documentdb/tutorial-ai-agent |
限制与配额
| 主题 | URL |
|---|---|
| 在 DocumentDB 中使用受支持的计算和存储配置 | https://learn.microsoft.com/en-us/azure/documentdb/compute-storage |
| 在 DocumentDB 中使用受支持的计算和存储配置 | https://learn.microsoft.com/en-us/azure/documentdb/compute-storage |
| 了解 Azure DocumentDB 免费层的限制和功能 | https://learn.microsoft.com/en-us/azure/documentdb/free-tier |
| 配置 DocumentDB 的 Premium SSD v2 性能 | https://learn.microsoft.com/en-us/azure/documentdb/high-performance-storage |
| 配置文本索引并了解其在 DocumentDB 中的限制 | https://learn.microsoft.com/en-us/azure/documentdb/how-to-create-text-index |
| 在层级限制下为 Azure DocumentDB 启用诊断日志 | https://learn.microsoft.com/en-us/azure/documentdb/how-to-monitor-diagnostics-logs |
| 了解 Azure DocumentDB 中的索引行为和限制 | https://learn.microsoft.com/en-us/azure/documentdb/indexing |
| 查阅 Azure DocumentDB 的服务限制和配额 | https://learn.microsoft.com/en-us/azure/documentdb/limitations |
| Azure DocumentDB 中的文档大小和批量写入限制 | https://learn.microsoft.com/en-us/azure/documentdb/max-document-size |
| 跟踪 Azure DocumentDB 功能发布和预览版 | https://learn.microsoft.com/en-us/azure/documentdb/release-notes |
安全性
| 主题 | URL |
|---|---|
| 了解 Azure DocumentDB 的静态数据加密 | https://learn.microsoft.com/en-us/azure/documentdb/database-encryption-at-rest |
| 配置 Azure DocumentDB 防火墙访问规则 | https://learn.microsoft.com/en-us/azure/documentdb/how-to-configure-firewall |
| 为 Azure DocumentDB 配置 Entra ID RBAC 身份验证 | https://learn.microsoft.com/en-us/azure/documentdb/how-to-connect-role-based-access-control |
| 为 Azure DocumentDB 配置客户管理的加密密钥 | https://learn.microsoft.com/en-us/azure/documentdb/how-to-data-encryption |
| 使用 Azure Private Link 保护 Azure DocumentDB | https://learn.microsoft.com/en-us/azure/documentdb/how-to-private-link |
| 管理对 Azure DocumentDB 集群的公共网络访问 | https://learn.microsoft.com/en-us/azure/documentdb/how-to-public-access |
| 管理 DocumentDB 中的辅助原生用户和权限 | https://learn.microsoft.com/en-us/azure/documentdb/secondary-users |
| 对 Azure DocumentDB 集群应用安全最佳实践 | https://learn.microsoft.com/en-us/azure/documentdb/security |
配置
集成与编码模式
部署
| 主题 | URL |
|---|---|
| 使用 DocumentDB 在本地开发并部署到 Azure | https://learn.microsoft.com/en-us/azure/documentdb/development-loop |
| 将 Azure DocumentDB 集群升级到较新的 MongoDB 版本 | https://learn.microsoft.com/en-us/azure/documentdb/how-to-upgrade-cluster |
| 使用 Bicep 部署 Azure DocumentDB 集群 | https://learn.microsoft.com/en-us/azure/documentdb/quickstart-bicep |
| 使用 Terraform 部署 Azure DocumentDB 集群 | https://learn.microsoft.com/en-us/azure/documentdb/quickstart-terraform |
评论
支持 Markdown