[App Service] az appservice plan update/az webapp update : Add elastic scale support (#20748)

* WIP

* start elastic scale implementation

* add elastic scale params to 'az appservice plan update' and add tests; start webapp elastic scale impl

* Change allowed SKUs for elastic scale

* fix webapp minimum_elastic_instance_count bug

* add/record tests and fix ASP update setting worker count to 1 when not specified

* rerecord old tests

* fix style and linter issues

* rerecord test_webapp_e2e test

* make elastic scale parameters preview

* update recordings

* fix style

Author: StrawnSC

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

@@ -106,7 +106,6 @@ def load_arguments(self, _):
                    completer=get_resource_name_completion_list('Microsoft.Web/serverFarms'),
                    configured_default='appserviceplan', id_part='name',
                    local_context_attribute=LocalContextAttribute(name='plan_name', actions=[LocalContextAction.GET]))
-        c.argument('number_of_workers', help='Number of workers to be allocated.', type=int, default=1)
         c.argument('admin_site_name', help='The name of the admin web app.',
                    deprecate_info=c.deprecate(expiration='0.2.17'))
         c.ignore('max_burst')
@@ -116,6 +115,7 @@ def load_arguments(self, _):
                    validator=validate_asp_create,
                    local_context_attribute=LocalContextAttribute(name='plan_name', actions=[LocalContextAction.SET],
                                                                  scopes=['appservice', 'webapp', 'functionapp']))
+        c.argument('number_of_workers', help='Number of workers to be allocated.', type=int, default=1)
         c.argument('app_service_environment', options_list=['--app-service-environment', '-e'],
                    help="Name or ID of the app service environment",
                    local_context_attribute=LocalContextAttribute(name='ase_name', actions=[LocalContextAction.GET]))
@@ -131,6 +131,9 @@ def load_arguments(self, _):
 
     with self.argument_context('appservice plan update') as c:
         c.argument('sku', arg_type=sku_arg_type)
+        c.argument('elastic_scale', arg_type=get_three_state_flag(), is_preview=True, help='Enable or disable automatic scaling. Set to "true" to enable elastic scale for this plan, or "false" to disable elastic scale for this plan. The SKU must be a Premium V2 SKU (P1V2, P2V2, P3V2) or a Premium V3 SKU (P1V3, P2V3, P3V3)')
+        c.argument('max_elastic_worker_count', options_list=['--max-elastic-worker-count', '-m'], type=int, is_preview=True, help='Maximum number of instances that the plan can scale out to. The plan must be an elastic scale plan.')
+        c.argument('number_of_workers', type=int, help='Number of workers to be allocated.')
         c.ignore('allow_pending_state')
 
     with self.argument_context('appservice plan delete') as c:
@@ -198,6 +201,8 @@ def load_arguments(self, _):
                    arg_type=get_three_state_flag(return_label=True), deprecate_info=c.deprecate(expiration='3.0.0'))
         c.argument('skip_dns_registration', help="If true web app hostname is not registered with DNS on creation",
                    arg_type=get_three_state_flag(return_label=True), deprecate_info=c.deprecate(expiration='3.0.0'))
+        c.argument('minimum_elastic_instance_count', options_list=["--minimum-elastic-instance-count", "-i"], type=int, is_preview=True, help="Minimum number of instances. App must be in an elastic scale App Service Plan.")
+        c.argument('prewarmed_instance_count', options_list=["--prewarmed-instance-count", "-w"], type=int, is_preview=True, help="Number of preWarmed instances. App must be in an elastic scale App Service Plan.")
 
     with self.argument_context('webapp browse') as c:
         c.argument('logs', options_list=['--logs', '-l'], action='store_true',

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

@@ -5,19 +5,19 @@
 
 import ipaddress
 
-from azure.cli.core.azclierror import (InvalidArgumentValueError, ArgumentUsageError, ValidationError,
-                                       MutuallyExclusiveArgumentError)
+
+from azure.cli.core.azclierror import (InvalidArgumentValueError, ArgumentUsageError, RequiredArgumentMissingError,
+                                       ResourceNotFoundError, ValidationError, MutuallyExclusiveArgumentError)
 from azure.cli.core.commands.client_factory import get_mgmt_service_client, get_subscription_id
 from azure.cli.core.profiles import ResourceType
 from azure.cli.core.commands.validators import validate_tags
 
 from knack.log import get_logger
-from knack.util import CLIError
 from msrestazure.tools import is_valid_resource_id, parse_resource_id
 
 from ._appservice_utils import _generic_site_operation
 from ._client_factory import web_client_factory
-from .utils import _normalize_sku, get_sku_name, _normalize_location
+from .utils import _normalize_sku, get_sku_tier, _normalize_location
 
 logger = get_logger(__name__)
 
@@ -59,7 +59,8 @@ def validate_site_create(cmd, namespace):
         else:
             plan_info = client.app_service_plans.get(resource_group_name, plan)
         if not plan_info:
-            raise CLIError("The plan '{}' doesn't exist in the resource group '{}'".format(plan, resource_group_name))
+            raise ResourceNotFoundError("The plan '{}' doesn't exist in the resource group '{}'".format(
+                plan, resource_group_name))
         # verify that the name is available for create
         validation_payload = {
             "name": namespace.name,
@@ -71,7 +72,7 @@ def validate_site_create(cmd, namespace):
         }
         validation = client.validate(resource_group_name, validation_payload)
         if validation.status.lower() == "failure" and validation.error.code != 'SiteAlreadyExists':
-            raise CLIError(validation.error.message)
+            raise ValidationError(validation.error.message)
 
 
 def validate_ase_create(cmd, namespace):
@@ -81,11 +82,11 @@ def validate_ase_create(cmd, namespace):
     if isinstance(namespace.name, str):
         name_validation = client.check_name_availability(namespace.name, resource_type)
         if not name_validation.name_available:
-            raise CLIError(name_validation.message)
+            raise ValidationError(name_validation.message)
 
 
 def _validate_asp_sku(sku, app_service_environment, zone_redundant):
-    if zone_redundant and get_sku_name(sku.upper()) not in ['PREMIUMV2', 'PREMIUMV3']:
+    if zone_redundant and get_sku_tier(sku.upper()) not in ['PREMIUMV2', 'PREMIUMV3']:
         raise ValidationError("Zone redundancy cannot be enabled for sku {}".format(sku))
     # Isolated SKU is supported only for ASE
     if sku.upper() in ['I1', 'I2', 'I3', 'I1V2', 'I2V2', 'I3V2']:
@@ -110,7 +111,7 @@ def validate_asp_create(namespace):
 def validate_functionapp_asp_create(namespace):
     validate_tags(namespace)
     sku = _normalize_sku(namespace.sku)
-    tier = get_sku_name(sku)
+    tier = get_sku_tier(sku)
     _validate_asp_sku(sku=sku, app_service_environment=None, zone_redundant=namespace.zone_redundant)
     if namespace.max_burst is not None:
         if tier.lower() != "elasticpremium":
@@ -131,7 +132,7 @@ def validate_app_or_slot_exists_in_rg(cmd, namespace):
     else:
         app = client.web_apps.get(resource_group_name, webapp, None, raw=True)
     if app.response.status_code != 200:
-        raise CLIError(app.response.text)
+        raise ResourceNotFoundError(app.response.text)
 
 
 def validate_app_exists_in_rg(cmd, namespace):
@@ -140,11 +141,11 @@ def validate_app_exists_in_rg(cmd, namespace):
     resource_group_name = namespace.resource_group_name
     app = client.web_apps.get(resource_group_name, webapp, None, raw=True)
     if app.response.status_code != 200:
-        raise CLIError(app.response.text)
+        raise ResourceNotFoundError(app.response.text)
 
 
 def validate_add_vnet(cmd, namespace):
-    from azure.core.exceptions import ResourceNotFoundError
+    from azure.core.exceptions import ResourceNotFoundError as ResNotFoundError
 
     resource_group_name = namespace.resource_group_name
     from azure.cli.command_modules.network._client_factory import network_client_factory
@@ -172,7 +173,7 @@ def validate_add_vnet(cmd, namespace):
         try:
             vnet_loc = vnet_client.virtual_networks.get(resource_group_name=namespace.resource_group_name,
                                                         virtual_network_name=vnet_identifier).location
-        except ResourceNotFoundError:
+        except ResNotFoundError:
             vnets = vnet_client.virtual_networks.list_all()
             vnet_loc = ''
             for v in vnets:
@@ -202,7 +203,7 @@ def validate_front_end_scale_factor(namespace):
         scale_error_text = "Frontend Scale Factor '{}' is invalid. Must be between {} and {}"
         scale_factor = namespace.front_end_scale_factor
         if scale_factor < min_scale_factor or scale_factor > max_scale_factor:
-            raise CLIError(scale_error_text.format(scale_factor, min_scale_factor, max_scale_factor))
+            raise ValidationError(scale_error_text.format(scale_factor, min_scale_factor, max_scale_factor))
 
 
 def validate_ip_address(cmd, namespace):
@@ -215,13 +216,13 @@ def validate_ip_address(cmd, namespace):
 
 def validate_onedeploy_params(namespace):
     if namespace.src_path and namespace.src_url:
-        raise CLIError('Only one of --src-path and --src-url can be specified')
+        raise MutuallyExclusiveArgumentError('Only one of --src-path and --src-url can be specified')
 
     if not namespace.src_path and not namespace.src_url:
-        raise CLIError('Either of --src-path or --src-url must be specified')
+        raise RequiredArgumentMissingError('Either of --src-path or --src-url must be specified')
 
     if namespace.src_url and not namespace.artifact_type:
-        raise CLIError('Deployment type is mandatory when deploying from URLs. Use --type')
+        raise RequiredArgumentMissingError('Deployment type is mandatory when deploying from URLs. Use --type')
 
 
 def _validate_ip_address_format(namespace):
@@ -304,7 +305,7 @@ def _validate_service_tag_existence(cmd, namespace):
 def validate_public_cloud(cmd):
     from azure.cli.core.cloud import AZURE_PUBLIC_CLOUD
     if cmd.cli_ctx.cloud.name != AZURE_PUBLIC_CLOUD.name:
-        raise CLIError('This command is not yet supported on soveriegn clouds.')
+        raise ValidationError('This command is not yet supported on soveriegn clouds.')
 
 
 def validate_staticsite_sku(cmd, namespace):
@@ -352,7 +353,7 @@ def validate_vnet_integration(cmd, namespace):
 
         sku_name = plan_info.sku.name
         disallowed_skus = {'FREE', 'SHARED', 'BASIC', 'ElasticPremium', 'PremiumContainer', 'Isolated', 'IsolatedV2'}
-        if get_sku_name(sku_name) in disallowed_skus:
+        if get_sku_tier(sku_name) in disallowed_skus:
             raise ArgumentUsageError("App Service Plan has invalid sku for vnet integration: {}."
                                      "Plan sku cannot be one of: {}. "
                                      "Please run 'az appservice plan create -h' "

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

@@ -133,7 +133,8 @@ def load_command_table(self, _):
         g.custom_command('identity remove', 'remove_identity')
         g.custom_command('create-remote-connection', 'create_tunnel', exception_handler=ex_handler_factory())
         g.custom_command('deploy', 'perform_onedeploy', validator=validate_onedeploy_params, is_preview=True)
-        g.generic_update_command('update', getter_name='get_webapp', setter_name='set_webapp', custom_func_name='update_webapp', command_type=appservice_custom)
+        g.generic_update_command('update', getter_name='get_webapp', setter_name='set_webapp',
+                                 custom_func_name='update_webapp', command_type=appservice_custom)
 
     with self.command_group('webapp traffic-routing') as g:
         g.custom_command('set', 'set_traffic_routing')