[HORIZONDB] Add private endpoint CLI commands by petarperin-mdcs · Pull Request #10043 · Azure/azure-cli-extensions

petarperin-mdcs · 2026-06-25T13:02:04Z

Related command

az horizondb private-endpoint-connection
az horizondb private-link-resource

Summary

Add HorizonDB-specific private endpoint connection commands: list, show, approve, reject, and delete.
Add HorizonDB-specific private link resource commands: list and show.
Update the vendored HorizonDB SDK private endpoint connection update/delete route shape to match the cluster-scoped backend contract.
Add help, README, history/version updates, and targeted command/validator tests.
Add a replayable scenario test and recording for the HorizonDB private endpoint command surface.

Validation

python -m unittest discover -s src\horizondb\azext_horizondb\tests\latest -p test_horizondb_private_endpoint_commands.py
azdev test test_horizondb_private_endpoint_command_scenario --discover
python -m compileall -q src\horizondb\azext_horizondb
azdev style horizondb
azdev linter horizondb --min-severity medium
git diff --check
python scripts\ci\test_index.py -q

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? (azdev required; see .azure-pipelines/templates/azdev_setup.yml for the install command until azdev==0.2.11b1 is on PyPI)
My extension version conforms to the Extension version schema

For new extensions:

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

Add HorizonDB-specific private link resource and private endpoint connection commands to the preview extension. Update the vendored SDK PEC update/delete route shape to match the cluster-scoped backend contract and add targeted coverage for route generation and ID validation. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

azure-client-tools-bot-prd · 2026-06-25T13:02:11Z

❌Azure CLI Extensions Breaking Change Test

❌cosmosdb-preview

rule cmd_name rule_message suggest_message

❌ 1007 - ParaRemove cosmosdb create cmd cosmosdb create removed parameter disable_local_auth please add back parameter disable_local_auth for cmd cosmosdb create

❌ 1012 - SubgroupRemove cosmosdb keys sub group cosmosdb keys removed please confirm sub group cosmosdb keys removed

❌ 1007 - ParaRemove cosmosdb restore cmd cosmosdb restore removed parameter disable_local_auth please add back parameter disable_local_auth for cmd cosmosdb restore

❌ 1012 - SubgroupRemove cosmosdb softdeleted-account sub group cosmosdb softdeleted-account removed please confirm sub group cosmosdb softdeleted-account removed

❌ 1012 - SubgroupRemove cosmosdb sql softdeleted-container sub group cosmosdb sql softdeleted-container removed please confirm sub group cosmosdb sql softdeleted-container removed

❌ 1012 - SubgroupRemove cosmosdb sql softdeleted-database sub group cosmosdb sql softdeleted-database removed please confirm sub group cosmosdb sql softdeleted-database removed

❌ 1007 - ParaRemove cosmosdb update cmd cosmosdb update removed parameter soft_delete_configuration please add back parameter soft_delete_configuration for cmd cosmosdb update

⚠️ 1010 - ParaPropUpdate cosmosdb create cmd cosmosdb create update parameter continuous_tier: updated property choices from ['Continuous30Days', 'Continuous35Days', 'Continuous7Days'] to ['Continuous30Days', 'Continuous7Days']

⚠️ 1010 - ParaPropUpdate cosmosdb update cmd cosmosdb update update parameter continuous_tier: updated property choices from ['Continuous30Days', 'Continuous35Days', 'Continuous7Days'] to ['Continuous30Days', 'Continuous7Days']

⚠️horizondb

rule cmd_name rule_message suggest_message

⚠️ 1015 - SubgroupPropUpdate horizondb sub group horizondb updated property sub_groups from {} to {'horizondb private-endpoint-connection': {'name': 'horizondb private-endpoint-connection', 'commands': {'horizondb private-endpoint-connection list': {'name': 'horizondb private-endpoint-connection list', 'is_aaz': False, 'parameters': [{'name': 'resource_group_name', 'options': ['--resource-group', '-g'], 'required': True, 'id_part': 'resource_group', 'has_completer': True}, {'name': 'cluster_name', 'options': ['--cluster-name', '-c'], 'required': True}]}, 'horizondb private-endpoint-connection show': {'name': 'horizondb private-endpoint-connection show', 'is_aaz': False, 'parameters': [{'name': 'connection_id', 'options': ['--id']}, {'name': 'resource_group_name', 'options': ['--resource-group', '-g'], 'id_part': 'resource_group', 'has_completer': True}, {'name': 'cluster_name', 'options': ['--cluster-name', '-c']}, {'name': 'private_endpoint_connection_name', 'options': ['--name', '-n']}]}, 'horizondb private-endpoint-connection delete': {'name': 'horizondb private-endpoint-connection delete', 'is_aaz': False, 'parameters': [{'name': '_change_reference', 'options': ['--change-reference']}, {'name': '_acquire_policy_token', 'options': ['--acquire-policy-token']}, {'name': 'connection_id', 'options': ['--id']}, {'name': 'resource_group_name', 'options': ['--resource-group', '-g'], 'id_part': 'resource_group', 'has_completer': True}, {'name': 'cluster_name', 'options': ['--cluster-name', '-c']}, {'name': 'private_endpoint_connection_name', 'options': ['--name', '-n']}]}, 'horizondb private-endpoint-connection approve': {'name': 'horizondb private-endpoint-connection approve', 'is_aaz': False, 'parameters': [{'name': '_change_reference', 'options': ['--change-reference']}, {'name': '_acquire_policy_token', 'options': ['--acquire-policy-token']}, {'name': 'connection_id', 'options': ['--id']}, {'name': 'resource_group_name', 'options': ['--resource-group', '-g'], 'id_part': 'resource_group', 'has_completer': True}, {'name': 'cluster_name', 'options': ['--cluster-name', '-c']}, {'name': 'private_endpoint_connection_name', 'options': ['--name', '-n']}, {'name': 'description', 'options': ['--description', '-d'], 'required': True}]}, 'horizondb private-endpoint-connection reject': {'name': 'horizondb private-endpoint-connection reject', 'is_aaz': False, 'parameters': [{'name': '_change_reference', 'options': ['--change-reference']}, {'name': '_acquire_policy_token', 'options': ['--acquire-policy-token']}, {'name': 'connection_id', 'options': ['--id']}, {'name': 'resource_group_name', 'options': ['--resource-group', '-g'], 'id_part': 'resource_group', 'has_completer': True}, {'name': 'cluster_name', 'options': ['--cluster-name', '-c']}, {'name': 'private_endpoint_connection_name', 'options': ['--name', '-n']}, {'name': 'description', 'options': ['--description', '-d'], 'required': True}]}}, 'sub_groups': {}}, 'horizondb private-link-resource': {'name': 'horizondb private-link-resource', 'commands': {'horizondb private-link-resource list': {'name': 'horizondb private-link-resource list', 'is_aaz': False, 'parameters': [{'name': 'resource_group_name', 'options': ['--resource-group', '-g'], 'required': True, 'id_part': 'resource_group', 'has_completer': True}, {'name': 'cluster_name', 'options': ['--cluster-name', '-c'], 'required': True}]}, 'horizondb private-link-resource show': {'name': 'horizondb private-link-resource show', 'is_aaz': False, 'parameters': [{'name': 'resource_group_name', 'options': ['--resource-group', '-g'], 'required': True, 'id_part': 'resource_group', 'has_completer': True}, {'name': 'cluster_name', 'options': ['--cluster-name', '-c'], 'required': True}, {'name': 'group_name', 'options': ['--group-name'], 'required': True}]}}, 'sub_groups': {}}}

Copilot

Pull request overview

This PR adds Azure HorizonDB CLI support for managing private endpoint connections and private link resources, including wiring new command groups into the extension, updating the vendored SDK request shapes to the cluster-scoped backend contract, and adding targeted validation/tests.

Changes:

Add az horizondb private-endpoint-connection commands (list/show/approve/reject/delete) and az horizondb private-link-resource commands (list/show).
Update vendored SDK private endpoint connection update/delete to use cluster-scoped routes (and update = PUT).
Add --id parsing/validation for private endpoint connection resource IDs plus targeted unit tests; bump extension version and update docs/help/history.

Reviewed changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
src/horizondb/setup.py	Bump extension version to 1.0.0b4.
src/horizondb/README.md	Document new private endpoint/private link command groups.
src/horizondb/HISTORY.rst	Add 1.0.0b4 release notes for the new commands.
src/horizondb/azext_horizondb/vendored_sdks/operations/_operations.py	Update private endpoint connection update/delete request builders + operation signatures to include `cluster_name` and use cluster-scoped routes (PUT for update).
src/horizondb/azext_horizondb/vendored_sdks/aio/operations/_operations.py	Propagate `cluster_name` into async private endpoint connection update/delete operation flows.
src/horizondb/azext_horizondb/utils/validators.py	Add validator to parse/validate `--id` for cluster-scoped private endpoint connection IDs and populate RG/cluster/connection name.
src/horizondb/azext_horizondb/tests/latest/test_horizondb_private_endpoint_commands.py	Add unit tests for ID parsing, request shape changes, and CLI argument required-ness.
src/horizondb/azext_horizondb/commands/private_endpoint_commands.py	Add approve/reject helpers and a private link resource get wrapper.
src/horizondb/azext_horizondb/cluster_commands.py	Register new command groups and bind SDK/custom handlers + validators.
src/horizondb/azext_horizondb/_params.py	Add parameters for private endpoint connection (`--connection-name`, `--id`, `--description`) and private link resource (`--group-name`).
src/horizondb/azext_horizondb/_help.py	Add help entries and examples for the new command groups/commands.
src/horizondb/azext_horizondb/_client_factory.py	Add client factories for private endpoint connections and private link resources operation groups.

petarperin-mdcs · 2026-06-26T13:07:54Z

+    from azext_horizondb._client_factory import cf_horizondb_private_endpoint_connections
+    from azext_horizondb.vendored_sdks.models import (
+        OptionalPropertiesUpdateableProperties,
+        PrivateEndpointConnectionUpdate,
+        PrivateLinkServiceConnectionState,
+    )
+
+    private_endpoint_connections_client = cf_horizondb_private_endpoint_connections(cmd.cli_ctx, None)
+    private_endpoint_connections_client.get(
+        resource_group_name=resource_group_name,
+        cluster_name=cluster_name,
+        private_endpoint_connection_name=private_endpoint_connection_name)
+
+    new_status = 'Approved' if is_approved else 'Rejected'
+    state = PrivateLinkServiceConnectionState(
+        status=new_status,
+        description=description)
+    update = PrivateEndpointConnectionUpdate(
+        properties=OptionalPropertiesUpdateableProperties(
+            private_link_service_connection_state=state))
+
+    return client.begin_update(
+        resource_group_name=resource_group_name,
+        cluster_name=cluster_name,
+        private_endpoint_connection_name=private_endpoint_connection_name,
+        properties=update)


Addressed in 7dc0907 by removing the extra GET before approve/reject; the command now relies on begin_update to surface service validation/errors.

yonzhan · 2026-06-25T22:37:29Z

HORIZONDB

Remove the redundant private endpoint connection GET before approve/reject and add HorizonDB wait/list-command linter fixes. Extend targeted tests for command metadata. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

nasc17 · 2026-06-29T01:50:08Z

+                 'Required if --id is not specified.')
+        private_endpoint_connection_id_arg_type = CLIArgumentType(
+            options_list=['--id'],
+            help='The resource ID of the private endpoint connection associated with the HorizonDB cluster.')


'If specified --cluster-name/-c and --name/-n, this should be omitted.'

Addressed in 7071881 by updating the --id help to reference --cluster-name/-c and --name/-n.

nasc17 · 2026-06-29T01:50:58Z

                scopes=['horizondb']))
+        cluster_name_no_id_arg_type = CLIArgumentType(
+            metavar='NAME',
+            options_list=['--name', '-n'],


Should be '--cluster-name'

cluster_name_resource_arg_type = CLIArgumentType(
metavar='NAME',
options_list=['--cluster-name', '-c'],
id_part='name',
help="Name of the cluster.",
local_context_attribute=LocalContextAttribute(
name='cluster_name',
actions=[LocalContextAction.SET, LocalContextAction.GET],
scopes=['horizondb']))

Addressed in 7071881 by changing the child command cluster argument to --cluster-name/-c.

nasc17 · 2026-06-29T01:52:47Z

 """
+
+
+helps['horizondb wait'] = """


Why was this command added?

unnecessary addition by AI, will remove

Addressed in 7071881 by removing the added wait command. The pre-existing update --no-wait linter finding is now handled with a linter exclusion.

nasc17 · 2026-06-29T01:53:07Z

+short-summary: List private endpoint connections for a HorizonDB cluster.
+examples:
+  - name: List private endpoint connections for a HorizonDB cluster.
+    text: az horizondb private-endpoint-connection list --resource-group exampleresourcegroup --name examplecluster


--cluster-name

Addressed in 7071881 by updating the help example to use --cluster-name.

nasc17 · 2026-06-29T01:53:49Z

+short-summary: Show details of a HorizonDB private endpoint connection.
+examples:
+  - name: Show a private endpoint connection by cluster and connection name.
+    text: az horizondb private-endpoint-connection show --resource-group exampleresourcegroup --name examplecluster --connection-name exampleconnection


--cluster-name examplecluster --name exampleconnection

Addressed in 7071881 by updating examples to use --cluster-name for the cluster and --name for the private endpoint connection.

nasc17 · 2026-06-29T01:54:20Z

            options_list=['--parameter-group'],
            help='The resource ID of the parameter group.')
+        private_endpoint_connection_name_arg_type = CLIArgumentType(
+            options_list=['--connection-name'],


Addressed in 7071881 by changing the private endpoint connection name argument to --name/-n.

nasc17 · 2026-06-29T01:59:24Z

+
+class HorizonDBPrivateEndpointCommandTests(unittest.TestCase):
+
+    def test_private_endpoint_connection_id_commands_do_not_require_resource_group_at_parse_time(self):


Integration test should follow similarly to how we have for Flexible Server. Please update and include recordings. For authoring support check: https://github.com/Azure/azure-cli/blob/dev/doc/authoring_tests.md

Addressed in 7071881 by adding a replayable ScenarioTest and recording for private-link-resource list/show and private-endpoint-connection list/show/approve/reject/delete.

nasc17 · 2026-06-29T02:00:24Z

    async def _update_initial(
        self,
        resource_group_name: str,
+        cluster_name: str,


For awareness, bug has been reported to SDK team for this: Azure/azure-sdk-for-python#47688

Keep as-is if functional.

Thanks. Kept the vendored SDK route fix in this PR since it is required for these commands to call the cluster-scoped HorizonDB backend route.

Update child command arguments to use --cluster-name and --name, remove the added wait command, add a linter exclusion for the pre-existing update --no-wait behavior, and add a recorded scenario test for the HorizonDB private endpoint command surface. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

nasc17 · 2026-06-30T01:43:26Z

@Pan-Qi Please review and merge this PR. Thank you

Pan-Qi · 2026-06-30T03:09:02Z

/azp run

azure-pipelines · 2026-06-30T03:09:15Z

Azure Pipelines successfully started running 2 pipeline(s).

Pan-Qi

Please check the failed CI tests

Copilot AI review requested due to automatic review settings June 25, 2026 13:02

azure-client-tools-bot-prd Bot added this to the July 2026 (2026-07-07) milestone Jun 25, 2026

Copilot started reviewing on behalf of petarperin-mdcs June 25, 2026 13:02 View session

Copilot AI reviewed Jun 25, 2026

View reviewed changes

yonzhan requested a review from jsntcy June 25, 2026 22:37

yonzhan assigned jsntcy Jun 25, 2026

Address HorizonDB PE CLI review feedback

7dc0907

Remove the redundant private endpoint connection GET before approve/reject and add HorizonDB wait/list-command linter fixes. Extend targeted tests for command metadata. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

nasc17 requested review from mattboentoro and nehrao1 June 29, 2026 01:37

nasc17 reviewed Jun 29, 2026

View reviewed changes

nasc17 suggested changes Jun 29, 2026

View reviewed changes

nasc17 reviewed Jun 29, 2026

View reviewed changes

yonzhan requested a review from Pan-Qi June 29, 2026 02:09

yonzhan assigned Pan-Qi Jun 29, 2026

nasc17 approved these changes Jun 30, 2026

View reviewed changes

Pan-Qi approved these changes Jun 30, 2026

View reviewed changes

Pan-Qi requested changes Jun 30, 2026

View reviewed changes


		class HorizonDBPrivateEndpointCommandTests(unittest.TestCase):

		def test_private_endpoint_connection_id_commands_do_not_require_resource_group_at_parse_time(self):

Uh oh!

Conversation

petarperin-mdcs commented Jun 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Related command

Summary

Validation

General Guidelines

Uh oh!

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

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yonzhan commented Jun 25, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nasc17 commented Jun 30, 2026

Uh oh!

Pan-Qi commented Jun 30, 2026

Uh oh!

azure-pipelines Bot commented Jun 30, 2026

Uh oh!

Pan-Qi left a comment • 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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

petarperin-mdcs commented Jun 25, 2026 •

edited

Loading

azure-client-tools-bot-prd Bot commented Jun 25, 2026 •

edited

Loading

Pan-Qi left a comment •

edited

Loading