通过

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

az networkcloud cluster metricsconfiguration

Note

此参考是 Azure CLI（版本 2.75.0 或更高版本） 的网络云 扩展的一部分。 该扩展将在首次运行 az networkcloud cluster metricsconfiguration 命令时自动安装。 了解更多关于扩展的信息。

管理群集的指标配置。

命令

名称 说明 类型 Status
az networkcloud cluster metricsconfiguration create

创建提供的群集的指标配置。

 Extension Preview
az networkcloud cluster metricsconfiguration delete

删除提供的群集的指标配置。

 Extension Preview
az networkcloud cluster metricsconfiguration list

列出群集的指标配置。

 Extension Preview
az networkcloud cluster metricsconfiguration show

获取提供的群集的指标配置。

 Extension Preview
az networkcloud cluster metricsconfiguration update

更新提供的群集的指标配置的属性，或更新与之关联的标记。 属性和标记更新可以独立完成。

 Extension Preview
az networkcloud cluster metricsconfiguration wait

将 CLI 置于等待状态，直到满足条件。

 Extension GA

az networkcloud cluster metricsconfiguration create

预览

此命令处于预览阶段，正在开发中。 参考和支持级别：https://aka.ms/CLI_refstatus

创建提供的群集的指标配置。

az networkcloud cluster metricsconfiguration create --cluster-name
                                                    --collection-interval
                                                    --extended-location
                                                    --resource-group
                                                    [--enabled-metrics]
                                                    [--if-match]
                                                    [--if-none-match]
                                                    [--location]
                                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                    [--tags]

示例

创建或更新群集的指标配置

az networkcloud cluster metricsconfiguration create --cluster-name "clusterName" --extended-location name="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" type="CustomLocation" --location "location" --collection-interval 15 --enabled-metrics "metric1" "metric2" --tags key1="myvalue1" key2="myvalue2" --resource-group "resourceGroupName"

必需参数

--cluster-name

群集的名称。

--collection-interval

将收集指标的间隔（以分钟为单位）。

属性 值
Parameter group: Properties Arguments
--extended-location

与资源关联的群集的扩展位置。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
Parameter group: MetricsConfigurationParameters Arguments
--resource-group -g

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

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--enabled-metrics

除了启用的核心指标集外，已选择启用的指标名称列表。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
Parameter group: Properties Arguments
--if-match

转换的 ETag。 省略此值以始终覆盖当前资源。 指定最后一次看到的 ETag 值，以防止意外覆盖并发更改。

--if-none-match

设置为“*”以允许创建新记录集，但要防止更新现有资源。 其他值将导致服务器出错，因为它们不受支持。

--location -l

未指定资源所在的地理位置，将使用资源组的位置。

属性 值
Parameter group: MetricsConfigurationParameters Arguments
--no-wait

不等待长时间运行的操作完成。

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

资源标记。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
Parameter group: MetricsConfigurationParameters Arguments
全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

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

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

--subscription

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

--verbose

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

属性 值
默认值: False

az networkcloud cluster metricsconfiguration delete

预览

此命令处于预览阶段，正在开发中。 参考和支持级别：https://aka.ms/CLI_refstatus

删除提供的群集的指标配置。

az networkcloud cluster metricsconfiguration delete [--cluster-name]
                                                    [--ids]
                                                    [--if-match]
                                                    [--if-none-match]
                                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                    [--resource-group]
                                                    [--subscription]
                                                    [--yes]

示例

删除群集的指标配置

az networkcloud cluster metricsconfiguration delete --cluster-name "clusterName" --resource-group "resourceGroupName"

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name

群集的名称。

属性 值
Parameter group: Resource Id Arguments
--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性 值
Parameter group: Resource Id Arguments
--if-match

转换的 ETag。 省略此值以始终覆盖当前资源。 指定最后一次看到的 ETag 值，以防止意外覆盖并发更改。

--if-none-match

设置为“*”以允许创建新记录集，但要防止更新现有资源。 其他值将导致服务器出错，因为它们不受支持。

--no-wait

不等待长时间运行的操作完成。

属性 值
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

属性 值
Parameter group: Resource Id Arguments
--subscription

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

属性 值
Parameter group: Resource Id Arguments
--yes -y

不要提示确认。

属性 值
默认值: False
全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

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

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

--verbose

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

属性 值
默认值: False

az networkcloud cluster metricsconfiguration list

预览

此命令处于预览阶段，正在开发中。 参考和支持级别：https://aka.ms/CLI_refstatus

列出群集的指标配置。

az networkcloud cluster metricsconfiguration list --cluster-name
                                                  --resource-group
                                                  [--max-items]
                                                  [--next-token]
                                                  [--skip-token]
                                                  [--top]

示例

列出群集的指标配置

az networkcloud cluster metricsconfiguration list --cluster-name "clusterName" --resource-group "resourceGroupName"

必需参数

--cluster-name

群集的名称。

--resource-group -g

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

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

命令输出中要返回的项总数。 如果可用的项总数大于指定的值，则会在命令的输出中提供令牌。 若要恢复分页，请在后续命令的 --next-token 参数中提供令牌值。

属性 值
Parameter group: Pagination Arguments
--next-token

用于指定开始分页的位置的令牌。 这是先前截断的响应中的令牌值。

属性 值
Parameter group: Pagination Arguments
--skip-token

服务器返回的不透明令牌，用于指示从何处继续列出资源。 这用于在大型结果集中分页。

--top

要从作返回的最大资源数。 示例：“$top=10”。

全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

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

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

--subscription

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

--verbose

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

属性 值
默认值: False

az networkcloud cluster metricsconfiguration show

预览

此命令处于预览阶段，正在开发中。 参考和支持级别：https://aka.ms/CLI_refstatus

获取提供的群集的指标配置。

az networkcloud cluster metricsconfiguration show [--cluster-name]
                                                  [--ids]
                                                  [--resource-group]
                                                  [--subscription]

示例

获取群集的指标配置

az networkcloud cluster metricsconfiguration show --cluster-name "clusterName" --resource-group "resourceGroupName"

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name

群集的名称。

属性 值
Parameter group: Resource Id Arguments
--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性 值
Parameter group: Resource Id Arguments
--resource-group -g

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

属性 值
Parameter group: Resource Id Arguments
--subscription

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

属性 值
Parameter group: Resource Id Arguments
全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

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

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

--verbose

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

属性 值
默认值: False

az networkcloud cluster metricsconfiguration update

预览

此命令处于预览阶段，正在开发中。 参考和支持级别：https://aka.ms/CLI_refstatus

更新提供的群集的指标配置的属性，或更新与之关联的标记。 属性和标记更新可以独立完成。

az networkcloud cluster metricsconfiguration update [--cluster-name]
                                                    [--collection-interval]
                                                    [--enabled-metrics]
                                                    [--ids]
                                                    [--if-match]
                                                    [--if-none-match]
                                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                    [--resource-group]
                                                    [--subscription]
                                                    [--tags]

示例

修补群集的指标配置

az networkcloud cluster metricsconfiguration update --cluster-name "clusterName" --collection-interval 15 --enabled-metrics "metric1" "metric2" --tags key1="myvalue1" key2="myvalue2" --resource-group "resourceGroupName"

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name

群集的名称。

属性 值
Parameter group: Resource Id Arguments
--collection-interval

将收集指标的间隔（以分钟为单位）。

属性 值
Parameter group: Properties Arguments
--enabled-metrics

除了启用的核心指标集外，已选择启用的指标名称列表。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
Parameter group: Properties Arguments
--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性 值
Parameter group: Resource Id Arguments
--if-match

转换的 ETag。 省略此值以始终覆盖当前资源。 指定最后一次看到的 ETag 值，以防止意外覆盖并发更改。

--if-none-match

设置为“*”以允许创建新记录集，但要防止更新现有资源。 其他值将导致服务器出错，因为它们不受支持。

--no-wait

不等待长时间运行的操作完成。

属性 值
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

属性 值
Parameter group: Resource Id Arguments
--subscription

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

属性 值
Parameter group: Resource Id Arguments
--tags

将替换现有标记的 Azure 资源标记。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
Parameter group: MetricsConfigurationUpdateParameters Arguments
全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

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

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

--verbose

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

属性 值
默认值: False

az networkcloud cluster metricsconfiguration wait

将 CLI 置于等待状态，直到满足条件。

az networkcloud cluster metricsconfiguration wait [--cluster-name]
                                                  [--created]
                                                  [--custom]
                                                  [--deleted]
                                                  [--exists]
                                                  [--ids]
                                                  [--interval]
                                                  [--metrics-configuration-name --name]
                                                  [--resource-group]
                                                  [--subscription]
                                                  [--timeout]
                                                  [--updated]

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name

群集的名称。

属性 值
Parameter group: Resource Id Arguments
--created

等待在“Succeeded”中使用“provisioningState”创建。

属性 值
Parameter group: Wait Condition Arguments
默认值: False
--custom

等待条件满足自定义 JMESPath 查询。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

属性 值
Parameter group: Wait Condition Arguments
--deleted

等到删除为止。

属性 值
Parameter group: Wait Condition Arguments
默认值: False
--exists

等待资源存在。

属性 值
Parameter group: Wait Condition Arguments
默认值: False
--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性 值
Parameter group: Resource Id Arguments
--interval

轮询间隔（以秒为单位）。

属性 值
Parameter group: Wait Condition Arguments
默认值: 30
--metrics-configuration-name --name -n

群集的指标配置的名称。

属性 值
Parameter group: Resource Id Arguments
--resource-group -g

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

属性 值
Parameter group: Resource Id Arguments
--subscription

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

属性 值
Parameter group: Resource Id Arguments
--timeout

最大等待（以秒为单位）。

属性 值
Parameter group: Wait Condition Arguments
默认值: 3600
--updated

等到 provisioningState 更新为“Succeeded”。

属性 值
Parameter group: Wait Condition Arguments
默认值: False
全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

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

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

--verbose

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

属性 值
默认值: False