Update AzureContainerAppsV0 with latest changes and Introduce AzureContainerAppsV1 task (#18055)

* Update AzureContainerAppsV0 with latest changes

* Introduce AzureContainerAppsV1 task

---------

Co-authored-by: Cormac McCarthy <[email protected]>
Co-authored-by: Kirill Ivlev <[email protected]>

Author: 3 people

.github/CODEOWNERS

@@ -29,6 +29,8 @@ Tasks/AzureCloudPowerShellDeploymentV1/    @vsebesta   @rvairavelu   @pipeline-e
 
 Tasks/AzureContainerAppsV0/    @cormacpayne    @daniv-msft
 
+Tasks/AzureContainerAppsV1/    @cormacpayne    @daniv-msft
+
 Tasks/AzureFileCopyV1/    @vsebesta   @rvairavelu   @pipeline-environment-team
 
 Tasks/AzureFileCopyV2/    @vsebesta   @rvairavelu   @pipeline-environment-team

Tasks/AzureContainerAppsV0/README.md

@@ -18,6 +18,9 @@ with a call to `docker build` and the Container App will be created or updated b
 If a previously built image has already been pushed to the ACR instance and is provided to this task, no application
 source is required and the image will be used when creating or updating the Container App.
 
+A YAML configuration file can also be provided to modify specific properties on the Container App that is created or
+updated; please see the section below on the `yamlConfigPath` argument.
+
 ## Running this task on Microsoft-hosted agents
 
 If you are running this task on a
@@ -153,6 +156,41 @@ need to be provided in order for this task to successfully run using one of the
 | ------------------------- | -------- | ----------- |
 | `imageToDeploy`           | Yes (for this scenario) | The name of the image that has already been pushed to a registry and will be deployed to the Container App by this task. If this image is found in an ACR instance that requires authentication to pull, the `acrName` argument, or the `acrUsername` and `acrPassword` arguments, can be provided to authenticate requests to the ACR instance. |
 
+### Arguments required for using a YAML configuration file
+
+| Argument name             | Required | Description |
+| ------------------------- | -------- | ----------- |
+| `yamlConfigPath`          | Yes (for this scenario) | Full path (on the executing Azure Pipelines agent) to the YAML file detailing the configuration of the Container App. |
+
+#### Important notes on the YAML configuration file
+
+The `resourceGroup` property in the YAML configuration file _will not_ be used; the value for this either comes from
+the `resourceGroup` argument provided to the task, or the default resource group name generated by the task. All other
+properties provided in the YAML configuration file will override the values provided as arguments to this task; for
+example, if the `containerAppName` argument is provided to the task, and the `name` property is set in the YAML
+configuration file, the `name` property in the YAML file will be used when creating or updating the Container App.
+
+Image and application source arguments (_e.g._, `appSourcePath`, `imageToDeploy`) will still be used to first build
+and/or push an image that is used by the Container App; in this case, the provided YAML configuration file will need to
+reference the image specified by `imageToDeploy` (or `imageToBuild`, depending on your scenario).
+
+When creating a new Container App, all properties listed in the YAML configuration file (except `resourceGroup` as
+mentioned above) will be set when the Container App is created. When updating an existing Container App, only the
+properties listed in the file will be updated on the Container App.
+
+Currently, the YAML file does not support setting up managed identity authentication for the container registry used;
+for more information on this issue, please see
+[this GitHub issue](https://github.com/microsoft/azure-container-apps/issues/524).
+
+In cases where the `yamlConfigPath` argument is provided, the YAML file will be passed through to the corresponding
+`az containerapp` command, either
+[`create`](https://learn.microsoft.com/en-us/cli/azure/containerapp?view=azure-cli-latest#az-containerapp-create) or
+[`update`](https://learn.microsoft.com/en-us/cli/azure/containerapp?view=azure-cli-latest#az-containerapp-update)
+depending on your scenario. For more information on the intended behavior when the YAML configuration file is provided,
+please see the documents linked for the corresponding commands.
+
+For more information on the structure of the YAML configuration file, please visit [this site](https://aka.ms/azure-container-apps-yaml).
+
 ### Additional arguments
 
 | Argument name             | Required | Description |
@@ -161,14 +199,15 @@ need to be provided in order for this task to successfully run using one of the
 | `acrUsername`             | No       | The username used to authenticate push requests to the provided Azure Container Registry. If not provided, an access token will be generated via "az acr login" and provided to "docker login" to authenticate the requests. |
 | `acrPassword`             | No       | The password used to authenticate push requests to the provided Azure Container Registry. If not provided, an access token will be generated via "az acr login" and provided to "docker login" to authenticate the requests. |
 | `dockerfilePath`          | No       | Relative path (_without file prefixes, see example below_) to the Dockerfile in the provided application source that should be used to build the image that is then pushed to ACR and deployed to the Container App. If not provided, this task will check if there is a file named `Dockerfile` in the provided application source and use that to build the image. Otherwise, the Oryx++ Builder will be used to create the image. |
-| `imageToBuild`            | No       | The custom name of the image that is to be built, pushed to ACR and deployed to the Container App by this task. _Note_: this image name should include the ACR server; _e.g._, `<acr-name>.azurecr.io/<repo>:<tag>`. If this argument is not provided, a default image name will be constructed in the form `<acr-name>.azurecr.io/ado-task/container-app:<build-id>.<build-number>` |
+| `imageToBuild`            | No       | The custom name of the image that is to be built, pushed to ACR and deployed to the Container App by this task. _Note_: this image name should include the ACR server; _e.g._, `<acr-name>.azurecr.io/<repo>:<tag>`. If this argument is not provided, a default image name will be constructed in the form of `<acr-name>.azurecr.io/ado-task/container-app:<build-id>.<build-number>` |
 | `containerAppName`        | No       | The name of the Container App that will be created or updated. If not provided, this value will be `ado-task-app-<build-id>-<build-number>`. |
-| `resourceGroup`           | No       | The resource group that the Container App will be created in, or currently exists in. If not provided, this value will be `<container-app-name>-rg`. |
-| `containerAppEnvironment` | No       | The name of the Container App environment to use with the application. If not provided, an existing environment in the resource group of the Container App will be used, otherwise, an environment will be created in the formation `<container-app-name>-env`. |
-| `runtimeStack`            | No       | The platform version stack used in the final runnable application image that is deployed to the Container App. The value should be provided in the formation `<platform>:<version>`. If not provided, this value is determined by Oryx based on the contents of the provided application. Please refer to [this document](https://github.com/microsoft/Oryx/blob/main/doc/supportedRuntimeVersions.md) for more information on supported runtime stacks for Oryx. |
-| `targetPort`              | No       | The target port that the Container App will listen on. If not provided, this value will be "80" for Python applications and "8080" for all other supported platforms. |
+| `resourceGroup`           | No       | The existing resource group that the Azure Container App will be created in. If not provided, this value will be `<container-app-name>-rg` and its existence will first be checked before attempting to create it. |
+| `containerAppEnvironment` | No       | The name of the Container App environment to use with the application. If not provided, an existing environment in the resource group of the Container App will be used, otherwise, an environment will be created in the form of `<container-app-name>-env`. |
+| `runtimeStack`            | No       | The platform version stack used in the final runnable application image that is deployed to the Container App. The value should be provided in the form of `<platform>:<version>`. If not provided, this value is determined by Oryx based on the contents of the provided application. Please refer to [this document](https://github.com/microsoft/Oryx/blob/main/doc/supportedRuntimeVersions.md) for more information on supported runtime stacks for Oryx. |
+| `targetPort`              | No       | The designated port for the application to run on. If no value is provided and the builder is used to build the runnable application image, the target port will be set to 80 for Python applications and 8080 for all other platform applications. If no value is provided when creating a Container App, the target port will default to 80. Note: when using this task to update a Container App, the target port may be updated if not provided based on changes to the ingress property. |
 | `location`                | No       | The location that the Container App (and other created resources) will be deployed to. To view locations suitable for creating the Container App in, please run the following: `az provider show -n Microsoft.App --query "resourceTypes[?resourceType=='containerApps'].locations"` |
 | `environmentVariables`    | No       | A list of environment variable(s) for the container. Space-separated values in 'key=value' format. Empty string to clear existing values. Prefix value with 'secretref:' to reference a secret. |
+| `ingress`                 | No       | Possible options: external, internal, disabled. If set to `external` (default value if not provided when creating a Container App), the Container App will be visible from the internet or a VNET, depending on the app environment endpoint configured. If set to `internal`, the Container App will be visible from within the app environment only. If set to `disabled`, ingress will be disabled for this Container App and will not have an HTTP or TCP endpoint. |
 | `disableTelemetry`        | No       | If set to `true`, no telemetry will be collected by this Azure DevOps Task. If set to `false`, or if this argument is not provided, telemetry will be sent to Microsoft about the Container App build and deploy scenario targeted by this Azure DevOps Task. |
 
 ## Usage
@@ -209,6 +248,42 @@ This will create a new Container App named `ado-task-app-<build-id>-<build-numbe
 `<container-app-name>-rg` where **no new image is built**, but an existing image named
 `mcr.microsoft.com/azuredocs/containerapps-helloworld:latest` will be used for the Container App.
 
+### Minimal - Use YAML configuration file with previously published image for Container App
+
+```yml
+steps:
+
+  - task: AzureContainerApps@0
+    displayName: Build and deploy Container App
+    inputs:
+      yamlConfigPath: simple-image-container-app.yaml
+```
+
+This will create a new Container App named `ado-task-app-<build-id>-<build-number>` in a new resource group named
+`<container-app-name>-rg` where **no new image is built**, but an existing image named
+`mcr.microsoft.com/azuredocs/containerapps-helloworld:latest` will be used for the Container App. Additional properties
+about the Container App will be pulled from the `simple-image-container-app.yaml` file and will override any additional
+values that would've been provided to the task as arguments **excluding `resourceGroup`**.
+
+The `simple-image-container-app.yaml` file has the following structure:
+
+```yml
+properties:
+  managedEnvironmentId: /subscriptions/SUBSCRIPTION_ID/resourceGroup/RESOURCE_GROUP/providers/Microsoft.App/managedEnvironments/CONTAINER_APP_ENVIRONMENT
+  configuration:
+    ingress:
+      external: true
+      allowInsecure: false
+      targetPort: 80
+  template:
+    containers:
+      - image: mcr.microsoft.com/azuredocs/containerapps-helloworld:latest
+        name: mysampleimagecontainer
+```
+
+The values for `SUBSCRIPTION_ID`, `RESOURCE_GROUP` and `CONTAINER_APP_ENVIRONMENT` must be updated to point to the full
+resource ID of the **existing** Container App environment that the Container App will use.
+
 ### Using ACR credentials to authenticate
 
 ```yml
@@ -366,8 +441,5 @@ contact [[email protected]](mailto:[email protected]) with any additio
 For any issues and feedback for the _official_ `AzureContainerApps` task, please create a new issue
 [in the `azure-pipelines-tasks` repository](https://github.com/microsoft/azure-pipelines-tasks/issues).
 
-For any issues and feedback for the _Release Candidate_ `AzureContainerAppsRC` task, please create a new issue
-[in this `container-apps-deploy-pipelines-task` repository](https://github.com/azure/container-apps-deploy-pipelines-task/issues).
-
 Do you think there might be a security issue? Have you been phished or identified a security vulnerability? Please don't
 report it here - let us know by sending an email to [email protected].