使用Azure模型上下文协议(MCP)服务器,可以使用自然语言提示管理Azure Monitor和工作簿资源。 可以查询Log Analytics工作区、分析操作数据、监视资源运行状况、检索性能指标和管理Azure Monitor工作簿。
Azure Monitor有助于最大程度地提高应用程序和服务的可用性和性能。 它提供了一个全面的解决方案,用于从云和本地环境收集、分析和处理遥测数据。
工作簿提供了一个灵活的画布,用于数据分析和在 Azure 门户中创建丰富的视觉报表。 它们允许你从各个Azure中挖掘多个数据源,并将其合并为统一的交互式体验。 工作簿可以结合多个类型的可视化效果和分析,非常适合自由探索。 有关详细信息,请参阅 Azure Monitor 工作簿文档。
注释
Tool 参数:Azure MCP 服务器工具为完成任务所需的数据定义参数。 其中一些参数特定于每个工具,如下所示。 其他参数是全局参数,由所有工具共享。 有关详细信息,请参阅 工具参数。
活动日志:获取活动日志
列出指定 Azure 资源在指定过去小时数的 Azure Monitor 活动日志。 此工具可帮助你了解资源部署历史记录、配置更改和访问模式。 它返回包含时间戳、操作名称、状态和调用方信息的活动日志事件。 使用结果调查失败的部署、意外更改或访问问题。
示例提示包括:
- “列出资源”webapp-prod“的最后 720 小时的活动日志。
| 参数 | 必需还是可选 | Description |
|---|---|---|
| 资源名称 | 必选 | 要检索活动日志的 Azure 资源名称。 |
| 事件级别 | 可选 | 要检索的活动日志级别。 有效级别为:Critical、、ErrorInformational、Verbose。 Warning 如果未提供,则返回所有级别。 |
| Hours | 可选 | 检索从现在起多少小时之前的活动日志。 |
| 资源类型 | 可选 | Azure资源的类型(例如,'Microsoft.Storage/storageAccounts')。 仅在需要区分同名资源时才提供这个。 |
| 顶部 | 可选 | 要检索的活动日志的最大数目。 |
破坏性: ❌ |幂等: ✅ |开放世界: ❌ |只读: ✅ |机密: ❌ |本地必需: ❌
Web 测试:创建或更新 Web 测试
此工具是模型上下文协议(MCP)工具的一部分,在Azure Monitor中创建或更新标准 Web 测试,以检查终结点可用性。 可以指定监视设置,例如 URL、频率、位置和预期响应。 如果测试不存在,此工具将创建它;否则,它会使用新设置更新现有测试。
示例提示包括:
- 在资源组“rg-prod-monitoring”中使用名为“webtest-prod-availability”的 Webtest 资源创建一个新的标准网页测试,并将其与 AppInsights 组件“/subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/rg-ai/providers/microsoft.insights/components/appinsights-prod”关联起来。
- 更新资源组“rg-prod-monitoring”中 Webtest 资源“webtest-prod-availability”的现有标准 Web 测试,将其链接到 AppInsights 组件“/subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/rg-ai/providers/microsoft.insights/components/appinsights-prod”。
| 参数 | 必需还是可选 | Description |
|---|---|---|
| 资源组 | 必选 | Azure资源组的名称。 |
| Webtest 资源 | 必选 | 要操作的 Web 测试的资源名称。 |
| Appinsights 组件 | 可选 | 要与 Web 测试关联的 Application Insights 组件的资源 ID。 |
| 说明 | 可选 | Web 测试的简要说明。 |
| 已启用 | 可选 | 是否启用 Web 测试。 |
| 预期状态代码 | 可选 | 预期的 HTTP 状态代码。 |
| 遵循重定向 | 可选 | 是否遵循 HTTP 重定向。 |
| 频率 | 可选 | 测试频率(以秒为单位)。 支持的值:300、600、900。 |
| Headers | 可选 | 在请求中包含的 HTTP 标头应作为逗号分隔的 KEY=VALUE 对。 |
| HTTP 谓词 | 可选 | 要使用的 HTTP 方法,例如获取或发布。 |
| 忽略状态代码 | 可选 | 是否忽略状态代码验证。 |
| 位置 | 可选 | 创建 Web 测试资源的位置。 这应与 Application Insights 组件位置匹配。 |
| 分析请求 | 可选 | 是否分析依赖请求。 |
| 请求正文 | 可选 | 要随请求一起发送的正文。 |
| 请求 URL | 可选 | 要测试的绝对 URL。 |
| 已启用重试 | 可选 | 是否启用重试。 |
| SSL 检查 | 可选 | 是否验证 SSL 证书。 |
| SSL 有效期检查 | 可选 | 检查 SSL 证书生存期的天数。 |
| 超时 | 可选 | 请求超时(以秒为单位)。 支持的值:30、60、90、120。 |
| Web 测试名称 | 可选 | Web 测试资源中测试的名称。 |
| Webtest 位置 | 可选 | 要运行测试的逗号分隔位置列表。 位置是指用于可用性测试的地理位置人口标签。 |
破坏性: ✅ |幂等: ✅ |开放世界: ❌ |只读: ❌ |机密: ❌ |本地必需: ❌
Web 测试:获取 Web 测试
此工具获取特定 Web 测试的详细信息或列出所有 Web 测试。 指定 Webtest 资源时,此工具将返回该 Web 测试的详细信息。 如果未指定 Webtest 资源,此工具将返回订阅中所有 Web 测试的列表,并且可以按资源组筛选列表。
示例提示包括:
- 在资源组“rg-monitoring”的订阅中获取 Web 测试资源“webtest-prod”的 Web 测试详细信息。
- “列出我的订阅中的所有 Web 测试资源。
- “在资源组”rg-prod“中列出订阅中的所有 Web 测试资源。
| 参数 | 必需还是可选 | Description |
|---|---|---|
| Webtest 资源 | 可选 | 要操作的 Web 测试的资源名称。 |
破坏性: ❌ |幂等: ✅ |开放世界: ❌ |只读: ✅ |机密: ❌ |本地必需: ❌
Log Analytics:列出工作区
此工具列出了订阅中的"Log Analytics" 工作区。 它检索每个工作区的名称、ID、位置和其他键属性。 在查询工作区日志或检查工作区设置之前,可以使用它来标识工作区。
示例提示包括:
- “列出订阅中的Log Analytics工作区。”
- “显示我的Log Analytics工作区。
- 获取我的订阅中的 Log Analytics 工作区。
破坏性: ❌ |幂等: ✅ |开放世界: ❌ |只读: ✅ |机密: ❌ |本地必需: ❌
Log Analytics:表列表
此工具列出Log Analytics工作区中的所有表。 例如,列出资源组“rg-monitoring”中工作区“prod-law”中的表,以预览可用的列和数据类型。 它返回用于生成 Kusto 查询语言 (KQL) 查询的表名称和架构。 可以按表类型进行筛选,例如 CustomLog 或 AzureMetrics。
示例提示包括:
- “列出资源组”rg-prod“中表类型为”CustomLog“的工作区”prod-law“Log Analytics 中的所有表。
- 列出资源组“rg-monitoring”中工作区“f1b2c3d4-5678-90ab-cdef-1234567890ab”中表类型为“AzureMetrics”的所有表。
| 参数 | 必需还是可选 | Description |
|---|---|---|
| 工作区名称 | 可选 | Log Analytics工作区 ID 或名称。 这可以是唯一标识符(GUID)或工作区的显示名称。 |
破坏性: ❌ |幂等: ✅ |开放世界: ❌ |只读: ✅ |机密: ❌ |本地必需: ❌
Log Analytics:获取表类型
此模型上下文协议 (MCP) 工具列出了Azure Log Analytics工作区中的可用表类型。 它返回表类型的名称。 针对Azure Monitor日志编写查询时,可以使用这些名称。
示例提示包括:
- “列出资源组”rg-prod“中Log Analytics工作区名称”prod-law-01“中的所有可用表类型。
- Log Analytics工作区名为“analytics-workspace”、资源组为“rg-logs”的环境中有哪些表类型可用?
| 参数 | 必需还是可选 | Description |
|---|---|---|
| 资源组 | 必选 | 包含工作区的Azure资源组的名称。 |
| 工作区名称 | 必选 | Log Analytics工作区的名称或 ID。 可以使用工作区 GUID 或显示名称。 |
破坏性: ❌ |幂等: ✅ |开放世界: ❌ |只读: ✅ |机密: ❌ |本地必需: ❌
Log Analytics:查询工作区日志
使用 Kusto 查询语言(KQL)跨整个 Log Analytics 工作区查询日志。 此工具运行工作区范围的查询,用于返回工作区中所有资源和表的日志。 此工具是模型上下文协议 (MCP) 工具的一部分。 例如,可以询问:“显示工作区中的所有错误”、“过去 24 小时内我的工作区中发生的情况”、“列出工作区中的失败请求”。
示例提示包括:
- 在资源组“rg-prod”的Log Analytics 工作区“my-workspace”中,从表“Syslog”中使用查询 'errors' 显示日志。
| 参数 | 必需还是可选 | Description |
|---|---|---|
| 查询 | 必选 | Kusto 查询语言(KQL)查询,用于在 Log Analytics 工作区中运行。 可以按名称使用预定义查询: recent 显示最新日志,按 TimeGenerated 排序; errors 显示按 TimeGenerated 排序的错误级别日志。 或者,提供自定义 KQL 查询。 |
| 资源组 | 必选 | 包含工作区的Azure资源组的名称。 |
| 表名称 | 必选 | 在工作区中查询的表的名称。 |
| 工作区名称 | 必选 | Log Analytics工作区 ID 或名称。 可以提供全局唯一标识符(GUID)或工作区的显示名称。 |
| Hours | 可选 | 从现在开始查询的小时数。 |
| Limit | 可选 | 要返回的最大结果数。 |
破坏性: ❌ |幂等: ✅ |开放世界: ❌ |只读: ✅ |机密: ❌ |本地必需: ❌
Log Analytics:查询资源日志
使用 Kusto 查询语言(KQL)查询Log Analytics工作区中特定Azure资源的诊断和活动日志。 此工具将结果筛选到指定的资源,并针对所选表运行提供的 KQL 查询。 例如,询问“显示过去 24 小时内资源'app-monitor'的日志”。
示例提示包括:
- 显示表 "AzureDiagnostics" 中,包含查询 "recent" 的资源 ID "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/rg-prod/providers/Microsoft.Compute/virtualMachines/my-vm" 的日志。
| 参数 | 必需还是可选 | Description |
|---|---|---|
| 查询 | 必选 | 要针对 Log Analytics 工作区执行的 KQL 查询。 可以按名称使用预定义查询: recent 显示由 TimeGenerated 排序的最新日志; errors 显示按 TimeGenerated 排序的错误级别日志。 否则,请提供自定义 KQL 查询。 |
| 资源标识符 | 必选 | 要查询的资源的Azure Resource ID。 示例:/subscriptions/<sub>/resourceGroups/<rg>/providers/Microsoft.OperationalInsights/workspaces/<ws>。 |
| 表名称 | 必选 | 在工作区中查询的表的名称。 |
| Hours | 可选 | 从现在开始查询的小时数。 |
| Limit | 可选 | 要返回的最大结果数。 |
破坏性: ❌ |幂等: ✅ |开放世界: ❌ |只读: ✅ |机密: ❌ |本地必需: ❌
健康状况:获取实体健康状况
此工具用于检索 Azure Monitor 健康模型中某个特定实体的健康状态及最近的健康事件。 模型上下文协议 (MCP) 工具基于自定义运行状况模型报告应用程序级运行状况,而不是基本资源可用性。 若要获得基本资源可用性,请使用 Azure 资源运行状况 或 azmcp_resourcehealth_availability-status_get 工具。 若要查询Log Analytics工作区中的日志,请使用 azmcp_monitor_workspace_log_query。 若要查询特定Azure资源的日志,请使用 azmcp_monitor_resource_log_query。
示例提示包括:
- “使用资源组”rg-prod“中的运行状况模型”app-health-v1“显示实体”order-service“的运行状况状态。
| 参数 | 必需还是可选 | Description |
|---|---|---|
| 实体名称 | 必选 | 要为其获取运行状况的实体。 |
| 健康模型 | 必选 | 要获取其健康状况的模型名称。 |
| 资源组 | 必选 | Azure资源组的名称。 此资源组是Azure资源的逻辑容器。 |
破坏性: ❌ |幂等: ✅ |开放世界: ❌ |只读: ✅ |机密: ❌ |本地必需: ❌
指标:查询指标
查询 Azure Monitor 的资源指标。 此工具返回指定指标的时序数据,帮助你分析资源性能和可用性。 此工具是模型上下文协议 (MCP) 工具的一部分。
示例提示包括:
- “使用指标”requests/duration“和指标命名空间”microsoft.insights/components“分析 Application Insights 资源”appinsights-prod“的性能趋势和响应时间。
- “使用指标命名空间”microsoft.insights/components“检查 Application Insights 资源”appinsights-staging“的可用性指标”availabilityResults/availabilityPercentage“?”
- 使用指标命名空间 "microsoft.insights/components" 获取资源 "appinsights-prod" 的指标 "requests/duration" ,聚合为 "Average" ,间隔为 "PT1M"。
- “使用指标”requests/failed、exceptions/count“和指标命名空间”microsoft.insights/components“调查 Application Insights 资源”appinsights-prod“的错误率和失败请求。
- 查询资源类型“Microsoft.Insights/components”的指标“requests/count”,资源“appinsights-qa”使用指标命名空间“microsoft.insights/components”,时间间隔为“PT5M”。
- 使用指标命名空间“microsoft.insights/components”下的指标“requests/count”,并采用聚合方法“Count”,对于 Application Insights 资源“appinsights-prod”,每秒请求率是多少?
| 参数 | 必需还是可选 | Description |
|---|---|---|
| 指标名称 | 必选 | 要查询的指标的名称,以逗号分隔。 |
| 指标命名空间 | 必选 | 要查询的指标命名空间。 从 azmcp-monitor-metrics-definitions 工具获取此值。 |
| 资源名称 | 必选 | 要查询指标的Azure资源的名称。 |
| 合并 | 可选 | 要使用的聚合类型,例如 Average、Maximum、Minimum、Total 或 Count。 |
| 结束时间 | 可选 | 查询的结束时间(例如 2023-01-01T00:00:00Z,ISO 格式)。 默认为当前时间。 |
| 滤波器 | 可选 | 要应用于指标查询的 OData 筛选器。 |
| Interval | 可选 | 数据点的时间间隔(例如 PT1H ,1 小时, PT5M 5 分钟)。 |
| 最大存储桶数 | 可选 | 要返回的最大时间桶数。 默认值为 50。 |
| 资源类型 | 可选 | Azure资源类型(例如,Microsoft.Storage/storageAccounts、Microsoft.Compute/virtualMachines)。 如果未指定,该工具将尝试从资源名称推断类型。 |
| 开始时间 | 可选 | 查询的开始时间(例如 2023-01-01T00:00:00Z,ISO 格式)。 默认值为 24 小时前。 |
破坏性: ❌ |幂等: ✅ |开放世界: ❌ |只读: ✅ |机密: ❌ |本地必需: ❌
指标:列出指标定义
此工具列出了Azure资源的指标定义。 它返回有关每个指标的元数据,包括命名空间、说明和聚合类型,以便可以确定要查询资源的指标。
示例提示包括:
- “获取资源名称”app-insights-prod“的指标定义。
- 列出资源名称为“mystorageacct”、资源类型为“Microsoft.Storage/storageAccounts”、指标命名空间为“Storage”的指标定义。
- “使用搜索字符串”cpu“显示资源名称”vm-prod-01“的指标定义,并限制”20”。
| 参数 | 必需还是可选 | Description |
|---|---|---|
| 资源名称 | 必选 | 要查询指标的Azure资源的名称。 |
| Limit | 可选 | 要返回的最大指标定义数。 默认值为 10。 |
| 指标命名空间 | 可选 | 要查询的指标命名空间。 从 azmcp-monitor-metrics-definitions 工具获取此值。 |
| 资源类型 | 可选 | Azure资源类型(例如,Microsoft.Storage/storageAccounts、Microsoft.Compute/virtualMachines)。 如果未指定,该工具将尝试从资源名称推断资源类型。 |
| 搜索字符串 | 可选 | 用于筛选指标定义的字符串。 该筛选器对指标名称和说明执行不区分大小写的匹配。 |
破坏性: ❌ |幂等: ✅ |开放世界: ❌ |只读: ✅ |机密: ❌ |本地必需: ❌
仪表:获取学习资源
此工具列出用于Azure Monitor检测的所有可用学习资源,或者按路径检索特定资源的内容。 默认情况下,该工具返回所有资源路径。 如果指定路径,该工具将返回完整的资源内容。 若要检测应用程序,请使用业务流程协调程序启动工具。
示例提示包括:
- 在路径“onboarding/get-started.md”获取入门学习资源。
- 在路径“onboarding/quickstart.md”中,展示给我Azure Monitor入门学习资源的内容。
- 检索位于路径'samples/instrumentation-guide.html'的Azure Monitor学习资源文件的内容。
- 列出所有Azure Monitor入门学习资源。”
- 显示与 Azure Monitor 监控相关的所有学习资源路径。
- 哪些学习资源可用于Azure Monitor工具接入过程?
| 参数 | 必需还是可选 | Description |
|---|---|---|
| 路径 | 可选 | 学习资源路径。 |
破坏性: ❌ |幂等: ✅ |开放世界: ❌ |只读: ✅ |机密: ❌ |本地必需: ✅
仪表:启动编排
从此处开始,获取用于为Azure Monitor添加监控功能的模型上下文协议(MCP)工具。 此工具分析工作区并返回要执行的第一个操作。 执行该操作后,请调用 orchestrator-next 继续。 完全按照 instruction 字段中的指示进行操作。
示例提示包括:
- 开始为工作区路径“/home/dev/workspace-monitoring”启动Azure Monitor的监控编排。
- “分析工作区路径'/src/projects/my-app-workspace',并返回第一个Azure Monitor检测步骤。
- 开始在工作区路径「/workspace/my-app」上为项目进行 Azure Monitor 引导,并为我提供第一步操作。
| 参数 | 必需还是可选 | Description |
|---|---|---|
| 工作区路径 | 必选 | 工作区文件夹的绝对路径。 |
破坏性: ❌ |幂等: ❌ |开放世界: ❌ |只读: ❌ |机密: ❌ |本地必需: ✅
监控:继续编排
完成当前仪表操作后,获取下一个仪表操作。
此工具是模型上下文协议 (MCP) 套件的一部分。
执行上一响应中的确切 instruction 结果后,运行此工具以接收下一个操作。
预期工作流:
- 从 orchestrator-start 或 orchestrator-next 接收操作。
- 请准确执行
instruction字段。 - 使用简洁的
Completion note运行此工具,即可获取下一个操作。
返回:要执行的下一个操作,或 complete 完成所有步骤时的状态。
示例提示包括:
- 完成上一个 Azure Monitor 检测步骤后,获取会话 ID 'session-abc123' 的下一个操作,并记录备注“已将 UseAzureMonitor() 添加到 Program.cs”。
- 获取会话 ID "workspace/session-2026" 的下一个入职操作,完成说明为“运行了 dotnet 添加包 Microsoft.ApplicationInsights”。
- “完成上一个检测步骤后,返回会话 ID”session-789xyz“的下一步,完成说明”已更新 appsettings.json 以启用 Application Insights”。
| 参数 | 必需还是可选 | Description |
|---|---|---|
| 完成说明 | 必选 | 描述你执行操作的一个句子,例如“运行 dotnet add package 命令”或“在 Program.cs 中添加 UseAzureMonitor()”。 |
| 会话 ID | 必选 | 从 orchestrator-start 返回的工作区路径被称为 sessionId。 |
破坏性: ❌ |幂等: ❌ |开放世界: ❌ |只读: ❌ |机密: ❌ |本地必需: ✅
仪表:发送棕地分析
返回状态orchestrator-start后analysis_needed发送棕色域代码分析结果。 此工具是模型上下文协议(MCP)工作流的一部分。 在调用此工具之前,必须扫描工作区源文件并填写分析模板。 此工具成功后,请 orchestrator-next继续操作。
示例提示包括:
- “发送 brownfield 代码分析结果 JSON '{”serviceOptions“:null,”initializers“:null,”processors“:null,”clientUsage“:null,”sampling“:{”found“:false,”hasCustomSampling“:false},”telemetryPipeline“:null,”logging“:null}”,以在请求分析后Azure Monitor检测会话'workspace-7a3b'。"
- 通过提交查找 JSON '{"serviceOptions":{"found":true,"details":"AddApplicationInsightsTelemetry used"},"initializers":[],"processors":[],"clientUsage":null,"sampling":{"found":false,"hasCustomSampling":false},"telemetryPipeline":null,"logging":null}' 到会话 "sess-01234",继续迁移协调。
- “发送已完成的棕色域遥测分析作为结果 JSON '{”serviceOptions“:null,”initializers“:null,”processors“:null,”clientUsage“:{”found“:true},”sampling“:{” found“:false,”hasCustomSampling“:false},”telemetryPipeline“:null,”logging“:{”found“:true}}”用于载入会话'session-9f3b'。
| 参数 | 必需还是可选 | Description |
|---|---|---|
| 结果 JSON | 必选 | 具有棕色字段分析结果的 JSON 对象。 必需属性:serviceOptions(分析 AddApplicationInsightsTelemetry() 调用中的服务选项结果,如果未找到,则为 null)、初始值设定项(分析 ITelemetryInitializer 或 IConfigureOptions<TelemetryConfiguration> 实现中的遥测初始值设定项,如果未找到,则为 null)、处理器(分析 ITelemetryProcessor 实现的遥测处理器结果,如果未找到,则为 null)、clientUsage(分析 TelemetryClient 直接使用的结果,如果未找到,则为 null)、采样(自定义采样配置结果,如果没有自定义采样,则为 null)、telemetryPipeline(自定义 ITelemetryChannel 或 TelemetrySinks 使用情况的结果,如果未找到,则为 null)、日志记录(显式记录器提供程序和筛选器的结果,如果未找到,则为 null)。 对于代码库中不存在的部分,请传递一个空的默认对象,例如找到: false 或 hasCustomSampling: false,而不是 null。 |
| 会话 ID | 必选 |
orchestrator-start中返回的工作区路径为sessionId。 |
破坏性: ❌ |幂等: ❌ |开放世界: ❌ |只读: ❌ |机密: ❌ |本地必需: ✅
仪表:发送增强选择
在orchestrator-start返回状态enhancement_available后提交用户的增强选择。 向用户呈现增强选项,然后使用所选的增强键调用此工具。 可以通过传入逗号分隔的列表来选择多个增强功能,例如redis,processors。 此工具成功后,请 orchestrator-next继续操作。
示例提示包括:
- 提交适用于 Azure Monitor 仪器会话 ID “workspaces/my-app/session-abc123”的增强密钥“redis, processors”。
- “通过将增强密钥”redis“发送到会话 ID”workspaces/prod-app/session-789“来继续检测增强流。
- 发送选定的增强密钥“entityframework”和“otlp”以供入门会话 ID“workspaces/onboard/session-456”使用。
| 参数 | 必需还是可选 | Description |
|---|---|---|
| 增强键 | 必选 | 一个或多个增强键,逗号分隔(例如, redis, redis,processors, entityframework,otlp)。 |
| 会话 ID | 必选 |
orchestrator-start中返回的工作区路径为sessionId。 |
破坏性: ❌ |幂等: ❌ |开放世界: ❌ |只读: ❌ |机密: ❌ |本地必需: ✅
工作簿:列出工作簿
使用 Resource Graph 查询Azure工作簿以快速进行元数据查询。 此工具可帮助你发现、筛选和统计不同范围内的工作簿。
它返回工作簿元数据,包括id、name、locationcategory和时间戳。 默认情况下,它不会返回完整的工作簿内容(serializedData)——要显示全部内容,请使用显示工具,或将 Output format 设置为 full。
默认情况下,搜索以当前Azure上下文(租户/订阅)中的工作簿为目标。 可用于 Resource group 显式指定搜索范围。 该工具默认返回服务器端总计数。 返回的最大结果为 50,最大限制为 1000;使用 Max results. 调整此项。 选择 Output format 用于 summary 最小化令牌,或 full 用于完整 serializedData 输出。
示例提示包括:
- “显示资源组”monitoring-rg“中的所有工作簿。
- “列出资源组”prod-rg“中的共享工作簿。
- 在资源组“analytics-rg”中,自2024-01-15以来,被修改的工作簿有哪些?
| 参数 | 必需还是可选 | Description |
|---|---|---|
| 资源组 | 可选 | 限定搜索范围的 Azure 资源组名称。 |
| 类别 | 可选 | 按类别筛选工作簿(例如,,workbook,sentinelTSG)。 如果未指定,则返回所有类别。 |
| 包括总计计数 | 可选 | 在响应中包含所有匹配工作簿的总计数(默认值:true)。 |
| Kind | 可选 | 按类型筛选工作簿(例如,shareduser)。 如果未指定,则返回所有类型。 |
| 最大结果 | 可选 | 要返回的最大结果数(默认值:50,最大值:1000)。 |
| 修改后的 | 可选 | 筛选在此日期之后修改的工作簿(例如 2024-01-15ISO 8601 格式)。 |
| 名称包含 | 可选 | 筛选显示名称包含此文本的工作簿(不区分大小写)。 |
| 输出格式 | 可选 | 输出格式: summary (仅 ID 和名称、最小标记)、 standard (不包含内容、默认值的元数据)、 full (包括 serializedData)。 |
| 源 ID | 可选 | 按源资源 ID 筛选工作簿(例如,/subscriptions/abc123/resourceGroups/prod/providers/Microsoft.Insights/components/myapp)。 如果未指定,则返回所有工作簿。 |
破坏性: ❌ |幂等: ✅ |开放世界: ❌ |只读: ✅ |机密: ❌ |本地必需: ❌
工作簿:显示工作簿详细信息
通过 Azure 资源管理器 (ARM) API 检索完整的工作簿详细信息,包括 serializedData 内容。 此命令允许获取完整的工作簿定义,包括可视化 JSON。
它返回完整的工作簿属性、 serializedData标记和 ETag。 可以为批处理操作提供多个 Workbook IDs 。 该命令报告单个工作簿发生的部分故障。 为了提高性能,请先使用列表工具查找工作簿,然后再使用显示工具来查看特定的工作簿。
示例提示包括:
- 显示具有资源 ID '/subscriptions/abc123/resourceGroups/monitoring/providers/Microsoft.Insights/workbooks/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1' 的工作簿的详细信息。
- 获取到工作簿『/subscriptions/xyz789/resourceGroups/prod-rg/providers/Microsoft.Insights/workbooks/b1b1b1b1-cccc-dddd-eeee-f2f2f2f2f2f2』的完整定义。
| 参数 | 必需还是可选 | Description |
|---|---|---|
| 工作簿 ID | 必选 | 要检索的工作簿Azure资源 ID。 支持多个批处理操作值。 |
破坏性: ❌ |幂等: ✅ |开放世界: ❌ |只读: ✅ |机密: ❌ |本地必需: ❌
工作簿:创建工作簿
在指定的资源组和订阅中创建新工作簿。 可以设置工作簿的显示名称和序列化的 JSON 内容。 此命令在成功完成后返回创建的工作簿信息。
示例提示包括:
- “使用基本笔记本的序列化内容在资源组”monitoring-rg“中创建名为”Performance Dashboard“的新工作簿。
- “在资源组”prod-rg“中创建名为”基础结构概述“的工作簿,其中包含显示 VM 指标的内容。
| 参数 | 必需还是可选 | Description |
|---|---|---|
| 显示名称 | 必选 | 工作簿的显示名称。 |
| 资源组 | 必选 | 包含工作簿的Azure资源组的名称。 |
| 序列化的内容 | 必选 | 工作簿的序列化 JSON 内容。 |
| 源 ID | 可选 | 工作簿的链接资源 ID。 默认情况下,该属性为 azure monitor。 |
破坏性: ✅ |幂等: ❌ |开放世界: ❌ |只读: ❌ |机密: ❌ |本地必需: ❌
工作簿:更新工作簿
通过添加新步骤、修改内容或更改显示名称来更新现有Azure工作簿的属性。 此操作返回更新的工作簿详细信息。 你需要工作簿资源 ID,并且可以指定新的序列化内容或新的显示名称。
示例提示包括:
- 更新工作簿'/subscriptions/abc123/resourceGroups/monitoring-rg/providers/Microsoft.Insights/workbooks/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1',显示名称为“Monthly Report”。
- “更改工作簿 '/subscriptions/xyz789/resourceGroups/prod-rg/providers/Microsoft.Insights/workbooks/b1b1b1b1-cccc-dddd-eeee-f2f2f2f2f2f2' 的序列化内容,以包含新的指标图表。”
| 参数 | 必需还是可选 | Description |
|---|---|---|
| 工作簿 ID | 必选 | 要更新的工作簿Azure资源 ID。 |
| 显示名称 | 可选 | 工作簿的显示名称。 |
| 序列化的内容 | 可选 | 工作簿的 JSON 序列化内容。 |
破坏性: ✅ |幂等: ✅ |开放世界: ❌ |只读: ❌ |机密: ❌ |本地必需: ❌
工作簿:删除工作簿
按其Azure资源 ID 删除一个或多个工作簿。 此命令对工作簿执行软删除,将工作簿保留 90 天。 如果需要,可以通过Azure门户从回收站还原它们。
对于批处理操作,可以提供多个 Workbook IDs 值。 该命令报告每个工作簿的部分故障,确保各个故障不会影响整个批处理操作。
若要了解详细信息,请参阅 Manage Azure Monitor 工作簿。
示例提示包括:
- 删除资源 ID 为'/subscriptions/abc123/resourceGroups/monitoring/providers/Microsoft.Insights/workbooks/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1'的工作簿。
- 删除具有资源 ID '/subscriptions/xyz789/resourceGroups/prod-rg/providers/Microsoft.Insights/workbooks/b1b1b1b1-cccc-dddd-eeee-f2f2f2f2f2f2' 和 '/subscriptions/def456/resourceGroups/analytics-rg/providers/Microsoft.Insights/workbooks/c2c2c2c2-dddd-eeee-ffff-a3a3a3a3a3a3' 的工作簿。
| 参数 | 必需还是可选 | Description |
|---|---|---|
| 工作簿 ID | 必选 | 要删除的工作簿的 Azure 资源 ID。 支持多个批处理操作值。 |
破坏性: ✅ |幂等: ✅ |开放世界: ❌ |只读: ❌ |机密: ❌ |本地必需: ❌
相关内容
- 什么是 Azure MCP 服务器工具?
- 开始使用 Azure MCP Server
- Azure Monitor
- Application Insights
- Azure Monitor 中的 Workbooks
- Azure Monitor 中的指标