Rename commands

Author: Tratcher

src/containerapp/HISTORY.rst

@@ -4,7 +4,7 @@ Release History
 ===============
 upcoming
 ++++++
-* 'az containerapp env ingress': New environment level ingress configuration.
+* 'az containerapp env premium-ingress': New environment level ingress configuration.
 * 'az containerapp auth update': Support authenticating blob storage token store using managed identity with `--blob-container-uri` and `--blob-container-identity`.
 
 1.1.0b4

src/containerapp/azext_containerapp/_help.py

@@ -2364,51 +2364,51 @@
           az containerapp env http-route-config delete -g MyResourceGroup -n MyEnvironment -r configname
 """
 
-helps['containerapp env ingress show'] = """
+helps['containerapp env premium-ingress show'] = """
     type: command
-    short-summary: Show the ingress settings for the environment.
+    short-summary: Show the premium ingress settings for the environment.
     examples:
-    - name: Show the ingress settings for the environment.
+    - name: Show the premium ingress settings for the environment.
       text: |
-          az containerapp env ingress show -g MyResourceGroup -n MyEnvironment
+          az containerapp env premium-ingress show -g MyResourceGroup -n MyEnvironment
 """
 
-helps['containerapp env ingress'] = """
+helps['containerapp env premium-ingress'] = """
     type: group
     short-summary: Configures premium ingress settings for the environment.
     long-summary: |
         Premium ingress settings apply to all applications in the environment. They allow moving the ingress instances to a workload profile and scaling them beyond the system defaults to enable high traffic workloads. Other settings include request idle timeouts, header count limits, and the termination grace period.
     examples:
-    - name: Set the ingress settings for the environment.
+    - name: Enable premium ingress for the environment.
       text: |
-          az containerapp env ingress set -g MyResourceGroup -n MyEnvironment -w WorkloadProfileName --min-replicas 2 --max-replicas 10
+          az containerapp env premium-ingress add -g MyResourceGroup -n MyEnvironment -w WorkloadProfileName --min-replicas 2 --max-replicas 10
 """
 
-helps['containerapp env ingress set'] = """
+helps['containerapp env premium-ingress add'] = """
     type: command
-    short-summary: Set the ingress settings for the environment.
+    short-summary: Enable the premium ingress settings for the environment.
     long-summary: |
         Unspecified optional parameters will be cleared from any existing configuration.
     examples:
-    - name: Set the ingress settings for the environment.
+    - name: Add the premium ingress settings for the environment.
       text: |
-          az containerapp env ingress set -g MyResourceGroup -n MyEnvironment -w WorkloadProfileName --min-replicas 2 --max-replicas 10
+          az containerapp env premium-ingress add -g MyResourceGroup -n MyEnvironment -w WorkloadProfileName --min-replicas 2 --max-replicas 10
 """
 
-helps['containerapp env ingress update'] = """
+helps['containerapp env premium-ingress update'] = """
     type: command
-    short-summary: Update the ingress settings for the environment.
+    short-summary: Update the premium ingress settings for the environment.
     examples:
-    - name: Update the workload profile used for ingress.
+    - name: Update the workload profile used for premium ingress.
       text: |
-          az containerapp env ingress update -g MyResourceGroup -n MyEnvironment -w WorkloadProfileName
+          az containerapp env premium-ingress update -g MyResourceGroup -n MyEnvironment -w WorkloadProfileName
 """
 
-helps['containerapp env ingress reset'] = """
+helps['containerapp env premium-ingress remove'] = """
     type: command
-    short-summary: Removes the ingress settings and resets the system to default values.
+    short-summary: Removes the ingress settings and restores the system to default values.
     examples:
     - name: Reset the ingress settings for the environment to its default values
       text: |
-          az containerapp env ingress reset -g MyResourceGroup -n MyEnvironment
+          az containerapp env premium-ingress remove -g MyResourceGroup -n MyEnvironment
 """

src/containerapp/azext_containerapp/_params.py

@@ -506,12 +506,12 @@ def load_arguments(self, _):
         c.argument('mode', arg_type=get_enum_type(['single', 'multiple', 'labels']), help="The active revisions mode for the container app.")
         c.argument('target_label', help="The label to apply to new revisions. Required for revision mode 'labels'.", is_preview=True)
 
-    with self.argument_context('containerapp env ingress') as c:
+    with self.argument_context('containerapp env premium-ingress') as c:
         c.argument('resource_group_name', arg_type=resource_group_name_type, id_part=None)
         c.argument('name', options_list=['--name', '-n'], help="The name of the managed environment.")
         c.argument('workload_profile_name', options_list=['--workload-profile-name', '-w'], help="The workload profile to run ingress replicas on. This profile must not be shared with any container app or job.")
         c.argument('min_replicas', options_list=['--min-replicas'], type=int, help="Minimum number of replicas to run. Default 2, minimum 2.")
         c.argument('max_replicas', options_list=['--max-replicas'], type=int, help="Maximum number of replicas to run. Default 10. The upper limit is the maximum cores avalable in the workload profile.")
-        c.argument('termination_grace_period', options_list=['--termination-grace-period', '-t'], type=int, help="Time in seconds to drain requests durring ingress shutdown. Default 500, minimum 0, maximum 3600.")
+        c.argument('termination_grace_period', options_list=['--termination-grace-period', '-t'], type=int, help="Time in seconds to drain requests during ingress shutdown. Default 500, minimum 0, maximum 3600.")
         c.argument('request_idle_timeout', options_list=['--request-idle-timeout'], type=int, help="Timeout in minutes for idle requests. Default 4, minimum 1.")
         c.argument('header_count_limit', options_list=['--header-count-limit'], type=int, help="Limit of http headers per request. Default 100, minimum 1.")

src/containerapp/azext_containerapp/commands.py

@@ -292,8 +292,8 @@ def load_command_table(self, args):
         g.custom_command('add', 'add_revision_label')
         g.custom_command('remove', 'remove_revision_label')
 
-    with self.command_group('containerapp env ingress', is_preview=True) as g:
-        g.custom_show_command('show', 'show_environment_ingress')
-        g.custom_command('set', 'set_environment_ingress')
-        g.custom_command('update', 'update_environment_ingress')
-        g.custom_command('reset', 'reset_environment_ingress_to_defaults')
+    with self.command_group('containerapp env premium-ingress', is_preview=True) as g:
+        g.custom_show_command('show', 'show_environment_premium_ingress')
+        g.custom_command('add', 'add_environment_premium_ingress')
+        g.custom_command('update', 'update_environment_premium_ingress')
+        g.custom_command('remove', 'remove_environment_premium_ingress')

src/containerapp/azext_containerapp/custom.py

@@ -3712,7 +3712,7 @@ def remove_revision_label(cmd, resource_group_name, name, label, no_wait=False):
         handle_raw_exception(e)
 
 
-def show_environment_ingress(cmd, name, resource_group_name):
+def show_environment_premium_ingress(cmd, name, resource_group_name):
     _validate_subscription_registered(cmd, CONTAINER_APPS_RP)
 
     try:
@@ -3722,14 +3722,14 @@ def show_environment_ingress(cmd, name, resource_group_name):
 
         ingress_config = safe_get(env, "properties", "ingressConfiguration")
         if not ingress_config:
-            return {"message": "No ingress configuration found for this environment, using default values."}
+            return {"message": "No premium ingress configuration found for this environment, using default values."}
 
         return ingress_config
     except Exception as e:
         handle_raw_exception(e)
 
 
-def set_environment_ingress(cmd, name, resource_group_name, workload_profile_name, min_replicas, max_replicas, termination_grace_period=None, request_idle_timeout=None, header_count_limit=None, no_wait=False):
+def add_environment_premium_ingress(cmd, name, resource_group_name, workload_profile_name, min_replicas, max_replicas, termination_grace_period=None, request_idle_timeout=None, header_count_limit=None, no_wait=False):
     _validate_subscription_registered(cmd, CONTAINER_APPS_RP)
 
     try:
@@ -3766,7 +3766,7 @@ def set_environment_ingress(cmd, name, resource_group_name, workload_profile_nam
         handle_raw_exception(e)
 
 
-def update_environment_ingress(cmd, name, resource_group_name, workload_profile_name=None, min_replicas=None, max_replicas=None, termination_grace_period=None, request_idle_timeout=None, header_count_limit=None, no_wait=False):
+def update_environment_premium_ingress(cmd, name, resource_group_name, workload_profile_name=None, min_replicas=None, max_replicas=None, termination_grace_period=None, request_idle_timeout=None, header_count_limit=None, no_wait=False):
     _validate_subscription_registered(cmd, CONTAINER_APPS_RP)
 
     try:
@@ -3797,7 +3797,7 @@ def update_environment_ingress(cmd, name, resource_group_name, workload_profile_
         if ingress_config:
             safe_set(env_patch, "properties", "ingressConfiguration", value=ingress_config)
         else:
-            return {"message": "No changes specified for ingress configuration"}
+            return {"message": "No changes specified for premium ingress configuration"}
 
         # Update the environment with the patched ingress configuration
         result = ManagedEnvironmentPreviewClient.update(
@@ -3814,7 +3814,7 @@ def update_environment_ingress(cmd, name, resource_group_name, workload_profile_
         handle_raw_exception(e)
 
 
-def reset_environment_ingress_to_defaults(cmd, name, resource_group_name, no_wait=False):
+def remove_environment_premium_ingress(cmd, name, resource_group_name, no_wait=False):
     _validate_subscription_registered(cmd, CONTAINER_APPS_RP)
 
     try: