add help docs

Author: OGFTestPipeline

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

@@ -2210,10 +2210,112 @@
 helps['webapp sitecontainers create'] = """
 type: command
 short-summary: Create sitecontainers for a linux webapp
+long-summary: |
+    Multiple sitecontainers can be added at once by passing arg --sitecontainer-spec-file, which is the path to a json file containing an array of sitecontainer specs.
+    Example json file:
+    [{
+        "name" : "firstcontainer",
+        "image": "myregistry.io/firstimage:latest",
+        "target_port": "80",
+        "is_main": true,
+        "environment_variables" : [
+            {
+                "name" : "hello",
+                "value": "world"
+            }
+        ],
+        "volume_mounts": [
+            {
+                "container_mount_path" : "mountPath",
+                "data": "configData",
+                "read_only": true,
+                "volume_sub_path": "subPath"
+            }
+        ]
+    },
+    {
+        "name" : "secondcontainer",
+        "image": "myregistry.io/secondimage:latest",
+        "target_port": "3000",
+        "is_main": false,
+        "auth_type": "SystemIdentity",
+        "start_up_command": "MyStartupCmd"
+    },
+    {
+        "name" : "thirdcontainer",
+        "image": "myregistry.io/thirdimage:latest",
+        "target_port": "3001",
+        "is_main": false,
+        "auth_type": "UserAssigned",
+        "user_managed_identity_client_id": "ClientID"
+    },
+    {
+        "name" : "thirdcontainer",
+        "image": "myregistry.io/thirdimage:latest",
+        "target_port": "3002",
+        "is_main": false,
+        "auth_type": "UserCredentials",
+        "user_name": "Username",
+        "password_secret": "Password"
+    }]
 examples:
-  - name: Create sitecontainers for a linux webapp (autogenerated)
-    text: az webapp sitecontaienrs create --name MyWebApp --resource-group MyResourceGroup
-    crafted: true
+  - name: Create a sitecontainer for a linux webapp
+    text: az webapp sitecontainers create --name MyWebApp --resource-group MyResourceGroup --container-name MyContainer --image MyImageRegistry.io/MyImage:latest --target-port 80 --is-main
+  - name : Create multiple sitecontainers for a linux webapp using a json sitecontainer-spec file
+    text: az webapp sitecontainers create --name MyWebApp --resource-group MyResourceGroup --sitecontainer-spec-file ./sitecontainersspec.json
+"""
+
+
+helps['webapp sitecontainers update'] = """
+type: command
+short-summary: Update a sitecontainer for a linux webapp
+examples:
+  - name: Update a sitecontainer for a linux webapp
+    text: az webapp sitecontainers update --name MyWebApp --resource-group MyResourceGroup --container-name MyContainer --image MyImageRegistry.io/MyImage:latest --target-port 3000 --is-main false
+"""
+
+
+helps['webapp sitecontainers delete'] = """
+type: command
+short-summary: Delete a sitecontainer for a linux webapp
+examples:
+  - name: Delete a sitecontainer for a linux webapp
+    text: az webapp sitecontainers delete --name MyWebApp --resource-group MyResourceGroup --container-name MyContainer
+"""
+
+
+helps['webapp sitecontainers show'] = """
+type: command
+short-summary: List the details of a sitecontainer for a linux webapp
+examples:
+  - name: List the details of a sitecontainer for a linux webapp
+    text: az webapp sitecontainers show --name MyWebApp --resource-group MyResourceGroup --container-name MyContainer
+"""
+
+
+helps['webapp sitecontainers list'] = """
+type: command
+short-summary: List all the sitecontainers for a linux webapp
+examples:
+  - name: List all the sitecontainers for a linux webapp
+    text: az webapp sitecontainers list --name MyWebApp --resource-group MyResourceGroup --container-name MyContainer
+"""
+
+
+helps['webapp sitecontainers status'] = """
+type: command
+short-summary: Get the status of a sitecontainer for a linux webapp
+examples:
+  - name: Get the status of a sitecontainer for a linux webapp
+    text: az webapp sitecontainers status --name MyWebApp --resource-group MyResourceGroup --container-name MyContainer
+"""
+
+helps['webapp sitecontainers log'] = """
+type: command
+short-summary: Get the logs of a sitecontainer for a linux webapp
+examples:
+  - name: Get the logs of a sitecontainer for a linux webapp
+    text: az webapp sitecontainers log --name MyWebApp --resource-group MyResourceGroup --container-name MyContainer
 """
 
 

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

@@ -173,9 +173,34 @@ def load_arguments(self, _):
         c.ignore('using_webapp_up')
 
     with self.argument_context("webapp sitecontainers") as c:
-        c.argument("create", help='Create sitecontainers for a linux webapp')
-        c.argument("is_main", help="If true, this sitecontainer becomes the primary sitecontainer receiving frontend traffic.",
+        c.argument('name', arg_type=webapp_name_arg_type, help='Name of the linux webapp')
+        c.argument("container_name", help='Name of the SiteContainer')
+        c.argument('slot', options_list=['--slot', '-s'], help='Name of the web app slot. Default to the productions slot if not specified.')
+
+    with self.argument_context("webapp sitecontainers create") as c:
+        c.argument("image", help='Image Name')
+        c.argument("target_port", help='Target port for SiteContainer')
+        c.argument("startup_cmd", help='Startup Command for the SiteContainer')
+        c.argument("is_main", help="true if the container is the main site container; false otherwise",
+                   arg_type=get_three_state_flag())
+        c.argument("system_assigned_identity", help="If true, the system-assigned identity will be used for auth while pulling image",
+                   arg_type=get_three_state_flag())
+        c.argument("user_assigned_identity", help='ClientID for the user-maganed identity which will be used for auth while pulling image')
+        c.argument("registry_username", help='username used for image registry auth')
+        c.argument("registry_password", help='password used for image registry auth')
+        c.argument("sitecontainers_spec_file", help="path to a json sitecontainer spec file containing a list of sitecontainers, other sitecontainer input args will be ignored if this arg is provided")
+
+    with self.argument_context("webapp sitecontainers update") as c:
+        c.argument("image", help='Image Name')
+        c.argument("target_port", help='Target port for SiteContainer')
+        c.argument("startup_cmd", help='Startup Command for the SiteContainer')
+        c.argument("is_main", help="true if the container is the main site container; false otherwise",
+                   arg_type=get_three_state_flag())
+        c.argument("system_assigned_identity", help="If true, the system-assigned identity will be used for auth while pulling image",
                    arg_type=get_three_state_flag())
+        c.argument("user_assigned_identity", help='ClientID for the user-maganed identity which will be used for auth while pulling image')
+        c.argument("registry_username", help='username used for image registry auth')
+        c.argument("registry_password", help='password used for image registry auth')
 
     with self.argument_context('webapp show') as c:
         c.argument('name', arg_type=webapp_name_arg_type)

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

@@ -149,7 +149,7 @@ def load_command_table(self, _):
         g.custom_command('show', 'get_webapp_sitecontainer')
         g.custom_command('list', 'list_webapp_sitecontainers')
         g.custom_command('status', 'get_webapp_sitecontainers_status')
-        g.custom_command('logs', 'get_webapp_sitecontainer_logs')
+        g.custom_command('log', 'get_webapp_sitecontainer_log')
 
     with self.command_group('webapp traffic-routing') as g:
         g.custom_command('set', 'set_traffic_routing')

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

@@ -1185,7 +1185,7 @@ def get_webapp_sitecontainers_status(cmd, name, resource_group, container_name=N
         raise AzureInternalError("Failed to fetch sitecontainer status. Error: {}".format(str(ex)))
 
 
-def get_webapp_sitecontainer_logs(cmd, name, resource_group, container_name, slot=None):
+def get_webapp_sitecontainer_log(cmd, name, resource_group, container_name, slot=None):
     scm_url = _get_scm_url(cmd, resource_group, name, slot)
     site_container_logs_url = scm_url + '/api/sitecontainers/' + container_name + '/logs'
     headers = get_scm_site_headers(cmd.cli_ctx, name, resource_group, slot)