[SQL] az sql elastic-pool create: Add support for HighAvailabilityReplica count for HS Elastic pools (#22213)

* Add support for HighAvailabilityReplica count for HS Elastic pools

* Fixed error on update command

* Added tests for HSEP replica count feature

* Minor fix for style concistency

* retrigger checks

* retrigger checks

* retrigger checks

* Updated test recording

* Updated test recording for test_sql_elastic_pool_maintenance

* Updated test recordings

* Fixed small style error

* Update src/azure-cli/azure/cli/command_modules/sql/custom.py

Co-authored-by: Yishi Wang <[email protected]>

* Updated EP hyperscale tests ran in production

* Deleted changes to help_py

* added back changes to help_py

* Added missing help messages for commands

* Added back some lines removed by accident on _params.py

* Added missing comma

* Fixed small typo

* Removed trailing white space

* Added help for storage_uri and storage_key

* Removed 'Allowed values' from help messages

Co-authored-by: Christian Valencia <[email protected]>
Co-authored-by: Yishi Wang <[email protected]>

Author: christianvalencia7

src/azure-cli/azure/cli/command_modules/sql/_help.py

@@ -520,6 +520,8 @@
     text: az sql elastic-pool create -g mygroup -s myserver -n mydb -e Standard -c 100
   - name: Create an elastic pool with GeneralPurpose edition, Gen4 hardware and 1 vcore.
     text: az sql elastic-pool create -g mygroup -s myserver -n mydb -e GeneralPurpose -f Gen4 -c 1
+  - name: Create an elastic pool with Hyperscale edition, Gen5 hardware, 4 vcore and 2 high availability replicas.
+    text: az sql elastic-pool create -g mygroup -s myserver -n mydb -e Hyperscale -f Gen5 -c 4 --ha-replicas 2
 """
 
 helps['sql elastic-pool list-editions'] = """
@@ -557,6 +559,8 @@
     text: az sql elastic-pool update -g mygroup -s myserver -n mypool -z
   - name: Update elastic pool with zone redundancy explicitly disabled
     text: az sql elastic-pool update -g mygroup -s myserver -n mypool -z false
+  - name: Update elastic pool with 2 high availability replicas
+    text: az sql elastic-pool update -g mygroup -s myserver -n mypool --ha-replicas 2
 """
 
 helps['sql failover-group'] = """

src/azure-cli/azure/cli/command_modules/sql/_params.py

@@ -374,20 +374,28 @@ def _configure_db_dw_params(arg_ctx):
     creation_arg_group = 'Creation'
 
     arg_ctx.argument('collation',
-                     arg_group=creation_arg_group)
+                     arg_group=creation_arg_group,
+                     help='The collation of the database.')
 
     arg_ctx.argument('catalog_collation',
                      arg_group=creation_arg_group,
-                     arg_type=get_enum_type(CatalogCollationType))
+                     arg_type=get_enum_type(CatalogCollationType),
+                     help='Collation of the metadata catalog.')
 
     # WideWorldImportersStd and WideWorldImportersFull cannot be successfully created.
     # AdventureWorksLT is the only sample name that is actually supported.
     arg_ctx.argument('sample_name',
                      arg_group=creation_arg_group,
-                     arg_type=get_enum_type([SampleName.adventure_works_lt]))
+                     arg_type=get_enum_type([SampleName.adventure_works_lt]),
+                     help='The name of the sample schema to apply when creating this'
+                     'database.')
 
     arg_ctx.argument('license_type',
-                     arg_type=get_enum_type(DatabaseLicenseType))
+                     arg_type=get_enum_type(DatabaseLicenseType),
+                     help='The license type to apply for this database.'
+                     '``LicenseIncluded`` if you need a license, or ``BasePrice``'
+                     'if you have a license and are eligible for the Azure Hybrid'
+                     'Benefit.')
 
     arg_ctx.argument('zone_redundant',
                      arg_type=zone_redundant_param_type)
@@ -739,17 +747,27 @@ def load_arguments(self, _):
             ])
 
         c.argument('administrator_login',
-                   options_list=['--admin-user', '-u'])
+                   options_list=['--admin-user', '-u'],
+                   help='Required. Administrator login name.')
 
         c.argument('administrator_login_password',
-                   options_list=['--admin-password', '-p'])
+                   options_list=['--admin-password', '-p'],
+                   help='Required. Administrator login password.')
 
         c.argument('authentication_type',
                    options_list=['--auth-type', '-a'],
-                   arg_type=get_enum_type(AuthenticationType))
+                   arg_type=get_enum_type(AuthenticationType),
+                   help='Authentication type.')
+
+        c.argument('storage_key',
+                   help='Required. Storage key.')
 
         c.argument('storage_key_type',
-                   arg_type=get_enum_type(StorageKeyType))
+                   arg_type=get_enum_type(StorageKeyType),
+                   help='Required. Storage key type.')
+
+        c.argument('storage_uri',
+                   help='Required. Storage Uri.')
 
     with self.argument_context('sql db import') as c:
         # Create args that will be used to build up the ImportExistingDatabaseDefinition object
@@ -763,17 +781,27 @@ def load_arguments(self, _):
         ])
 
         c.argument('administrator_login',
-                   options_list=['--admin-user', '-u'])
+                   options_list=['--admin-user', '-u'],
+                   help='Required. Administrator login name.')
 
         c.argument('administrator_login_password',
-                   options_list=['--admin-password', '-p'])
+                   options_list=['--admin-password', '-p'],
+                   help='Required. Administrator login password.')
 
         c.argument('authentication_type',
                    options_list=['--auth-type', '-a'],
-                   arg_type=get_enum_type(AuthenticationType))
+                   arg_type=get_enum_type(AuthenticationType),
+                   help='Authentication type.')
+
+        c.argument('storage_key',
+                   help='Required. Storage key.')
 
         c.argument('storage_key_type',
-                   arg_type=get_enum_type(StorageKeyType))
+                   arg_type=get_enum_type(StorageKeyType),
+                   help='Required. Storage key type.')
+
+        c.argument('storage_uri',
+                   help='Required. Storage Uri.')
 
         # The parameter name '--name' is used for 'database_name', so we need to give a different name
         # for the import extension 'name' parameter to avoid conflicts. This parameter is actually not
@@ -1174,7 +1202,8 @@ def _configure_security_policy_storage_params(arg_ctx):
                    options_list=['--max-size', '--storage'])
 
         c.argument('license_type',
-                   arg_type=get_enum_type(ElasticPoolLicenseType))
+                   arg_type=get_enum_type(ElasticPoolLicenseType),
+                   help='The license type to apply for this elastic pool.')
 
         c.argument('zone_redundant',
                    arg_type=zone_redundant_param_type)
@@ -1196,6 +1225,9 @@ def _configure_security_policy_storage_params(arg_ctx):
         c.argument('maintenance_configuration_id',
                    arg_type=maintenance_configuration_id_param_type)
 
+        c.argument('high_availability_replica_count',
+                   arg_type=read_replicas_param_type)
+
     with self.argument_context('sql elastic-pool create') as c:
         # Create args that will be used to build up the ElasticPool object
         create_args_for_complex_type(
@@ -1207,6 +1239,7 @@ def _configure_security_policy_storage_params(arg_ctx):
                 'tags',
                 'zone_redundant',
                 'maintenance_configuration_id',
+                'high_availability_replica_count',
             ])
 
         # Create args that will be used to build up the ElasticPoolPerDatabaseSettings object
@@ -1371,10 +1404,14 @@ def _configure_security_policy_storage_params(arg_ctx):
                    options_list=['--name', '-n'])
 
         c.argument('administrator_login',
-                   options_list=['--admin-user', '-u'])
+                   options_list=['--admin-user', '-u'],
+                   help='Administrator username for the server. Once'
+                   'created it cannot be changed.')
 
         c.argument('administrator_login_password',
-                   options_list=['--admin-password', '-p'])
+                   options_list=['--admin-password', '-p'],
+                   help='The administrator login password (required for'
+                   'server creation).')
 
         c.argument('assign_identity',
                    options_list=['--assign_identity', '-i'],
@@ -1899,11 +1936,16 @@ def _configure_security_policy_storage_params(arg_ctx):
 
         c.argument('administrator_login',
                    options_list=['--admin-user', '-u'],
-                   required=False)
+                   required=False,
+                   help='Administrator username for the managed instance. Can'
+                   'only be specified when the managed instance is being'
+                   'created (and is required for creation).')
 
         c.argument('administrator_login_password',
                    options_list=['--admin-password', '-p'],
-                   required=False)
+                   required=False,
+                   help='The administrator login password (required for'
+                   'managed instance creation).')
 
         c.extra('vnet_name',
                 options_list=['--vnet-name'],
@@ -1964,7 +2006,9 @@ def _configure_security_policy_storage_params(arg_ctx):
             ])
 
         c.argument('administrator_login_password',
-                   options_list=['--admin-password', '-p'])
+                   options_list=['--admin-password', '-p'],
+                   help='The administrator login password (required for'
+                   'managed instance creation).')
 
         c.argument('assign_identity',
                    options_list=['--assign-identity', '-i'],

src/azure-cli/azure/cli/command_modules/sql/custom.py

@@ -3327,7 +3327,8 @@ def elastic_pool_update(
         tier=None,
         family=None,
         capacity=None,
-        maintenance_configuration_id=None):
+        maintenance_configuration_id=None,
+        high_availability_replica_count=None):
     '''
     Updates an elastic pool. Custom update function to apply parameters to instance.
     '''
@@ -3366,6 +3367,9 @@ def elastic_pool_update(
         cmd.cli_ctx,
         maintenance_configuration_id)
 
+    if high_availability_replica_count is not None:
+        instance.high_availability_replica_count = high_availability_replica_count
+
     return instance