[HORIZONDB] Add private endpoint CLI commands (#10043)

Author: petarperin-mdcs

src/horizondb/HISTORY.rst

@@ -3,6 +3,11 @@
 Release History
 ===============
 
+1.0.0b6
++++++++
+* Add private endpoint connection commands: `az horizondb private-endpoint-connection list/show/approve/reject/delete`.
+* Add private link resource commands: `az horizondb private-link-resource list/show`.
+
 1.0.0b5
 +++++++
 * Add support for configuring public access on HorizonDB clusters through `az horizondb create --public-access` and `az horizondb update --public-access`. Supplying an IP address or range automatically creates a firewall rule.

src/horizondb/README.md

@@ -19,3 +19,20 @@ az extension add --name horizondb
 - `az horizondb create`: Create a new Azure HorizonDB cluster.
 - `az horizondb delete`: Delete an Azure HorizonDB cluster.
 - `az horizondb show`: Show details of an Azure HorizonDB cluster.
+
+### HorizonDB Private Endpoint Connections
+
+*Commands:*
+
+- `az horizondb private-endpoint-connection list`: List private endpoint connections for a HorizonDB cluster.
+- `az horizondb private-endpoint-connection show`: Show details of a HorizonDB private endpoint connection.
+- `az horizondb private-endpoint-connection approve`: Approve a HorizonDB private endpoint connection.
+- `az horizondb private-endpoint-connection reject`: Reject a HorizonDB private endpoint connection.
+- `az horizondb private-endpoint-connection delete`: Delete a HorizonDB private endpoint connection.
+
+### HorizonDB Private Link Resources
+
+*Commands:*
+
+- `az horizondb private-link-resource list`: List private link resources for a HorizonDB cluster.
+- `az horizondb private-link-resource show`: Show details of a HorizonDB private link resource.

src/horizondb/azext_horizondb/_client_factory.py

@@ -40,3 +40,11 @@ def cf_horizondb_clusters(cli_ctx, _):
 
 def cf_horizondb_firewall_rules(cli_ctx, _):
     return get_horizondb_management_client(cli_ctx).horizon_db_firewall_rules
+
+
+def cf_horizondb_private_endpoint_connections(cli_ctx, _):
+    return get_horizondb_management_client(cli_ctx).horizon_db_private_endpoint_connections
+
+
+def cf_horizondb_private_link_resources(cli_ctx, _):
+    return get_horizondb_management_client(cli_ctx).horizon_db_private_link_resources

src/horizondb/azext_horizondb/_help.py

@@ -130,3 +130,86 @@
   - name: Delete a firewall rule.
     text: az horizondb firewall-rule delete --resource-group exampleresourcegroup --cluster-name examplecluster --name allowclientip
 """
+
+
+helps['horizondb private-endpoint-connection'] = """
+type: group
+short-summary: Manage HorizonDB private endpoint connections.
+"""
+
+
+helps['horizondb private-endpoint-connection list'] = """
+type: command
+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 --cluster-name examplecluster
+"""
+
+
+helps['horizondb private-endpoint-connection show'] = """
+type: command
+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 --cluster-name examplecluster --name exampleconnection
+  - name: Show a private endpoint connection by resource ID.
+    text: az horizondb private-endpoint-connection show --id /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.HorizonDb/clusters/{clusterName}/privateEndpointConnections/{connectionName}
+"""
+
+
+helps['horizondb private-endpoint-connection approve'] = """
+type: command
+short-summary: Approve a HorizonDB private endpoint connection.
+examples:
+  - name: Approve a private endpoint connection by cluster and connection name.
+    text: az horizondb private-endpoint-connection approve --resource-group exampleresourcegroup --cluster-name examplecluster --name exampleconnection --description "Approved"
+  - name: Approve a private endpoint connection by resource ID.
+    text: az horizondb private-endpoint-connection approve --id /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.HorizonDb/clusters/{clusterName}/privateEndpointConnections/{connectionName} --description "Approved"
+"""
+
+
+helps['horizondb private-endpoint-connection reject'] = """
+type: command
+short-summary: Reject a HorizonDB private endpoint connection.
+examples:
+  - name: Reject a private endpoint connection by cluster and connection name.
+    text: az horizondb private-endpoint-connection reject --resource-group exampleresourcegroup --cluster-name examplecluster --name exampleconnection --description "Rejected"
+  - name: Reject a private endpoint connection by resource ID.
+    text: az horizondb private-endpoint-connection reject --id /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.HorizonDb/clusters/{clusterName}/privateEndpointConnections/{connectionName} --description "Rejected"
+"""
+
+
+helps['horizondb private-endpoint-connection delete'] = """
+type: command
+short-summary: Delete a HorizonDB private endpoint connection.
+examples:
+  - name: Delete a private endpoint connection by cluster and connection name.
+    text: az horizondb private-endpoint-connection delete --resource-group exampleresourcegroup --cluster-name examplecluster --name exampleconnection
+  - name: Delete a private endpoint connection by resource ID.
+    text: az horizondb private-endpoint-connection delete --id /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.HorizonDb/clusters/{clusterName}/privateEndpointConnections/{connectionName}
+"""
+
+
+helps['horizondb private-link-resource'] = """
+type: group
+short-summary: Manage HorizonDB private link resources.
+"""
+
+
+helps['horizondb private-link-resource list'] = """
+type: command
+short-summary: List private link resources for a HorizonDB cluster.
+examples:
+  - name: List private link resources for a HorizonDB cluster.
+    text: az horizondb private-link-resource list --resource-group exampleresourcegroup --cluster-name examplecluster
+"""
+
+
+helps['horizondb private-link-resource show'] = """
+type: command
+short-summary: Show details of a HorizonDB private link resource.
+examples:
+  - name: Show a private link resource by group name.
+    text: az horizondb private-link-resource show --resource-group exampleresourcegroup --cluster-name examplecluster --group-name DefaultPool
+"""

src/horizondb/azext_horizondb/_params.py

@@ -40,7 +40,6 @@ def _horizondb_params():
                 name='cluster_name',
                 actions=[LocalContextAction.SET, LocalContextAction.GET],
                 scopes=['horizondb']))
-
         administrator_login_arg_type = CLIArgumentType(
             options_list=['--administrator-login', '-u'],
             help='The administrator login name for the cluster.',
@@ -73,6 +72,29 @@ def _horizondb_params():
         parameter_group_arg_type = CLIArgumentType(
             options_list=['--parameter-group'],
             help='The resource ID of the parameter group.')
+        cluster_name_resource_arg_type = CLIArgumentType(
+            metavar='NAME',
+            options_list=['--cluster-name', '-c'],
+            id_part=None,
+            help="Name of the cluster. The name can contain only lowercase letters, numbers, and the hyphen (-) character. Minimum 3 characters and maximum 63 characters.",
+            local_context_attribute=LocalContextAttribute(
+                name='cluster_name',
+                actions=[LocalContextAction.SET, LocalContextAction.GET],
+                scopes=['horizondb']))
+        private_endpoint_connection_name_arg_type = CLIArgumentType(
+            options_list=['--name', '-n'],
+            help='The name of the private endpoint connection associated with the HorizonDB cluster. '
+                 '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.')
+        private_endpoint_connection_description_arg_type = CLIArgumentType(
+            options_list=['--description', '-d'],
+            help='Comments for the approval or rejection.')
+        private_link_resource_group_name_arg_type = CLIArgumentType(
+            options_list=['--group-name'],
+            help='The private link resource group name. For HorizonDB this is the pool name, for example DefaultPool.')
 
         public_access_create_arg_type = CLIArgumentType(
             options_list=['--public-access'],
@@ -161,4 +183,29 @@ def _horizondb_params():
         with self.argument_context('horizondb firewall-rule delete') as c:
             c.argument('yes', arg_type=yes_arg_type)
 
+        for scope in ['show', 'delete', 'approve', 'reject']:
+            with self.argument_context('horizondb private-endpoint-connection {}'.format(scope)) as c:
+                c.argument('resource_group_name', arg_type=resource_group_name_type, required=False)
+                c.argument('cluster_name', arg_type=cluster_name_resource_arg_type, required=False)
+                c.argument('private_endpoint_connection_name',
+                           arg_type=private_endpoint_connection_name_arg_type,
+                           required=False)
+                c.extra('connection_id',
+                        arg_type=private_endpoint_connection_id_arg_type,
+                        required=False)
+                if scope in ['approve', 'reject']:
+                    c.argument('description',
+                               arg_type=private_endpoint_connection_description_arg_type,
+                               required=True)
+
+        with self.argument_context('horizondb private-endpoint-connection list') as c:
+            c.argument('cluster_name', arg_type=cluster_name_resource_arg_type)
+
+        with self.argument_context('horizondb private-link-resource list') as c:
+            c.argument('cluster_name', arg_type=cluster_name_resource_arg_type)
+
+        with self.argument_context('horizondb private-link-resource show') as c:
+            c.argument('cluster_name', arg_type=cluster_name_resource_arg_type)
+            c.argument('group_name', arg_type=private_link_resource_group_name_arg_type, required=True)
+
     _horizondb_params()

src/horizondb/azext_horizondb/cluster_commands.py

@@ -6,9 +6,13 @@
 from azure.cli.core.commands import CliCommandType
 from azext_horizondb._client_factory import (
     cf_horizondb_clusters,
-    cf_horizondb_firewall_rules)
+    cf_horizondb_firewall_rules,
+    cf_horizondb_private_endpoint_connections,
+    cf_horizondb_private_link_resources)
 from azext_horizondb.utils._transformers import (
     table_transform_output)
+from azext_horizondb.utils.validators import (
+    validate_private_endpoint_connection_id)
 
 
 # pylint: disable=too-many-locals, too-many-statements, line-too-long
@@ -24,6 +28,16 @@ def load_command_table(self, _):
     firewall_rule_custom = CliCommandType(
         operations_tmpl='azext_horizondb.commands.firewall_rule_commands#{}',
         client_factory=cf_horizondb_firewall_rules)
+    private_endpoint_commands = CliCommandType(
+        operations_tmpl='azext_horizondb.commands.private_endpoint_commands#{}')
+    horizondb_private_endpoint_connections_sdk = CliCommandType(
+        operations_tmpl='azext_horizondb.vendored_sdks.operations#HorizonDbPrivateEndpointConnectionsOperations.{}',
+        client_factory=cf_horizondb_private_endpoint_connections
+    )
+    horizondb_private_link_resources_sdk = CliCommandType(
+        operations_tmpl='azext_horizondb.vendored_sdks.operations#HorizonDbPrivateLinkResourcesOperations.{}',
+        client_factory=cf_horizondb_private_link_resources
+    )
 
     with self.command_group('horizondb', horizondb_clusters_sdk,
                             custom_command_type=custom_commands,
@@ -42,3 +56,22 @@ def load_command_table(self, _):
         g.custom_command('delete', 'horizondb_firewall_rule_delete')
         g.custom_show_command('show', 'horizondb_firewall_rule_get')
         g.custom_command('list', 'horizondb_firewall_rule_list')
+
+    with self.command_group('horizondb private-endpoint-connection',
+                            horizondb_private_endpoint_connections_sdk,
+                            custom_command_type=private_endpoint_commands,
+                            client_factory=cf_horizondb_private_endpoint_connections) as g:
+        g.custom_command('list', 'horizondb_private_endpoint_connection_list')
+        g.show_command('show', 'get', validator=validate_private_endpoint_connection_id)
+        g.command('delete', 'begin_delete', validator=validate_private_endpoint_connection_id)
+        g.custom_command('approve', 'horizondb_approve_private_endpoint_connection',
+                         validator=validate_private_endpoint_connection_id)
+        g.custom_command('reject', 'horizondb_reject_private_endpoint_connection',
+                         validator=validate_private_endpoint_connection_id)
+
+    with self.command_group('horizondb private-link-resource',
+                            horizondb_private_link_resources_sdk,
+                            custom_command_type=private_endpoint_commands,
+                            client_factory=cf_horizondb_private_link_resources) as g:
+        g.custom_command('list', 'horizondb_private_link_resource_list')
+        g.custom_show_command('show', 'horizondb_private_link_resource_get')

src/horizondb/azext_horizondb/commands/private_endpoint_commands.py

@@ -0,0 +1,66 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+
+
+def horizondb_approve_private_endpoint_connection(
+        client, resource_group_name, cluster_name, private_endpoint_connection_name,
+        description=None):
+    return _update_private_endpoint_connection_status(
+        client, resource_group_name, cluster_name, private_endpoint_connection_name,
+        is_approved=True, description=description)
+
+
+def horizondb_reject_private_endpoint_connection(
+        client, resource_group_name, cluster_name, private_endpoint_connection_name,
+        description=None):
+    return _update_private_endpoint_connection_status(
+        client, resource_group_name, cluster_name, private_endpoint_connection_name,
+        is_approved=False, description=description)
+
+
+def _update_private_endpoint_connection_status(
+        client, resource_group_name, cluster_name, private_endpoint_connection_name,
+        is_approved=True, description=None):
+    from azext_horizondb.vendored_sdks.models import (
+        OptionalPropertiesUpdateableProperties,
+        PrivateEndpointConnectionUpdate,
+        PrivateLinkServiceConnectionState,
+    )
+
+    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)
+
+
+def horizondb_private_endpoint_connection_list(
+        client, resource_group_name, cluster_name):
+    return client.list(
+        resource_group_name=resource_group_name,
+        cluster_name=cluster_name)
+
+
+def horizondb_private_link_resource_list(
+        client, resource_group_name, cluster_name):
+    return client.list(
+        resource_group_name=resource_group_name,
+        cluster_name=cluster_name)
+
+
+def horizondb_private_link_resource_get(
+        client, resource_group_name, cluster_name, group_name):
+    return client.get(
+        resource_group_name=resource_group_name,
+        cluster_name=cluster_name,
+        group_name=group_name)