[SQL] az sql instance-pool: Add instance pools command group

src/azure-cli/HISTORY.rst

@@ -3,6 +3,11 @@
 Release History
 ===============
 
+**SQL**
+
+* Add new cmdlets for Instance Pools 'sql instance-pool'
+* Support create, delete, show, list and update for Instance Pools.
+
 **AMS**
 
 * az ams is now GA.

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

@@ -71,6 +71,32 @@ def _apply_format(result, format_group):
     # Apply format function to list
     return [format_group(item) for item in obj_list]
 
+###############################################
+#                sql instance-pool            #
+###############################################
+
+
+def instance_pool_table_format(result):
+    '''
+    Formats an instance pool or list of instance pools as summary results for display with "-o table".
+    '''
+    def _instance_pool_table_format(result):
+        '''
+        Formats an instance pool or list of instance pools as summary results for display with "-o table".
+        '''
+        from collections import OrderedDict
+        sku = result['sku']
+        return OrderedDict([
+            ('name', result['name']),
+            ('resourceGroup', result['resourceGroup']),
+            ('location', result['location']),
+            ('Capacity', result['vCores']),
+            ('SKU Family', sku['family']),
+            ('SKU Tier', sku['tier']),
+            ('Tags', str(result['tags']) if result['tags'] else '')
+        ])
+
+    return _apply_format(result, _instance_pool_table_format)
 
 ###############################################
 #                sql server                   #

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

@@ -457,6 +457,65 @@
 short-summary: Updates the instance failover group.
 """
 
+helps['sql instance-pool'] = """
+type: group
+short-summary: Manage instance pools.
+"""
+
+helps['sql instance-pool create'] = """
+type: command
+short-summary: Create an instance pool.
+examples:
+  - name: Example to create an instance pool (include --no-wait in the end to get an asynchronous experience)
+    text: az sql instance-pool create -g resource_group_name -n instance_pool_name -l location --subnet /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Network/virtualNetworks/{VNETName}/subnets/{SubnetName} --license-type LicenseIncluded --capacity 8 -e GeneralPurpose -f Gen5 --no-wait
+  - name: Example to create an instance pool with subnet name and vnet-name
+    text: az sql instance-pool create --license-type LicenseIncluded -l northcentralus -n myinstancepool -c 8 -e GeneralPurpose -f Gen5 -g billingPools --subnet mysubnetname --vnet-name myvnetname
+"""
+
+helps['sql instance-pool delete'] = """
+type: command
+short-summary: Delete an instance pool.
+examples:
+  - name: Delete an instance pool
+    text: az sql instance-pool delete -g mygroup -n myinstancepool --yes
+"""
+
+helps['sql instance-pool list'] = """
+type: command
+short-summary: List available instance pools.
+examples:
+  - name: List all instance pools in the current subscription.
+    text: az sql instance-pool list
+  - name: List all instance pools in a resource group.
+    text: az sql instance-pool list -g mygroup
+"""
+
+helps['sql instance-pool show'] = """
+type: command
+short-summary: Get the details for an instance pool.
+examples:
+  - name: Get the details for an instance pool
+    text: az sql instance-pool show -g mygroup -n myinstancepool
+"""
+
+helps['sql instance-pool update'] = """
+type: command
+short-summary: Update an instance pool.
+examples:
+  - name: Update an instance pool with new tags (make sure they are space separated if there are multiple tags)
+    text: az sql instance-pool update -n myinstancepool -g mygroup --tags mykey1=myvalue1 mykey2=myvalue2
+  - name: Clear the tags assigned to an instance pool
+    text: az sql instance-pool update -n myinstancepool -g mygroup --tags ""
+"""
+
+helps['sql instance-pool wait'] = """
+type: command
+short-summary: Wait for an instance pool to reach a desired state.
+examples:
+  - name: Wait until an instance pool gets created.
+    text: az sql instance-pool wait -n myinstancepool -g mygroup --created
+"""
+
 helps['sql mi'] = """
 type: group
 short-summary: Manage SQL managed instances.

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

@@ -14,6 +14,7 @@
     ElasticPoolPerDatabaseSettings,
     ImportExtensionRequest,
     ExportRequest,
+    InstancePool,
     ManagedDatabase,
     ManagedInstance,
     ManagedInstanceAdministrator,
@@ -1020,6 +1021,69 @@ def _configure_security_policy_storage_params(arg_ctx):
         c.argument('allow_data_loss',
                    arg_type=allow_data_loss_param_type)
 
+    ###############################################
+    #             sql instance pool               #
+    ###############################################
+
+    with self.argument_context('sql instance-pool') as c:
+        c.argument('instance_pool_name',
+                   options_list=['--name', '-n'],
+                   help="Instance Pool Name")
+
+        c.argument(
+            'tier',
+            arg_type=tier_param_type,
+            required=True,
+            help='The edition component of the sku. Allowed value: GeneralPurpose.')
+
+        c.argument('family',
+                   arg_type=family_param_type,
+                   required=True,
+                   help='The compute generation component of the sku. '
+                   'Allowed value: Gen5')
+
+        c.argument('license_type',
+                   arg_type=get_enum_type(DatabaseLicenseType),
+                   help='The license type to apply for this instance pool.')
+
+    with self.argument_context('sql instance-pool create') as c:
+        # Create args that will be used to build up the InstancePool object
+        create_args_for_complex_type(
+            c, 'parameters', InstancePool, [
+                'location',
+                'license_type',
+                'subnet_id',
+                'vcores',
+                'tags'
+            ])
+
+        c.argument('vcores',
+                   required=True,
+                   arg_type=capacity_param_type,
+                   help='Capacity of the instance pool in vcores.')
+
+        c.argument(
+            'subnet_id',
+            options_list=['--subnet'],
+            required=True,
+            help='Name or ID of the subnet that allows access to an Instance Pool. '
+                 'If subnet name is provided, --vnet-name must be provided.')
+
+        # Create args that will be used to build up the Instance Pool's Sku object
+        create_args_for_complex_type(
+            c, 'sku', Sku, [
+                'family',
+                'name',
+                'tier',
+            ])
+
+        c.ignore('name')  # Hide sku name
+
+        c.extra('vnet_name',
+                options_list=['--vnet-name'],
+                help='The virtual network name',
+                validator=validate_subnet)
+
     ###############################################
     #                sql server                   #
     ###############################################

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

@@ -84,6 +84,10 @@ def get_sql_firewall_rules_operations(cli_ctx, _):
     return get_sql_management_client(cli_ctx).firewall_rules
 
 
+def get_sql_instance_pools_operations(cli_ctx, _):
+    return get_sql_management_client(cli_ctx).instance_pools
+
+
 def get_sql_recommended_elastic_pools_operations(cli_ctx, _):
     return get_sql_management_client(cli_ctx).recommended_elastic_pools
 

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

@@ -82,21 +82,31 @@ def validate_subnet(cmd, namespace):
     from msrestazure.tools import resource_id, is_valid_resource_id
     from azure.cli.core.commands.client_factory import get_subscription_id
 
-    subnet = namespace.virtual_network_subnet_id
+    is_instance_pool = False
+    if hasattr(namespace, "subnet_id"):
+        is_instance_pool = True
+        subnet = namespace.subnet_id
+    else:
+        subnet = namespace.virtual_network_subnet_id
+
     subnet_is_id = is_valid_resource_id(subnet)
     vnet = namespace.vnet_name
 
     if (subnet_is_id and not vnet) or (not subnet and not vnet):
         pass
     elif subnet and not subnet_is_id and vnet:
-        namespace.virtual_network_subnet_id = resource_id(
+        virtual_network_subnet_id = resource_id(
             subscription=get_subscription_id(cmd.cli_ctx),
             resource_group=namespace.resource_group_name,
             namespace='Microsoft.Network',
             type='virtualNetworks',
             name=vnet,
             child_type_1='subnets',
             child_name_1=subnet)
+        if is_instance_pool:
+            namespace.subnet_id = virtual_network_subnet_id
+        else:
+            namespace.virtual_network_subnet_id = virtual_network_subnet_id
     else:
         raise CLIError('incorrect usage: [--subnet ID | --subnet NAME --vnet-name NAME]')
     delattr(namespace, 'vnet_name')

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

@@ -15,6 +15,7 @@
     elastic_pool_table_format,
     elastic_pool_edition_table_format,
     firewall_rule_table_format,
+    instance_pool_table_format,
     server_table_format,
     usage_table_format,
     LongRunningOperationResultTransform,
@@ -36,6 +37,7 @@
     get_sql_encryption_protectors_operations,
     get_sql_failover_groups_operations,
     get_sql_firewall_rules_operations,
+    get_sql_instance_pools_operations,
     get_sql_managed_databases_operations,
     get_sql_managed_instance_azure_ad_administrators_operations,
     get_sql_managed_instance_encryption_protectors_operations,
@@ -345,6 +347,26 @@ def load_command_table(self, _):
         g.command('delete', 'delete')
         g.custom_command('set-primary', 'failover_group_failover')
 
+    ###############################################
+    #             sql instance-pool               #
+    ###############################################
+
+    instance_pools_operations = CliCommandType(
+        operations_tmpl='azure.mgmt.sql.operations#InstancePoolsOperations.{}',
+        client_factory=get_sql_instance_pools_operations)
+    with self.command_group('sql instance-pool', instance_pools_operations, client_factory=get_sql_instance_pools_operations, is_preview=True) as g:
+        g.command('show', 'get',
+                  table_transformer=instance_pool_table_format)
+        g.custom_command('list', 'instance_pool_list',
+                         table_transformer=instance_pool_table_format)
+        g.command('update', 'update')
+        g.command('delete', 'delete', supports_no_wait=True, confirmation=True)
+        g.custom_command(
+            'create',
+            'instance_pool_create',
+            supports_no_wait=True)
+        g.wait_command('wait')
+
     ###############################################
     #                sql server                   #
     ###############################################

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

@@ -1898,6 +1898,82 @@ def elastic_pool_list_capabilities(
 
     return editions
 
+###############################################
+#                sql instance-pool            #
+###############################################
+
+
+def instance_pool_list(
+        client,
+        resource_group_name=None):
+    '''
+    Lists servers in a resource group or subscription
+    '''
+
+    if resource_group_name:
+        # List all instance pools in the resource group
+        return client.list_by_resource_group(
+            resource_group_name=resource_group_name)
+
+    # List all instance pools in the subscription
+    return client.list()
+
+
+def instance_pool_create(
+        cmd,
+        client,
+        instance_pool_name,
+        resource_group_name,
+        no_wait=False,
+        sku=None,
+        **kwargs):
+    '''
+    Creates a new instance pool
+    '''
+
+    kwargs['sku'] = _find_instance_pool_sku_from_capabilities(
+        cmd.cli_ctx, kwargs['location'], sku)
+
+    return sdk_no_wait(no_wait, client.create_or_update,
+                       instance_pool_name=instance_pool_name,
+                       resource_group_name=resource_group_name,
+                       parameters=kwargs)
+
+
+def _find_instance_pool_sku_from_capabilities(cli_ctx, location, sku):
+    '''
+    Validate if the sku family and edition input by user are permissible in the region using
+    capabilities API and get the SKU name
+    '''
+
+    logger.debug('_find_instance_pool_sku_from_capabilities input: %s', sku)
+
+    # Get location capability
+    loc_capability = _get_location_capability(
+        cli_ctx, location, CapabilityGroup.supported_managed_instance_versions)
+
+    # Get default server version capability
+    managed_instance_version_capability = _get_default_capability(
+        loc_capability.supported_managed_instance_versions)
+
+    # Find edition capability, based on requested sku properties
+    edition_capability = _find_edition_capability(
+        sku, managed_instance_version_capability.supported_instance_pool_editions)
+
+    # Find family level capability, based on requested sku properties
+    _find_family_capability(
+        sku, edition_capability.supported_families)
+
+    result = Sku(
+        name="instance-pool",
+        tier=sku.tier,
+        family=sku.family)
+
+    logger.debug(
+        '_find_instance_pool_sku_from_capabilities return: %s',
+        result)
+    return result
+
 
 ###############################################
 #                sql server                   #