[AKS] aks-preview: add --enable/--disable-control-plane-metrics by davidkydd · Pull Request #9855 · Azure/azure-cli-extensions

davidkydd · 2026-05-07T08:28:59Z

Surface the new first-class API property
azureMonitorProfile.metrics.controlPlane.enabled (API version 2026-02-02-preview) so users can opt in/out of Azure Monitor managed Prometheus control plane metrics (kube-apiserver, etcd, etc.) without relying on the AFEC-gated preview.

Add --enable-control-plane-metrics on az aks create and az aks update, plus --disable-control-plane-metrics on az aks update.
Validate that --enable-control-plane-metrics requires Azure Monitor metrics to be enabled (either already on the cluster or via --enable-azure-monitor-metrics in the same command), and that enable and disable cannot be combined.
Wire the flags into the create (set_up_azure_monitor_profile) and update (update_azure_monitor_profile) decorator paths.
Bump extension to 20.0.0b9 and add HISTORY entry.

This checklist is used to make sure that common guidelines for a pull request are followed.

Related command

General Guidelines

Have you run azdev style <YOUR_EXT> locally? (pip install azdev required)
Have you run python scripts/ci/test_index.py -q locally? (pip install wheel==0.30.0 required)
My extension version conforms to the Extension version schema

For new extensions:

My extension description/summary conforms to the Extension Summary Guidelines.

About Extension Publish

There is a pipeline to automatically build, upload and publish extension wheels.
Once your pull request is merged into main branch, a new pull request will be created to update src/index.json automatically.
You only need to update the version information in file setup.py and historical information in file HISTORY.rst in your PR but do not modify src/index.json.

Surface the new first-class API property azureMonitorProfile.metrics.controlPlane.enabled (API version 2026-02-02-preview) so users can opt in/out of Azure Monitor managed Prometheus control plane metrics (kube-apiserver, etcd, etc.) without relying on the AFEC-gated preview. - Add --enable-control-plane-metrics on `az aks create` and `az aks update`, plus --disable-control-plane-metrics on `az aks update`. - Validate that --enable-control-plane-metrics requires Azure Monitor metrics to be enabled (either already on the cluster or via --enable-azure-monitor-metrics in the same command), and that enable and disable cannot be combined. - Wire the flags into the create (set_up_azure_monitor_profile) and update (update_azure_monitor_profile) decorator paths. - Bump extension to 20.0.0b7 and add HISTORY entry.

azure-client-tools-bot-prd · 2026-05-07T08:29:03Z

⚠️Azure CLI Extensions Breaking Change Test

⚠️aks-preview

rule cmd_name rule_message suggest_message

⚠️ 1006 - ParaAdd aks create cmd aks create added parameter enable_control_plane_metrics

⚠️ 1006 - ParaAdd aks update cmd aks update added parameter disable_control_plane_metrics

⚠️ 1006 - ParaAdd aks update cmd aks update added parameter enable_control_plane_metrics

github-actions · 2026-05-07T08:29:14Z

The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR.

Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions).
After that please run the following commands to enable git hooks:

pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>

yonzhan · 2026-05-07T08:29:16Z

Thank you for your contribution! We will review the pull request and get back to you soon.

github-actions · 2026-05-07T08:32:59Z

For more info about extension versioning, please refer to Extension version schema

Copilot

Pull request overview

This PR updates the aks-preview extension to surface the new azureMonitorProfile.metrics.controlPlane.enabled API property (2026-02-02-preview) by adding CLI flags to enable/disable Azure Monitor managed Prometheus control plane metrics collection for AKS clusters.

Changes:

Added --enable-control-plane-metrics to az aks create / az aks update, and --disable-control-plane-metrics to az aks update.
Implemented decorator-context validation and wiring to set azure_monitor_profile.metrics.control_plane.enabled during create/update.
Bumped extension version to 20.0.0b7 and added release notes entry.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
src/aks-preview/setup.py	Bumps extension version to 20.0.0b7.
src/aks-preview/HISTORY.rst	Adds release notes entry for the new flags.
src/aks-preview/azext_aks_preview/managed_cluster_decorator.py	Adds new context getters/validation and wires control plane metrics into create/update Azure Monitor profile flows.
src/aks-preview/azext_aks_preview/custom.py	Adds new parameters to `aks_create` / `aks_update` function signatures so they flow into raw parameters.
src/aks-preview/azext_aks_preview/_params.py	Registers the new CLI arguments for `aks create` and `aks update`.
src/aks-preview/azext_aks_preview/_help.py	Documents the new CLI flags in command help.

davidkydd · 2026-05-12T09:26:36Z

+        # Enable control plane metrics if requested.
+        if self.context.get_enable_control_plane_metrics():
+            mc.azure_monitor_profile.metrics.control_plane = (
+                self.models.ManagedClusterAzureMonitorProfileMetricsControlPlane(enabled=True)
+            )
+


Fixed in a7b923c — set_up_azure_monitor_profile now calls get_enable_control_plane_metrics() unconditionally so passing --enable-control-plane-metrics without the parent flag raises RequiredArgumentMissingError on create instead of being silently ignored when _setup_azure_monitor_metrics is skipped.

davidkydd · 2026-05-12T09:26:57Z

+        # Handle enable / disable of control plane metrics independently of the parent metrics flag,
+        # so users can toggle control plane metrics on a cluster that already has metrics enabled.
+        if self.context.get_enable_control_plane_metrics():
+            if mc.azure_monitor_profile is None:
+                mc.azure_monitor_profile = self.models.ManagedClusterAzureMonitorProfile()  # pylint: disable=no-member
+            if mc.azure_monitor_profile.metrics is None:
+                # Should not normally happen — validation requires metrics to be enabled — but guard
+                # against partially-populated profiles to avoid AttributeError.
+                mc.azure_monitor_profile.metrics = (
+                    self.models.ManagedClusterAzureMonitorProfileMetrics(enabled=True)  # pylint: disable=no-member
+                )
+            mc.azure_monitor_profile.metrics.control_plane = (
+                self.models.ManagedClusterAzureMonitorProfileMetricsControlPlane(enabled=True)  # pylint: disable=no-member
+            )
+
+        if self.context.get_disable_control_plane_metrics():
+            if (
+                mc.azure_monitor_profile and
+                mc.azure_monitor_profile.metrics
+            ):
+                mc.azure_monitor_profile.metrics.control_plane = (
+                    self.models.ManagedClusterAzureMonitorProfileMetricsControlPlane(enabled=False)  # pylint: disable=no-member
+                )


Fixed in 3f343fe — added 5 update-decorator tests covering: (1) enable-cp without parent flag raises RequiredArgumentMissingError, (2) enable-cp succeeds when AM metrics already on cluster, (3) enable-cp + disable-am-metrics raises MutuallyExclusiveArgumentError, (4) enable-cp + disable-cp together raises MutuallyExclusiveArgumentError, (5) disable-cp writes control_plane.enabled=False.

…e-azure-monitor-metrics Combining the two flags in the same command produced an inconsistent payload (azureMonitorProfile.metrics.enabled=False AND metrics.controlPlane.enabled=True). Validator now raises MutuallyExclusiveArgumentError up-front. Addresses Copilot review feedback on PR Azure#9855.

…even without parent flag set_up_azure_monitor_profile now invokes get_enable_control_plane_metrics() unconditionally so passing --enable-control-plane-metrics without --enable-azure-monitor-metrics raises RequiredArgumentMissingError instead of being silently ignored when _setup_azure_monitor_metrics is skipped. Addresses Copilot review feedback on PR Azure#9855.

…e wording Previous wording "Requires --enable-azure-monitor-metrics" was misleading on update for clusters that already have Azure Monitor metrics enabled. Updated to "Requires Azure Monitor metrics to be enabled (already enabled or via --enable-azure-monitor-metrics)" for both 'aks create' and 'aks update'. Addresses Copilot review feedback on PR Azure#9855.

The two unreleased bullets under Pending (cli core minimum bump, --k8s-support-plan/--tier on upgrade) are part of 20.0.0b7. Moved into the 20.0.0b7 section so the changelog reflects the actual shipping version. Addresses Copilot review feedback on PR Azure#9855.

Adds 5 update-decorator tests covering the new validation branches and update path: - enable-control-plane-metrics without parent flag raises - enable-control-plane-metrics succeeds when AM metrics already on cluster - enable-control-plane-metrics + disable-azure-monitor-metrics raises - enable + disable control-plane-metrics together raises - disable-control-plane-metrics writes control_plane.enabled=False Addresses Copilot review feedback on PR Azure#9855.

Linter (option_length_too_long, threshold 22) flagged --enable-control-plane-metrics (31) and --disable-control-plane-metrics (32) as too long. Adds --enable-cp-metrics and --disable-cp-metrics short aliases on both 'aks create' and 'aks update'. Canonical long names retained for backward compatibility.

Linter (missing_parameter_help) requires inline help text on c.argument when options_list is set, since the YAML help block in _help.py is not matched once the canonical option name is one of several. Adds inline help= mirroring the YAML wording on all three argument definitions.

- Wrap inline help= strings in _params.py to satisfy line-too-long (C0301). - Update _help.py entries to include the alias forms (--enable-cp-metrics, --disable-cp-metrics) so the linter's unrecognized_help_parameter_rule recognizes the canonical option list.

davidkydd · 2026-05-13T02:15:14Z

/azp run

azure-pipelines · 2026-05-13T02:15:21Z

Commenter does not have sufficient privileges for PR 9855 in repo Azure/azure-cli-extensions

davidkydd · 2026-05-13T02:16:00Z

@yonzhan @zhoxing-ms all copilot comments and gates are passing except for the azure build which I don't have permissions to trigger, could I get a review plz?

Keen to get this out to use for testing purposes, thanks!

FumingZhang · 2026-05-15T02:38:23Z

/azp run

azure-pipelines · 2026-05-15T02:38:35Z

Azure Pipelines successfully started running 2 pipeline(s).

FumingZhang · 2026-05-15T05:33:48Z

/azp run

azure-pipelines · 2026-05-15T05:34:01Z

Azure Pipelines successfully started running 2 pipeline(s).

FumingZhang

lgtm, could you please add a scenario test to validate the change?

Adds live ScenarioTest coverage for --enable-control-plane-metrics and --disable-control-plane-metrics on `az aks create` and `az aks update`: Positive cases: - create with --enable-azure-monitor-metrics + --enable-control-plane-metrics asserts azureMonitorProfile.metrics.controlPlane.enabled == True - update flow on an AM-metrics-enabled cluster: enable then disable control plane metrics, asserting the controlPlane.enabled toggles Negative cases (expect_failure=True): - create --enable-control-plane-metrics without --enable-azure-monitor-metrics - create --enable-control-plane-metrics together with --disable-azure-monitor-metrics - create with both --enable-control-plane-metrics and --disable-control-plane-metrics - update --enable-control-plane-metrics on a cluster lacking AM metrics Addresses scenario-test request on PR Azure#9855.

FumingZhang · 2026-05-18T01:45:41Z

/azp run

azure-pipelines · 2026-05-18T01:45:53Z

Azure Pipelines successfully started running 2 pipeline(s).

FumingZhang · 2026-05-18T02:52:20Z

+    @AKSCustomResourceGroupPreparer(
+        random_name_length=17, name_prefix="clitest", location="westus2"
+    )
+    def test_aks_create_with_control_plane_metrics(


Re-queued live test to validate the change

tests failed, please fix them according to the error msg

Copilot AI review requested due to automatic review settings May 7, 2026 08:29

davidkydd requested a review from FumingZhang as a code owner May 7, 2026 08:29

azure-client-tools-bot-prd Bot added this to the June 2026 (2026-06-02) milestone May 7, 2026

microsoft-github-policy-service Bot requested review from yanzhudd, yonzhan and zhoxing-ms May 7, 2026 08:29

microsoft-github-policy-service Bot assigned yanzhudd and zhoxing-ms May 7, 2026

microsoft-github-policy-service Bot added Auto-Assign Auto assign by bot AKS labels May 7, 2026

Copilot started reviewing on behalf of davidkydd May 7, 2026 08:30 View session

Copilot AI reviewed May 7, 2026

View reviewed changes

yonzhan unassigned zhoxing-ms May 7, 2026

davidkydd added 8 commits May 12, 2026 16:38

Merge branch 'main' into dakydd/ccpmetricsga-20260202preview

5fe4614

Merge branch 'main' into dakydd/ccpmetricsga-20260202preview

b2a70ba

FumingZhang reviewed May 15, 2026

View reviewed changes

FumingZhang reviewed May 18, 2026

View reviewed changes

Conversation

davidkydd commented May 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Related command

General Guidelines

About Extension Publish

Uh oh!

azure-client-tools-bot-prd Bot commented May 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented May 7, 2026

Uh oh!

yonzhan commented May 7, 2026

Uh oh!

github-actions Bot commented May 7, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

davidkydd May 12, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

davidkydd May 12, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

davidkydd commented May 13, 2026

Uh oh!

azure-pipelines Bot commented May 13, 2026

Uh oh!

davidkydd commented May 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

FumingZhang commented May 15, 2026

Uh oh!

azure-pipelines Bot commented May 15, 2026

Uh oh!

FumingZhang commented May 15, 2026

Uh oh!

azure-pipelines Bot commented May 15, 2026

Uh oh!

FumingZhang left a comment

Choose a reason for hiding this comment

Uh oh!

FumingZhang commented May 18, 2026

Uh oh!

azure-pipelines Bot commented May 18, 2026

Uh oh!

FumingZhang May 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

FumingZhang May 18, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

davidkydd commented May 7, 2026 •

edited

Loading

azure-client-tools-bot-prd Bot commented May 7, 2026 •

edited

Loading

davidkydd commented May 13, 2026 •

edited

Loading

FumingZhang May 18, 2026 •

edited

Loading