{AKS} Vendor new SDK and bump API version to 2025-04-02-preview #8837

FumingZhang · 2025-06-06T03:49:57Z

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

Related command

{AKS} Vendor new SDK and bump API version to 2025-04-02-preview
Deprecate options --safeguards-level, --safeguards-version and --safeguards-excluded-ns in az aks create and az aks update commands.

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.

azure-client-tools-bot-prd · 2025-06-06T03:50:01Z

️✔️Azure CLI Extensions Breaking Change Test

️✔️Non Breaking Changes

azure-client-tools-bot-prd · 2025-06-06T03:50:04Z

Hi @FumingZhang,
Please write the description of changes which can be perceived by customers into HISTORY.rst.
If you want to release a new extension version, please update the version in setup.py as well.

yonzhan · 2025-06-06T03:50:11Z

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

github-actions · 2025-06-06T03:50:12Z

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>

Copilot

Pull Request Overview

This PR vendors a new SDK and updates the API version from 2025-03-02-preview to 2025-04-02-preview. The key changes include updating all recorded URIs in test recordings, modifying the SDKProfile in the extension’s initialization, and updating release documentation in HISTORY.rst and README.rst.

Reviewed Changes

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

File	Description
tests/recordings/*.yaml	Updated API version URIs for consistent versioning in tests
managed_cluster_decorator.py	Commented-out safeguards code now has a TODO for the new deployment safeguard API
init.py	Updated SDKProfile API version to 2025-04-02-preview
README.rst and HISTORY.rst	Updated release notes and versioning details to reflect the new API version

Copilot · 2025-06-06T03:50:53Z

src/aks-preview/azext_aks_preview/managed_cluster_decorator.py

+        # TODO (NickKeller): update this according to the new deployment safeguard API
+        # excludedNamespaces = self.context.get_safeguards_excluded_namespaces()
+        # version = self.context.get_safeguards_version()
+        # level = self.context.get_safeguards_level()
+        # # provided any value?
+        # mc = setup_common_safeguards_profile(level, version, excludedNamespaces, mc, self.models)


Consider removing or cleaning up the commented-out safeguards profile code in set_up_safeguards_profile once the new deployment safeguard API is available, or reference a tracking issue to avoid leaving dead code in production.

Suggested change

# TODO (NickKeller): update this according to the new deployment safeguard API

# excludedNamespaces = self.context.get_safeguards_excluded_namespaces()

# version = self.context.get_safeguards_version()

# level = self.context.get_safeguards_level()

# # provided any value?

# mc = setup_common_safeguards_profile(level, version, excludedNamespaces, mc, self.models)

# TODO (NickKeller): Update this method when the new deployment safeguard API becomes available.

# Tracking issue: https://github.com/Azure/azure-cli/issues/12345

Copilot · 2025-06-06T03:50:53Z

src/aks-preview/azext_aks_preview/managed_cluster_decorator.py

        """Update safeguards profile for the ManagedCluster object
        :return: the ManagedCluster object
        """
+        # TODO (NickKeller): update this according to the new deployment safeguard API

-        self._ensure_mc(mc)
+        # self._ensure_mc(mc)

-        excludedNamespaces = self.context.get_safeguards_excluded_namespaces()
-        version = self.context.get_safeguards_version()
-        level = self.context.get_safeguards_level()
+        # excludedNamespaces = self.context.get_safeguards_excluded_namespaces()
+        # version = self.context.get_safeguards_version()
+        # level = self.context.get_safeguards_level()

-        mc = setup_common_safeguards_profile(level, version, excludedNamespaces, mc, self.models)
+        # mc = setup_common_safeguards_profile(level, version, excludedNamespaces, mc, self.models)

-        if level is not None:
-            mc.safeguards_profile.level = level
-        if version is not None:
-            mc.safeguards_profile.version = version
+        # if level is not None:
+        #     mc.safeguards_profile.level = level
+        # if version is not None:
+        #     mc.safeguards_profile.version = version



The commented-out code in update_safeguards_profile (including the _ensure_mc call and safeguards configuration) could be removed or clearly marked with a reference to an issue, which would improve code clarity and maintainability.

May I ask whether these commented-out lines of code have any impact on the existing logic?

github-actions · 2025-06-06T03:53:46Z

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

yanzhudd · 2025-06-06T04:53:23Z

src/aks-preview/azext_aks_preview/managed_cluster_decorator.py

+        # version = self.context.get_safeguards_version()
+        # level = self.context.get_safeguards_level()
+        # # provided any value?
+        # mc = setup_common_safeguards_profile(level, version, excludedNamespaces, mc, self.models)


May I ask whether these commented-out lines of code have any impact on the existing logic?

The options related to the 'safe guard' feature are being updated. A new backend API design has been introduced, and the feature owner has removed the current safe guard profile from the AKS Swagger. A separate profile will be added soon and feature owner add new implementation then.

For now, as the safe guard related model has been removed, I have to comment out the implementation to pass the test.

Azure/azure-rest-api-specs@3a1d83e

Add new DeploymentSafeguards resource to Microsoft.ContainerService spec azure-rest-api-specs#34902

+ feature owner @NickKeller to help take another look

Any code that sets mc.safeguards_profile is fine to delete instead of comment out. I'd like to leave in the cli flags though, as I want to use those as syntactic sugar to create our resource

OK, I'll remove the implementations

NickKeller · 2025-06-06T13:32:07Z

src/aks-preview/azext_aks_preview/_params.py

-        c.argument("safeguards_excluded_ns", type=str, is_preview=True)
+        c.argument(
+            "safeguards_excluded_ns",
+            deprecate_info=c.deprecate(


I can always "un-deprecate" this option when my PR merges and the sdk for my new resource is generated?

It's not going to add to the managed cluster model, but I would like to use it to specify creating our resource instead

I think "un-deprecate" is not acceptable, I'll revert these changes and let you decide whether to deprecate them.

FumingZhang · 2025-06-10T04:43:20Z

/azp run

azure-pipelines · 2025-06-10T04:43:33Z

Azure Pipelines successfully started running 2 pipeline(s).

azclibot · 2025-06-10T06:28:42Z

[Release] Update index.json for extension [ aks-preview-18.0.0b11 ] : https://dev.azure.com/msazure/One/_build/results?buildId=126776792&view=results

FumingZhang added 5 commits June 5, 2025 18:50

update sdk

50a9635

update default API version

74c5909

update recordings

db6575b

update history

d797a1c

fix for safeguard

6a3ee45

Copilot AI review requested due to automatic review settings June 6, 2025 03:49

FumingZhang requested a review from andyliuliming as a code owner June 6, 2025 03:49

azure-client-tools-bot-prd bot added this to the July 2025 (2025-07-01) milestone Jun 6, 2025

microsoft-github-policy-service bot requested review from yanzhudd, yonzhan and zhoxing-ms June 6, 2025 03:50

microsoft-github-policy-service bot assigned yanzhudd and zhoxing-ms Jun 6, 2025

microsoft-github-policy-service bot added Auto-Assign Auto assign by bot AKS labels Jun 6, 2025

Copilot AI reviewed Jun 6, 2025

View reviewed changes

update

4e2b196

yanzhudd reviewed Jun 6, 2025

View reviewed changes

update history

476b012

NickKeller reviewed Jun 6, 2025

View reviewed changes

update

89f61da

yanzhudd approved these changes Jun 10, 2025

View reviewed changes

yanzhudd merged commit 718c878 into Azure:main Jun 10, 2025
24 checks passed

FumingZhang deleted the fuming/aks-sdk-0605 branch September 10, 2025 03:40

{AKS} Vendor new SDK and bump API version to 2025-04-02-preview #8837

{AKS} Vendor new SDK and bump API version to 2025-04-02-preview #8837

Uh oh!

Conversation

FumingZhang commented Jun 6, 2025 • 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 Jun 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

azure-client-tools-bot-prd bot commented Jun 6, 2025

Uh oh!

yonzhan commented Jun 6, 2025

Uh oh!

github-actions bot commented Jun 6, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jun 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jun 6, 2025

Choose a reason for hiding this comment

Uh oh!

yanzhudd Jun 6, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jun 6, 2025

Uh oh!

yanzhudd Jun 6, 2025

Choose a reason for hiding this comment

Uh oh!

FumingZhang Jun 6, 2025

Choose a reason for hiding this comment

Uh oh!

FumingZhang Jun 6, 2025 • 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!

NickKeller Jun 6, 2025

Choose a reason for hiding this comment

Uh oh!

FumingZhang Jun 10, 2025

Choose a reason for hiding this comment

Uh oh!

NickKeller Jun 6, 2025

Choose a reason for hiding this comment

Uh oh!

FumingZhang Jun 10, 2025

Choose a reason for hiding this comment

Uh oh!

FumingZhang commented Jun 10, 2025

Uh oh!

azure-pipelines bot commented Jun 10, 2025

Uh oh!

Uh oh!

azclibot commented Jun 10, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

FumingZhang commented Jun 6, 2025 •

edited

Loading

azure-client-tools-bot-prd bot commented Jun 6, 2025 •

edited

Loading

FumingZhang Jun 6, 2025 •

edited

Loading