你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

az monitor diagnostic-settings

管理服务诊断设置。

命令

名称 说明 类型 状态
az monitor diagnostic-settings categories

检索服务诊断设置类别。

核心 GA
az monitor diagnostic-settings categories list

列出指定资源的诊断设置类别。

核心 GA
az monitor diagnostic-settings categories show

获取指定资源的诊断设置类别。

核心 GA
az monitor diagnostic-settings create

为指定的资源创建诊断设置。 有关详细信息,请访问:https://docs.microsoft.com/rest/api/monitor/diagnosticsettings/createorupdate#metricsettings

核心 GA
az monitor diagnostic-settings delete

删除指定资源的现有诊断设置。

核心 GA
az monitor diagnostic-settings list

获取指定资源的活动诊断设置列表。

核心 GA
az monitor diagnostic-settings show

获取指定资源的活动诊断设置。

核心 GA
az monitor diagnostic-settings subscription

管理订阅的诊断设置。

核心 GA
az monitor diagnostic-settings subscription create

为指定资源创建订阅诊断设置。

核心 GA
az monitor diagnostic-settings subscription delete

删除指定资源的现有订阅诊断设置。

核心 GA
az monitor diagnostic-settings subscription list

获取指定 subscriptionId 的活动订阅诊断设置列表。 :关键字 (keyword)可调用 cls:将传递直接响应的自定义类型或函数:return:SubscriptionDiagnostic设置ResourceCollection 或 cls(response):rtype: ~$(python-base-namespace).v2017_05_01_preview.models.SubscriptionDiagnostic设置ResourceCollection:raises ~azure.core.exceptions.HttpResponseError:。

核心 GA
az monitor diagnostic-settings subscription show

获取指定资源的活动订阅诊断设置。

核心 GA
az monitor diagnostic-settings subscription update

更新指定资源的订阅诊断设置。

核心 GA
az monitor diagnostic-settings update

更新指定资源的诊断设置。

核心 GA

az monitor diagnostic-settings create

为指定的资源创建诊断设置。 有关详细信息,请访问:https://docs.microsoft.com/rest/api/monitor/diagnosticsettings/createorupdate#metricsettings

az monitor diagnostic-settings create --name
                                      --resource
                                      [--event-hub]
                                      [--event-hub-rule]
                                      [--export-to-resource-specific {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--logs]
                                      [--marketplace-partner-id]
                                      [--metrics]
                                      [--resource-group]
                                      [--resource-namespace]
                                      [--resource-parent]
                                      [--resource-type]
                                      [--storage-account]
                                      [--workspace]

示例

创建诊断设置,此处的保留期仅适用于目标是存储帐户。

az monitor diagnostic-settings create --resource {ID} -n {name} --storage-account {storageAccount} --logs "[{category:WorkflowRuntime,enabled:true,retention-policy:{enabled:false,days:0}}]" --metrics "[{category:WorkflowRuntime,enabled:true,retention-policy:{enabled:false,days:0}}]"

必需参数

--name -n

诊断设置的名称。 必需。

--resource

目标资源的名称或 ID。

可选参数

--event-hub

为事件中心命名或 ID。 如果未指定任何事件,则会选择默认事件中心。

--event-hub-rule

事件中心授权规则的名称或 ID。

--export-to-resource-specific

指示必须对资源特定的表(即专用或固定架构表)执行到 LA 的导出,而不是名为 AzureDiagnostics 的默认动态架构表。 仅当参数 --workspace 也给定时,此参数才有效。 允许的值:false、true。

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--logs

日志设置的 JSON 编码列表。 使用“@{file}”从文件加载。有关详细信息,请访问: https://docs.microsoft.com/rest/api/monitor/diagnosticsettings/createorupdate#logsettings 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--marketplace-partner-id

要向其发送诊断日志的市场资源的完整 ARM 资源 ID。

--metrics

指标设置列表。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--resource-namespace

目标资源提供程序命名空间。

--resource-parent

目标资源父路径(如果适用)。

--resource-type

目标资源类型。 还可以接受命名空间/类型格式(例如:“Microsoft.Compute/virtualMachines”。

--storage-account

要向其发送诊断日志的存储帐户的名称或 ID。

--workspace

要向其发送诊断日志的 Log Analytics 工作区的名称或 ID。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az monitor diagnostic-settings delete

删除指定资源的现有诊断设置。

az monitor diagnostic-settings delete --name
                                      --resource
                                      [--resource-group]
                                      [--resource-namespace]
                                      [--resource-parent]
                                      [--resource-type]

必需参数

--name -n

诊断设置的名称。 必需。

--resource

目标资源的名称或 ID。

可选参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--resource-namespace

目标资源提供程序命名空间。

--resource-parent

目标资源父路径(如果适用)。

--resource-type

目标资源类型。 还可以接受命名空间/类型格式(例如:“Microsoft.Compute/virtualMachines”。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az monitor diagnostic-settings list

获取指定资源的活动诊断设置列表。

az monitor diagnostic-settings list --resource
                                    [--resource-group]
                                    [--resource-namespace]
                                    [--resource-parent]
                                    [--resource-type]

必需参数

--resource

目标资源的名称或 ID。

可选参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--resource-namespace

目标资源提供程序命名空间。

--resource-parent

目标资源父路径(如果适用)。

--resource-type

目标资源类型。 还可以接受命名空间/类型格式(例如:“Microsoft.Compute/virtualMachines”。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az monitor diagnostic-settings show

获取指定资源的活动诊断设置。

az monitor diagnostic-settings show --name
                                    --resource
                                    [--resource-group]
                                    [--resource-namespace]
                                    [--resource-parent]
                                    [--resource-type]

必需参数

--name -n

诊断设置的名称。 必需。

--resource

目标资源的名称或 ID。

可选参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--resource-namespace

目标资源提供程序命名空间。

--resource-parent

目标资源父路径(如果适用)。

--resource-type

目标资源类型。 还可以接受命名空间/类型格式(例如:“Microsoft.Compute/virtualMachines”。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az monitor diagnostic-settings update

更新指定资源的诊断设置。

az monitor diagnostic-settings update --name
                                      --resource
                                      [--add]
                                      [--event-hub]
                                      [--event-hub-rule]
                                      [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--log-ana-dtype]
                                      [--logs]
                                      [--marketplace-partner-id]
                                      [--metrics]
                                      [--remove]
                                      [--resource-group]
                                      [--resource-namespace]
                                      [--resource-parent]
                                      [--resource-type]
                                      [--service-bus-rule-id]
                                      [--set]
                                      [--storage-account-id]
                                      [--workspace-id]

必需参数

--name -n

诊断设置的名称。 必需。

--resource

目标资源的名称或 ID。

可选参数

--add

通过指定路径和键值对将对象添加到对象列表。 示例:--add property.listProperty <key=value、string 或 JSON 字符串>。

--event-hub

事件中心的名称。 如果未指定任何事件,则会选择默认事件中心。

--event-hub-rule

事件中心授权规则的资源 ID。

--force-string

使用“set”或“add”时,保留字符串文本,而不是尝试转换为 JSON。

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--log-ana-dtype --log-analytics-destination-type

一个字符串,指示导出到 Log Analytics 是否应使用默认目标类型,即 AzureDiagnostics,或使用构造的目标类型,如下所示: _。 可能的值为:专用值和 null(默认值为 null)。

--logs

日志设置的列表。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--marketplace-partner-id

要向其发送诊断日志的市场资源的完整 ARM 资源 ID。

--metrics

指标设置列表。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--remove

从列表中删除属性或元素。 示例:--remove property.list OR --remove propertyToRemove。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--resource-namespace

目标资源提供程序命名空间。

--resource-parent

目标资源父路径(如果适用)。

--resource-type

目标资源类型。 还可以接受命名空间/类型格式(例如:“Microsoft.Compute/virtualMachines”。

--service-bus-rule-id

诊断设置的服务总线规则 ID。 这是为了保持向后兼容性。

--set

通过指定要设置的属性路径和值来更新对象。 示例:--set property1.property2=。

--storage-account-id

要向其发送诊断日志的存储帐户的资源 ID。

--workspace-id

要向其发送诊断日志的 Log Analytics 工作区的完整 ARM 资源 ID。 示例:/subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。