Create Az CloudHsm Extension for 2025-03-31 by emmeliaAra · Pull Request #8862 · Azure/azure-cli-extensions

emmeliaAra · 2025-06-13T21:16:43Z

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.

azure-client-tools-bot-prd · 2025-06-13T21:16:45Z

Validation for Breaking Change Starting...

Thanks for your contribution!

azure-client-tools-bot-prd · 2025-06-13T21:16:48Z

Hi @emmeliaAra,
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.

github-actions · 2025-06-13T21:16:58Z

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 · 2025-06-13T21:16:58Z

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

github-actions · 2025-06-13T21:17:58Z

CodeGen Tools Feedback Collection

Thank you for using our CodeGen tool. We value your feedback, and we would like to know how we can improve our product. Please take a few minutes to fill our codegen survey

Copilot

Pull Request Overview

Adds the CloudHSM extension for Azure CLI (API version 2025-03-31), including new commands for cluster management, backup/restore operations, and wait/show/delete actions.

Introduces backup start/show and restore start/show commands with LRO support.
Defines main cloudhsm command group and subgroups for backup, restore, and wait.
Adds basic README and HISTORY entries for the new extension.

Reviewed Changes

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

Show a summary per file

File	Description
azext_cloudhsm/aaz/latest/cloudhsm/backup/_start.py	Defines `az cloudhsm backup start` command
azext_cloudhsm/aaz/latest/cloudhsm/backup/_show.py	Implements `az cloudhsm backup show` command
azext_cloudhsm/aaz/latest/cloudhsm/restore/_start.py	Defines `az cloudhsm restore start` command
azext_cloudhsm/aaz/latest/cloudhsm/restore/_show.py	Implements `az cloudhsm restore show` command
azext_cloudhsm/aaz/latest/cloudhsm/_wait.py	Implements `az cloudhsm wait` command
azext_cloudhsm/aaz/latest/cloudhsm/_show.py	Implements `az cloudhsm show` command
azext_cloudhsm/aaz/latest/cloudhsm/_delete.py	Implements `az cloudhsm delete` command
src/cloudhsm/README.md	Adds placeholder usage instructions
src/cloudhsm/HISTORY.rst	Adds initial release history

Comments suppressed due to low confidence (1)

src/cloudhsm/azext_cloudhsm/aaz/latest/cloudhsm/backup/_start.py:14

There are no existing CLI tests for az cloudhsm backup start. Consider adding functional tests to validate LRO polling behavior and output deserialization.

@register_command(

Copilot · 2025-06-13T21:18:30Z

+        # define Arg Group "BackupRequestProperties"
+
+        _args_schema = cls._args_schema
+        _args_schema.blob_container_uri = AAZStrArg(


The --blob-container-uri argument is required for the backup command but required=True is missing. Please add required=True to ensure the CLI enforces this input.

From the Swagger this property is required. however during flattening this property became optional. To enforce this property in the custom.py file I set args_schema_backup.blob_container_uri._required = True.

I did not modify the files generated automatically as per the guidelines. Do I update the start.py file or can we ignore this message ?

https://github.com/Azure/azure-rest-api-specs/blob/292e6eee612b2a1b0bc558fec33bcbca9acb590e/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2025-03-31/cloudhsm.json#L1404

Copilot · 2025-06-13T21:18:30Z

+            pass
+
+


The on_202 callback is empty, so HTTP 202 responses will not populate or return any output. Consider handling in-progress status similar to on_200 or returning a meaningful placeholder.

Suggested change

pass

data = self.deserialize_http_content(session)

self.ctx.set_var(

"instance",

data,

schema_builder=self._build_schema_on_202

)

_schema_on_202 = None

@classmethod

def _build_schema_on_202(cls):

if cls._schema_on_202 is not None:

return cls._schema_on_202

cls._schema_on_202 = AAZObjectType()

_schema_on_202 = cls._schema_on_202

_schema_on_202.properties = AAZObjectType()

properties = cls._schema_on_202.properties

properties.status = AAZStrType(

serialized_name="status",

nullable=True,

flags={"read_only": True},

)

properties.message = AAZStrType(

serialized_name="message",

nullable=True,

flags={"read_only": True},

)

return cls._schema_on_202

Copilot · 2025-06-13T21:18:31Z

+            return cls._schema_on_200
+
+        def on_202(self, session):
+            pass


The on_202 callback is a no-op, so intermediate HTTP 202 statuses in the backup show command aren’t surfaced. You may want to mirror on_200 behavior or explicitly indicate a pending state.

Suggested change

pass

data = self.deserialize_http_content(session)

self.ctx.set_var(

"pending_status",

{

"message": "The backup operation is still in progress.",

"details": data

}

)

github-actions · 2025-06-13T21:20:10Z

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

sushiv4 · 2025-06-16T16:57:24Z

+
+from knack.log import get_logger
+from .aaz.latest.cloudhsm._create import Create as _CloudHsmCreate
+from .aaz.latest.cloudhsm.backup._start import Start as _CloudHsmBackupStart


does this also need to contain _CloudHsmRestoreStart

jsntcy · 2025-06-16T23:23:41Z

@necusjz, could you please help review this PR?

necusjz · 2025-06-17T00:35:12Z

/azp run

azure-pipelines · 2025-06-17T00:35:25Z

Azure Pipelines successfully started running 2 pipeline(s).

necusjz · 2025-06-17T00:39:40Z

plz provide the link of your pull request in Azure/aaz.

…tainerUri and not blobContainerUri

emmeliaAra · 2025-06-23T12:17:03Z

plz provide the link of your pull request in Azure/aaz.

@necusjz PR in AAZ repo: https://github.com/Azure/aaz/pull/790

emmeliaAra added 2 commits June 13, 2025 14:40

Create Az cloudhsm extension for 2025-03-31 #27947

75b99e5

Updates for azdev style

07cdef1

Copilot AI review requested due to automatic review settings June 13, 2025 21:16

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

emmeliaAra requested review from D-Alegria and jkapil June 13, 2025 21:17

Copilot AI reviewed Jun 13, 2025

View reviewed changes

yonzhan requested review from jsntcy and kairu-ms June 13, 2025 23:39

yonzhan assigned kairu-ms Jun 13, 2025

emmeliaAra added 4 commits June 16, 2025 11:34

Add details in history.rst

c1ee0cf

Merge branch 'main' into cloudHsm-2025-03-31-v

6c4862d

Add short abbreviation for domain-name-label-scope

eb4f848

Unregister backup/restore show commands

2a84d1e

sushiv4 reviewed Jun 16, 2025

View reviewed changes

Comment thread src/cloudhsm/azext_cloudhsm/aaz/latest/cloudhsm/backup/_show.py Outdated

sushiv4 reviewed Jun 16, 2025

View reviewed changes

Comment thread src/cloudhsm/azext_cloudhsm/aaz/latest/cloudhsm/restore/_show.py Outdated

jkapil approved these changes Jun 16, 2025

View reviewed changes

sushiv4 reviewed Jun 16, 2025

View reviewed changes

update example for Delete

3ad5be1

jsntcy requested a review from necusjz June 16, 2025 23:22

necusjz reviewed Jun 17, 2025

View reviewed changes

Comment thread src/cloudhsm/README.md Outdated

emmeliaAra and others added 17 commits June 22, 2025 22:52

Create Az cloudhsm extension for 2025-03-31 #27947

13397ae

Updates for azdev style

e91f7aa

Add details in history.rst

27022d9

Add short abbreviation for domain-name-label-scope

6c35efd

Unregister backup/restore show commands

3a93e3b

update example for Delete

d31f666

Fixing Build Gates

e79d318

Adding Readme for Cloudhsm CLI commands

6b8df9c

Fixing test script

655b2e0

Removing wait command to align with managedhsm

9883d9a

Making vesion consistent across files

635b5a7

updating test data.

dd6cc08

Fixing local test error

b3e527c

Fixing test data

a796d64

Unfortunately the swagger property name is called azureStorageBlobCon…

38fdc23

…tainerUri and not blobContainerUri

Updated readme file and Servicename json

16566b5

Merged with Kapil's branch

7bdf11c

Comment backup and restore test cases - to be run locally only

d43c688

necusjz closed this Jun 24, 2025

-            pass
+            data = self.deserialize_http_content(session)
+            self.ctx.set_var(
+                "instance",
+                data,
+                schema_builder=self._build_schema_on_202
+            )
+        _schema_on_202 = None
+        @classmethod
+        def _build_schema_on_202(cls):
+            if cls._schema_on_202 is not None:
+                return cls._schema_on_202
+            cls._schema_on_202 = AAZObjectType()
+            _schema_on_202 = cls._schema_on_202
+            _schema_on_202.properties = AAZObjectType()
+            properties = cls._schema_on_202.properties
+            properties.status = AAZStrType(
+                serialized_name="status",
+                nullable=True,
+                flags={"read_only": True},
+            )
+            properties.message = AAZStrType(
+                serialized_name="message",
+                nullable=True,
+                flags={"read_only": True},
+            )
+            return cls._schema_on_202

-            pass
+            data = self.deserialize_http_content(session)
+            self.ctx.set_var(
+                "pending_status",
+                {
+                    "message": "The backup operation is still in progress.",
+                    "details": data
+                }
+            )

Conversation

emmeliaAra commented Jun 13, 2025

Related command

General Guidelines

About Extension Publish

Uh oh!

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

Uh oh!

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

Uh oh!

github-actions bot commented Jun 13, 2025

Uh oh!

yonzhan commented Jun 13, 2025

Uh oh!

github-actions bot commented Jun 13, 2025

CodeGen Tools Feedback Collection

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jun 13, 2025

Choose a reason for hiding this comment

Uh oh!

emmeliaAra Jun 16, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jun 13, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jun 13, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jun 13, 2025

Uh oh!

Uh oh!

Uh oh!

sushiv4 Jun 16, 2025

Choose a reason for hiding this comment

Uh oh!

jsntcy commented Jun 16, 2025

Uh oh!

necusjz commented Jun 17, 2025

Uh oh!

azure-pipelines bot commented Jun 17, 2025

Uh oh!

Uh oh!

necusjz commented Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

emmeliaAra commented Jun 23, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

necusjz commented Jun 17, 2025 •

edited

Loading