containerapp add containerapp-preview extension

.github/CODEOWNERS

@@ -240,6 +240,8 @@
 
 /src/containerapp/ @ruslany @sanchitmehta @ebencarek @JennyLawrance @howang-ms @vinisoto @chinadragon0515 @vturecek @torosent @pagariyaalok @Juliehzl @jijohn14
 
+/src/containerapp-preview/ @ruslany @sanchitmehta @ebencarek @JennyLawrance @howang-ms @vinisoto @chinadragon0515 @vturecek @torosent @pagariyaalok @Juliehzl @jijohn14
+
 /src/scvmm/ @nascarsayan
 
 /src/spring/ @yuwzho

scripts/ci/verify_linter.py

@@ -70,9 +70,17 @@ def _cmd(cmd):
         check_call(cmd, shell=True)
 
     def add_from_code(self):
+        # The containerapp-preview extension is a special case,
+        # it must depend on the continerapp extension and cannot run independently.
+        if self.extension_name == 'containerapp-preview':
+            self._cmd('azdev extension add containerapp')
         self._cmd('azdev extension add {}'.format(self.extension_name))
 
     def remove(self):
+        # The containerapp-preview extension is a special case,
+        # it must depend on the continerapp extension and cannot run independently.
+        if self.extension_name == 'containerapp-preview':
+            self._cmd('azdev extension remove containerapp')
         self._cmd('azdev extension remove {}'.format(self.extension_name))
 
     def linter(self):

src/containerapp-preview/HISTORY.rst

@@ -0,0 +1,10 @@
+.. :changelog:
+
+Release History
+===============
+
+1.0.0b1
+++++++
+* Initial containerapp-preview extension.
+* `az containerapp list/show/delete/create`: support for preview extension
+* `az containerapp create`: support --environment-type parameter

src/containerapp-preview/README.rst

@@ -0,0 +1,9 @@
+Microsoft Azure CLI 'containerapp-preview' Extension
+==========================================
+
+This package is for the 'containerapp-preview' extension.
+i.e. 'az containerapp'
+
+We have two extensions: containerapp and containerapp-preview.
+The containerapp-preview extension does not run independently, it requires the containerapp extension.
+The commands in containerapp-preview can override the same commands in containerapp.

src/containerapp-preview/azext_containerapp_preview/__init__.py

@@ -0,0 +1,36 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+
+from azure.cli.core import AzCommandsLoader
+
+from azext_containerapp_preview._help import helps  # pylint: disable=unused-import
+from azext_containerapp_preview._utils import (_get_azext_module)
+
+
+class ContainerappPreviewCommandsLoader(AzCommandsLoader):
+
+    def __init__(self, cli_ctx=None):
+        from azure.cli.core.commands import CliCommandType
+        containerapp_preview_custom = CliCommandType(
+            operations_tmpl='azext_containerapp_preview.custom#{}',
+            client_factory=None)
+        super(ContainerappPreviewCommandsLoader, self).__init__(cli_ctx=cli_ctx,
+                                                                custom_command_type=containerapp_preview_custom)
+
+    def load_command_table(self, args):
+        from azext_containerapp_preview.commands import load_command_table
+
+        load_command_table(self, args)
+        return self.command_table
+
+    def load_arguments(self, command):
+        from azext_containerapp_preview._params import load_arguments
+
+        ga_params = _get_azext_module("azext_containerapp._params")
+        ga_params.load_arguments(self, command)
+        load_arguments(self, command)
+
+
+COMMAND_LOADER_CLS = ContainerappPreviewCommandsLoader

src/containerapp-preview/azext_containerapp_preview/_clients.py

@@ -0,0 +1,190 @@
+# coding=utf-8
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+import json
+
+from azure.cli.core.azclierror import ResourceNotFoundError
+from azure.cli.core.util import send_raw_request
+from azure.cli.core.commands.client_factory import get_subscription_id
+from knack.log import get_logger
+
+from ._utils import (_get_azext_module)
+
+logger = get_logger(__name__)
+
+PREVIEW_API_VERSION = "2023-04-01-preview"
+HEADER_AZURE_ASYNC_OPERATION = "azure-asyncoperation"
+HEADER_LOCATION = "location"
+
+
+def poll_status(cmd, request_url):
+    azext_client = _get_azext_module("azext_containerapp._clients")
+    return azext_client.poll_status(cmd, request_url)
+
+
+def poll_results(cmd, request_url):
+    azext_client = _get_azext_module("azext_containerapp._clients")
+    return azext_client.poll_results(cmd, request_url)
+
+
+class ContainerAppClient(_get_azext_module("azext_containerapp._clients").ContainerAppClient):
+    @classmethod
+    def get_api_version(cls):
+        return PREVIEW_API_VERSION
+
+
+class ManagedEnvironmentClient(_get_azext_module("azext_containerapp._clients").ManagedEnvironmentClient):
+    @classmethod
+    def get_api_version(cls):
+        return PREVIEW_API_VERSION
+
+
+class ConnectedEnvironmentClient():
+    @classmethod
+    def get_api_version(cls):
+        return PREVIEW_API_VERSION
+
+    @classmethod
+    def create(cls, cmd, resource_group_name, name, connected_environment_envelope, no_wait=False):
+        management_hostname = cmd.cli_ctx.cloud.endpoints.resource_manager
+        sub_id = get_subscription_id(cmd.cli_ctx)
+        url_fmt = "{}/subscriptions/{}/resourceGroups/{}/providers/Microsoft.App/connectedEnvironments/{}?api-version={}"
+        request_url = url_fmt.format(
+            management_hostname.strip('/'),
+            sub_id,
+            resource_group_name,
+            name,
+            cls.get_api_version())
+
+        r = send_raw_request(cmd.cli_ctx, "PUT", request_url, body=json.dumps(connected_environment_envelope))
+
+        if no_wait:
+            return r.json()
+        elif r.status_code == 201:
+            operation_url = r.headers.get(HEADER_AZURE_ASYNC_OPERATION)
+            poll_status(cmd, operation_url)
+            r = send_raw_request(cmd.cli_ctx, "GET", request_url)
+
+        return r.json()
+
+    @classmethod
+    def update(cls, cmd, resource_group_name, name, managed_environment_envelope, no_wait=False):
+        management_hostname = cmd.cli_ctx.cloud.endpoints.resource_manager
+        sub_id = get_subscription_id(cmd.cli_ctx)
+        url_fmt = "{}/subscriptions/{}/resourceGroups/{}/providers/Microsoft.App/connectedEnvironments/{}?api-version={}"
+        request_url = url_fmt.format(
+            management_hostname.strip('/'),
+            sub_id,
+            resource_group_name,
+            name,
+            cls.get_api_version())
+
+        r = send_raw_request(cmd.cli_ctx, "PATCH", request_url, body=json.dumps(managed_environment_envelope))
+
+        if no_wait:
+            return
+        elif r.status_code == 202:
+            operation_url = r.headers.get(HEADER_LOCATION)
+            response = poll_results(cmd, operation_url)
+            if response is None:
+                raise ResourceNotFoundError("Could not find a connected environment")
+            else:
+                return response
+
+        return r.json()
+
+    @classmethod
+    def delete(cls, cmd, resource_group_name, name, no_wait=False):
+        management_hostname = cmd.cli_ctx.cloud.endpoints.resource_manager
+        sub_id = get_subscription_id(cmd.cli_ctx)
+        url_fmt = "{}/subscriptions/{}/resourceGroups/{}/providers/Microsoft.App/connectedEnvironments/{}?api-version={}"
+        request_url = url_fmt.format(
+            management_hostname.strip('/'),
+            sub_id,
+            resource_group_name,
+            name,
+            cls.get_api_version())
+
+        r = send_raw_request(cmd.cli_ctx, "DELETE", request_url)
+
+        if no_wait:
+            return  # API doesn't return JSON (it returns no content)
+        elif r.status_code in [200, 201, 202, 204]:
+            if r.status_code == 202:
+                operation_url = r.headers.get(HEADER_LOCATION)
+                poll_results(cmd, operation_url)
+                logger.warning('Connected environment successfully deleted')
+        return
+
+    @classmethod
+    def show(cls, cmd, resource_group_name, name):
+        management_hostname = cmd.cli_ctx.cloud.endpoints.resource_manager
+        sub_id = get_subscription_id(cmd.cli_ctx)
+        url_fmt = "{}/subscriptions/{}/resourceGroups/{}/providers/Microsoft.App/connectedEnvironments/{}?api-version={}"
+        request_url = url_fmt.format(
+            management_hostname.strip('/'),
+            sub_id,
+            resource_group_name,
+            name,
+            cls.get_api_version())
+
+        r = send_raw_request(cmd.cli_ctx, "GET", request_url)
+        return r.json()
+
+    @classmethod
+    def list_by_subscription(cls, cmd, formatter=lambda x: x):
+        env_list = []
+
+        management_hostname = cmd.cli_ctx.cloud.endpoints.resource_manager
+        sub_id = get_subscription_id(cmd.cli_ctx)
+        request_url = "{}/subscriptions/{}/providers/Microsoft.App/connectedEnvironments?api-version={}".format(
+            management_hostname.strip('/'),
+            sub_id,
+            cls.get_api_version())
+
+        r = send_raw_request(cmd.cli_ctx, "GET", request_url)
+        j = r.json()
+        for env in j["value"]:
+            formatted = formatter(env)
+            env_list.append(formatted)
+
+        while j.get("nextLink") is not None:
+            request_url = j["nextLink"]
+            r = send_raw_request(cmd.cli_ctx, "GET", request_url)
+            j = r.json()
+            for env in j["value"]:
+                formatted = formatter(env)
+                env_list.append(formatted)
+
+        return env_list
+
+    @classmethod
+    def list_by_resource_group(cls, cmd, resource_group_name, formatter=lambda x: x):
+        env_list = []
+
+        management_hostname = cmd.cli_ctx.cloud.endpoints.resource_manager
+        sub_id = get_subscription_id(cmd.cli_ctx)
+        url_fmt = "{}/subscriptions/{}/resourceGroups/{}/providers/Microsoft.App/connectedEnvironments?api-version={}"
+        request_url = url_fmt.format(
+            management_hostname.strip('/'),
+            sub_id,
+            resource_group_name,
+            cls.get_api_version())
+
+        r = send_raw_request(cmd.cli_ctx, "GET", request_url)
+        j = r.json()
+        for env in j["value"]:
+            formatted = formatter(env)
+            env_list.append(formatted)
+
+        while j.get("nextLink") is not None:
+            request_url = j["nextLink"]
+            r = send_raw_request(cmd.cli_ctx, "GET", request_url)
+            j = r.json()
+            for env in j["value"]:
+                formatted = formatter(env)
+                env_list.append(formatted)
+
+        return env_list

src/containerapp-preview/azext_containerapp_preview/_constants.py

@@ -0,0 +1,12 @@
+# coding=utf-8
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+MANAGED_ENVIRONMENT_TYPE = "managed"
+CONNECTED_ENVIRONMENT_TYPE = "connected"
+MANAGED_ENVIRONMENT_RESOURCE_TYPE = "managedEnvironments"
+CONNECTED_ENVIRONMENT_RESOURCE_TYPE = "connectedEnvironments"
+GA_CONTAINERAPP_EXTENSION_NAME = 'containerapp'
+MIN_GA_VERSION = '0.3.35'
+CONTAINERAPP_NAMESPACE = 'Microsoft.App'

src/containerapp-preview/azext_containerapp_preview/_help.py

@@ -0,0 +1,64 @@
+# coding=utf-8
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+
+from knack.help_files import helps  # pylint: disable=unused-import
+
+helps['containerapp create'] = """
+    type: command
+    short-summary: Create a container app.
+    examples:
+    - name: Create a container app and retrieve its fully qualified domain name.
+      text: |
+          az containerapp create -n MyContainerapp -g MyResourceGroup \\
+              --image myregistry.azurecr.io/my-app:v1.0 --environment MyContainerappEnv \\
+              --ingress external --target-port 80 \\
+              --registry-server myregistry.azurecr.io --registry-username myregistry --registry-password $REGISTRY_PASSWORD \\
+              --query properties.configuration.ingress.fqdn
+    - name: Create a container app with resource requirements and replica count limits.
+      text: |
+          az containerapp create -n MyContainerapp -g MyResourceGroup \\
+              --image nginx --environment MyContainerappEnv \\
+              --cpu 0.5 --memory 1.0Gi \\
+              --min-replicas 4 --max-replicas 8
+    - name: Create a container app with secrets and environment variables.
+      text: |
+          az containerapp create -n MyContainerapp -g MyResourceGroup \\
+              --image my-app:v1.0 --environment MyContainerappEnv \\
+              --secrets mysecret=secretvalue1 anothersecret="secret value 2" \\
+              --env-vars GREETING="Hello, world" SECRETENV=secretref:anothersecret
+    - name: Create a container app using a YAML configuration. Example YAML configuration - https://aka.ms/azure-container-apps-yaml
+      text: |
+          az containerapp create -n MyContainerapp -g MyResourceGroup \\
+              --environment MyContainerappEnv \\
+              --yaml "path/to/yaml/file.yml"
+    - name: Create a container app with an http scale rule
+      text: |
+          az containerapp create -n myapp -g mygroup --environment myenv --image nginx \\
+              --scale-rule-name my-http-rule \\
+              --scale-rule-http-concurrency 50
+    - name: Create a container app with a custom scale rule
+      text: |
+          az containerapp create -n MyContainerapp -g MyResourceGroup \\
+              --image my-queue-processor --environment MyContainerappEnv \\
+              --min-replicas 4 --max-replicas 8 \\
+              --scale-rule-name queue-based-autoscaling \\
+              --scale-rule-type azure-queue \\
+              --scale-rule-metadata "accountName=mystorageaccountname" \\
+                                    "cloud=AzurePublicCloud" \\
+                                    "queueLength": "5" "queueName": "foo" \\
+              --scale-rule-auth "connection=my-connection-string-secret-name"
+    - name: Create a container app with secrets and mounts them in a volume.
+      text: |
+          az containerapp create -n MyContainerapp -g MyResourceGroup \\
+              --image my-app:v1.0 --environment MyContainerappEnv \\
+              --secrets mysecret=secretvalue1 anothersecret="secret value 2" \\
+              --secret-volume-mount "mnt/secrets"
+    - name: Create a container app hosted on a Connected Environment.
+      text: |
+          az containerapp create -n MyContainerapp -g MyResourceGroup \\
+              --image my-app:v1.0 --environment MyContainerappConnectedEnv \\
+              --environment-type connected
+"""

src/containerapp-preview/azext_containerapp_preview/_params.py

@@ -0,0 +1,18 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+# pylint: disable=line-too-long
+from azure.cli.core.commands.parameters import get_enum_type
+
+from ._validators import validate_env_name_or_id
+
+
+# This method cannot directly rely on GA resources.
+# When the switch core.use_command_index is turned off, possibly unrelated commands may also trigger unnecessary loads.
+# It will throw a warning if the GA resource does not exist.
+def load_arguments(self, _):
+
+    with self.argument_context('containerapp create') as c:
+        c.argument('managed_env', validator=validate_env_name_or_id, options_list=['--environment'], help="Name or resource ID of the container app's environment.")
+        c.argument('environment_type', arg_type=get_enum_type(["managed", "connected"]), help="Type of environment.", is_preview=True)