Share via

az containerapp compose

Note

This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.

Commands to create Azure Container Apps from Compose specifications.

Commands

Name Description Type Status
az containerapp compose create

Create one or more Container Apps in a new or existing Container App Environment from a Compose specification.

 Core GA
az containerapp compose create (containerapp extension)

Create one or more Container Apps in a new or existing Container App Environment from a Compose specification.

 Extension GA

az containerapp compose create

Edit

Create one or more Container Apps in a new or existing Container App Environment from a Compose specification.

az containerapp compose create --environment
                               --resource-group
                               [--compose-file-path]
                               [--location]
                               [--registry-password]
                               [--registry-server]
                               [--registry-username]
                               [--tags]
                               [--transport]
                               [--transport-mapping]

Examples

Create a container app by implicitly passing in a Compose configuration file from current directory.

az containerapp compose create -g MyResourceGroup \
    --environment MyContainerappEnv

Create a container app by explicitly passing in a Compose configuration file.

az containerapp compose create -g MyResourceGroup \
    --environment MyContainerappEnv \
    --compose-file-path "path/to/docker-compose.yml"

Required Parameters

--environment

Name or resource ID of the container app's environment.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--compose-file-path -f

Path to a Docker Compose file with the configuration to import to Azure Container Apps.

Property Value
Default value: ./docker-compose.yml
--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--registry-password

The password to log in to container registry. If stored as a secret, value must start with 'secretref:' followed by the secret name.

Property Value
Parameter group: Configuration Arguments
--registry-server

The container registry server hostname, e.g. myregistry.azurecr.io.

Property Value
Parameter group: Configuration Arguments
--registry-username

The username to log in to container registry.

Property Value
Parameter group: Configuration Arguments
--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--transport
Deprecated

Option '--transport' has been deprecated and will be removed in a future release. Use '--transport-mapping' instead.

Transport options per Container App instance (servicename=transportsetting).

--transport-mapping

Transport options per Container App instance (servicename=transportsetting).

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az containerapp compose create (containerapp extension)

Create one or more Container Apps in a new or existing Container App Environment from a Compose specification.

az containerapp compose create --environment
                               --resource-group
                               [--compose-file-path]
                               [--location]
                               [--registry-password]
                               [--registry-server]
                               [--registry-username]
                               [--tags]
                               [--transport]
                               [--transport-mapping]

Examples

Create a container app by implicitly passing in a Compose configuration file from current directory.

az containerapp compose create -g MyResourceGroup \
    --environment MyContainerappEnv

Create a container app by explicitly passing in a Compose configuration file.

az containerapp compose create -g MyResourceGroup \
    --environment MyContainerappEnv \
    --compose-file-path "path/to/docker-compose.yml"

Required Parameters

--environment

Name or resource ID of the container app's environment.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--compose-file-path -f

Path to a Docker Compose file with the configuration to import to Azure Container Apps.

Property Value
Default value: ./docker-compose.yml
--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--registry-password

The password to log in to container registry. If stored as a secret, value must start with 'secretref:' followed by the secret name.

Property Value
Parameter group: Configuration Arguments
--registry-server

The container registry server hostname, e.g. myregistry.azurecr.io.

Property Value
Parameter group: Configuration Arguments
--registry-username

The username to log in to container registry.

Property Value
Parameter group: Configuration Arguments
--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--transport
Deprecated

Option '--transport' has been deprecated and will be removed in a future release. Use '--transport-mapping' instead.

Transport options per Container App instance (servicename=transportsetting).

--transport-mapping

Transport options per Container App instance (servicename=transportsetting).

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False