az containerapp env

Reference

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 manage Container Apps environments.

Commands

Name	Description	Type	Status
az containerapp env certificate	Commands to manage certificates for the Container Apps environment.	Core and Extension	GA
az containerapp env certificate create	Create a managed certificate.	Core	Preview
az containerapp env certificate delete	Delete a certificate from the Container Apps environment.	Core	GA
az containerapp env certificate delete (containerapp extension)	Delete a certificate from the Container Apps environment.	Extension	GA
az containerapp env certificate list	List certificates for an environment.	Core	GA
az containerapp env certificate list (containerapp extension)	List certificates for an environment.	Extension	GA
az containerapp env certificate upload	Add or update a certificate.	Core	GA
az containerapp env certificate upload (containerapp extension)	Add or update a certificate.	Extension	GA
az containerapp env create	Create a Container Apps environment.	Core	GA
az containerapp env create (containerapp extension)	Create a Container Apps environment.	Extension	GA
az containerapp env dapr-component	Commands to manage Dapr components for the Container Apps environment.	Core and Extension	GA
az containerapp env dapr-component init	Initializes Dapr components and dev services for an environment.	Extension	Preview
az containerapp env dapr-component list	List Dapr components for an environment.	Core	GA
az containerapp env dapr-component remove	Remove a Dapr component from an environment.	Core	GA
az containerapp env dapr-component resiliency	Commands to manage resiliency policies for a dapr component.	Extension	Preview
az containerapp env dapr-component resiliency create	Create resiliency policies for a dapr component.	Extension	Preview
az containerapp env dapr-component resiliency delete	Delete resiliency policies for a dapr component.	Extension	Preview
az containerapp env dapr-component resiliency list	List resiliency policies for a dapr component.	Extension	Preview
az containerapp env dapr-component resiliency show	Show resiliency policies for a dapr component.	Extension	Preview
az containerapp env dapr-component resiliency update	Update resiliency policies for a dapr component.	Extension	Preview
az containerapp env dapr-component set	Create or update a Dapr component.	Core	GA
az containerapp env dapr-component show	Show the details of a Dapr component.	Core	GA
az containerapp env delete	Delete a Container Apps environment.	Core	GA
az containerapp env delete (containerapp extension)	Delete a Container Apps environment.	Extension	GA
az containerapp env dotnet-component	Commands to manage DotNet components within the environment.	Extension	Preview
az containerapp env dotnet-component create	Command to create DotNet component to enable Aspire Dashboard. Supported DotNet component type is Aspire Dashboard.	Extension	Preview
az containerapp env dotnet-component delete	Command to delete DotNet component to disable Aspire Dashboard.	Extension	Preview
az containerapp env dotnet-component list	Command to list DotNet components within the environment.	Extension	Preview
az containerapp env dotnet-component show	Command to show DotNet component in environment.	Extension	Preview
az containerapp env identity	Commands to manage environment managed identities.	Extension	Preview
az containerapp env identity assign	Assign managed identity to a managed environment.	Extension	Preview
az containerapp env identity remove	Remove a managed identity from a managed environment.	Extension	Preview
az containerapp env identity show	Show managed identities of a managed environment.	Extension	Preview
az containerapp env java-component	Commands to manage Java components within the environment.	Extension	GA
az containerapp env java-component admin-for-spring	Commands to manage the Admin for Spring for the Container Apps environment.	Extension	GA
az containerapp env java-component admin-for-spring create	Command to create the Admin for Spring.	Extension	GA
az containerapp env java-component admin-for-spring delete	Command to delete the Admin for Spring.	Extension	GA
az containerapp env java-component admin-for-spring show	Command to show the Admin for Spring.	Extension	GA
az containerapp env java-component admin-for-spring update	Command to update the Admin for Spring.	Extension	GA
az containerapp env java-component config-server-for-spring	Commands to manage the Config Server for Spring for the Container Apps environment.	Extension	GA
az containerapp env java-component config-server-for-spring create	Command to create the Config Server for Spring.	Extension	GA
az containerapp env java-component config-server-for-spring delete	Command to delete the Config Server for Spring.	Extension	GA
az containerapp env java-component config-server-for-spring show	Command to show the Config Server for Spring.	Extension	GA
az containerapp env java-component config-server-for-spring update	Command to update the Config Server for Spring.	Extension	GA
az containerapp env java-component eureka-server-for-spring	Commands to manage the Eureka Server for Spring for the Container Apps environment.	Extension	GA
az containerapp env java-component eureka-server-for-spring create	Command to create the Eureka Server for Spring.	Extension	GA
az containerapp env java-component eureka-server-for-spring delete	Command to delete the Eureka Server for Spring.	Extension	GA
az containerapp env java-component eureka-server-for-spring show	Command to show the Eureka Server for Spring.	Extension	GA
az containerapp env java-component eureka-server-for-spring update	Command to update the Eureka Server for Spring.	Extension	GA
az containerapp env java-component gateway-for-spring	Commands to manage the Gateway for Spring for the Container Apps environment.	Extension	Preview
az containerapp env java-component gateway-for-spring create	Command to create the Gateway for Spring.	Extension	Preview
az containerapp env java-component gateway-for-spring delete	Command to delete the Gateway for Spring.	Extension	Preview
az containerapp env java-component gateway-for-spring show	Command to show the Gateway for Spring.	Extension	Preview
az containerapp env java-component gateway-for-spring update	Command to update the Gateway for Spring.	Extension	Preview
az containerapp env java-component list	List all Java components within the environment.	Extension	GA
az containerapp env java-component nacos	Commands to manage the Nacos for the Container Apps environment.	Extension	Preview
az containerapp env java-component nacos create	Command to create the Nacos.	Extension	Preview
az containerapp env java-component nacos delete	Command to delete the Nacos.	Extension	Preview
az containerapp env java-component nacos show	Command to show the Nacos.	Extension	Preview
az containerapp env java-component nacos update	Command to update the Nacos.	Extension	Preview
az containerapp env java-component spring-cloud-config	Commands to manage the Config Server for Spring for the Container Apps environment.	Extension	Deprecated
az containerapp env java-component spring-cloud-config create	Command to create the Spring Cloud Config.	Extension	Deprecated
az containerapp env java-component spring-cloud-config delete	Command to delete the Spring Cloud Config.	Extension	Deprecated
az containerapp env java-component spring-cloud-config show	Command to show the Spring Cloud Config.	Extension	Deprecated
az containerapp env java-component spring-cloud-config update	Command to update the Spring Cloud Config.	Extension	Deprecated
az containerapp env java-component spring-cloud-eureka	Commands to manage the Spring Cloud Eureka for the Container Apps environment.	Extension	Deprecated
az containerapp env java-component spring-cloud-eureka create	Command to create the Spring Cloud Eureka.	Extension	Deprecated
az containerapp env java-component spring-cloud-eureka delete	Command to delete the Spring Cloud Eureka.	Extension	Deprecated
az containerapp env java-component spring-cloud-eureka show	Command to show the Spring Cloud Eureka.	Extension	Deprecated
az containerapp env java-component spring-cloud-eureka update	Command to update the Spring Cloud Eureka.	Extension	Deprecated
az containerapp env list	List Container Apps environments by subscription or resource group.	Core	GA
az containerapp env list (containerapp extension)	List Container Apps environments by subscription or resource group.	Extension	GA
az containerapp env list-usages	List usages of quotas for specific managed environment.	Core	GA
az containerapp env logs	Show container app environment logs.	Core	GA
az containerapp env logs show	Show past environment logs and/or print logs in real time (with the --follow parameter).	Core	GA
az containerapp env maintenance-config	Commands to manage Planned Maintenance for Container Apps.	Extension	Preview
az containerapp env maintenance-config add	Add Planned Maintenance to a Container App Environment.	Extension	Preview
az containerapp env maintenance-config list	List Planned Maintenance in a Container App Environment.	Extension	Preview
az containerapp env maintenance-config remove	Remove Planned Maintenance in a Container App Environment.	Extension	Preview
az containerapp env maintenance-config update	Update Planned Maintenance in a Container App Environment.	Extension	Preview
az containerapp env show	Show details of a Container Apps environment.	Core	GA
az containerapp env show (containerapp extension)	Show details of a Container Apps environment.	Extension	GA
az containerapp env storage	Commands to manage storage for the Container Apps environment.	Core and Extension	GA
az containerapp env storage list	List the storages for an environment.	Core	GA
az containerapp env storage list (containerapp extension)	List the storages for an environment.	Extension	GA
az containerapp env storage remove	Remove a storage from an environment.	Core	GA
az containerapp env storage remove (containerapp extension)	Remove a storage from an environment.	Extension	GA
az containerapp env storage set	Create or update a storage.	Core	GA
az containerapp env storage set (containerapp extension)	Create or update a storage.	Extension	GA
az containerapp env storage show	Show the details of a storage.	Core	GA
az containerapp env storage show (containerapp extension)	Show the details of a storage.	Extension	GA
az containerapp env telemetry	Commands to manage telemetry settings for the container apps environment.	Extension	Preview
az containerapp env telemetry app-insights	Commands to manage app insights settings for the container apps environment.	Extension	Preview
az containerapp env telemetry app-insights delete	Delete container apps environment telemetry app insights settings.	Extension	Preview
az containerapp env telemetry app-insights set	Create or update container apps environment telemetry app insights settings.	Extension	Preview
az containerapp env telemetry app-insights show	Show container apps environment telemetry app insights settings.	Extension	Preview
az containerapp env telemetry data-dog	Commands to manage data dog settings for the container apps environment.	Extension	Preview
az containerapp env telemetry data-dog delete	Delete container apps environment telemetry data dog settings.	Extension	Preview
az containerapp env telemetry data-dog set	Create or update container apps environment telemetry data dog settings.	Extension	Preview
az containerapp env telemetry data-dog show	Show container apps environment telemetry data dog settings.	Extension	Preview
az containerapp env telemetry otlp	Commands to manage otlp settings for the container apps environment.	Extension	Preview
az containerapp env telemetry otlp add	Add container apps environment telemetry otlp settings.	Extension	Preview
az containerapp env telemetry otlp list	List container apps environment telemetry otlp settings.	Extension	Preview
az containerapp env telemetry otlp remove	Remove container apps environment telemetry otlp settings.	Extension	Preview
az containerapp env telemetry otlp show	Show container apps environment telemetry otlp settings.	Extension	Preview
az containerapp env telemetry otlp update	Update container apps environment telemetry otlp settings.	Extension	Preview
az containerapp env update	Update a Container Apps environment.	Core	GA
az containerapp env update (containerapp extension)	Update a Container Apps environment.	Extension	GA
az containerapp env workload-profile	Manage the workload profiles of a Container Apps environment.	Core and Extension	GA
az containerapp env workload-profile add	Create a workload profile in a Container Apps environment.	Core	GA
az containerapp env workload-profile delete	Delete a workload profile from a Container Apps environment.	Core	GA
az containerapp env workload-profile list	List the workload profiles from a Container Apps environment.	Core	GA
az containerapp env workload-profile list-supported	List the supported workload profiles in a region.	Core	GA
az containerapp env workload-profile set	Create or update an existing workload profile in a Container Apps environment.	Extension	Deprecated
az containerapp env workload-profile show	Show a workload profile from a Container Apps environment.	Core	GA
az containerapp env workload-profile update	Update an existing workload profile in a Container Apps environment.	Core	GA

az containerapp env create

Edit

Create a Container Apps environment.

az containerapp env create --name
                           --resource-group
                           [--certificate-file]
                           [--certificate-password]
                           [--custom-domain-dns-suffix]
                           [--dapr-connection-string]
                           [--dapr-instrumentation-key]
                           [--docker-bridge-cidr]
                           [--enable-mtls {false, true}]
                           [--enable-peer-to-peer-encryption {false, true}]
                           [--enable-workload-profiles {false, true}]
                           [--infrastructure-subnet-resource-id]
                           [--internal-only {false, true}]
                           [--location]
                           [--logs-destination {azure-monitor, log-analytics, none}]
                           [--logs-workspace-id]
                           [--logs-workspace-key]
                           [--no-wait]
                           [--platform-reserved-cidr]
                           [--platform-reserved-dns-ip]
                           [--storage-account]
                           [--tags]
                           [--zone-redundant]

Examples

Create an environment with an auto-generated Log Analytics workspace.

az containerapp env create -n MyContainerappEnvironment -g MyResourceGroup \
    --location eastus2

Create a zone-redundant environment

az containerapp env create -n MyContainerappEnvironment -g MyResourceGroup \
    --location eastus2 --zone-redundant

Create an environment with an existing Log Analytics workspace.

az containerapp env create -n MyContainerappEnvironment -g MyResourceGroup \
    --logs-workspace-id myLogsWorkspaceID \
    --logs-workspace-key myLogsWorkspaceKey \
    --location eastus2

Create an environment with workload profiles enabled.

az containerapp env create -n MyContainerappEnvironment -g MyResourceGroup \
    --location eastus2 --enable-workload-profiles

Create an environment without workload profiles enabled.

az containerapp env create -n MyContainerappEnvironment -g MyResourceGroup \
    --location eastus2 --enable-workload-profiles false

Required Parameters

--name -n

Name of the Container Apps environment.

--resource-group -g

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

Optional Parameters

--certificate-file --custom-domain-certificate-file

The filepath of the certificate file (.pfx or .pem) for the environment's custom domain. To manage certificates for container apps, use az containerapp env certificate.

--certificate-password --custom-domain-certificate-password

The certificate file password for the environment's custom domain.

--custom-domain-dns-suffix --dns-suffix

The DNS suffix for the environment's custom domain.

--dapr-connection-string -d

Application Insights connection string used by Dapr to export service to service communication telemetry.

--dapr-instrumentation-key

Deprecated

Argument 'instrumentation_key' has been deprecated and will be removed in a future release.

Application Insights instrumentation key used by Dapr to export Service to Service communication telemetry.

--docker-bridge-cidr

Deprecated

Option '--docker-bridge-cidr' has been deprecated and will be removed in the Ignite 2024

CIDR notation IP range assigned to the Docker bridge. It must not overlap with any Subnet IP ranges or the IP range defined in Platform Reserved CIDR, if defined.

--enable-mtls

Boolean indicating if mTLS peer authentication is enabled for the environment.

Accepted values: false, true

--enable-peer-to-peer-encryption

Boolean indicating whether the peer-to-peer traffic encryption is enabled for the environment.

Accepted values: false, true

--enable-workload-profiles -w

Boolean indicating if the environment is enabled to have workload profiles.

Accepted values: false, true

Default value: True

--infrastructure-subnet-resource-id -s

Resource ID of a subnet for infrastructure components and user app containers.

--internal-only

Boolean indicating the environment only has an internal load balancer. These environments do not have a public static IP resource, therefore must provide infrastructureSubnetResourceId if enabling this property.

Accepted values: false, true

Default value: False

--location -l

Location of resource. Examples: eastus2, northeurope.

--logs-destination

Logs destination.

Accepted values: azure-monitor, log-analytics, none

Default value: log-analytics

--logs-workspace-id

Workspace ID of the Log Analytics workspace to send diagnostics logs to. Only works with logs destination "log-analytics". You can use "az monitor log-analytics workspace create" to create one. Extra billing may apply.

--logs-workspace-key

Log Analytics workspace key to configure your Log Analytics workspace. Only works with logs destination "log-analytics". You can use "az monitor log-analytics workspace get-shared-keys" to retrieve the key.

--no-wait

Do not wait for the long-running operation to finish.

Default value: False

--platform-reserved-cidr

IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. It must not overlap with any other Subnet IP ranges.

--platform-reserved-dns-ip

An IP address from the IP range defined by Platform Reserved CIDR that will be reserved for the internal DNS server.

--storage-account

Name or resource ID of the storage account used for Azure Monitor. If this value is provided, Azure Monitor Diagnostic Settings will be created automatically.

--tags

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

--zone-redundant -z

Enable zone redundancy on the environment. Cannot be used without --infrastructure-subnet-resource-id. If used with --location, the subnet's location must match.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--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.

az containerapp env create (containerapp extension)

Create a Container Apps environment.

az containerapp env create --name
                           --resource-group
                           [--certificate-akv-url]
                           [--certificate-file]
                           [--certificate-identity]
                           [--certificate-password]
                           [--custom-domain-dns-suffix]
                           [--dapr-connection-string]
                           [--dapr-instrumentation-key]
                           [--docker-bridge-cidr]
                           [--enable-dedicated-gpu {false, true}]
                           [--enable-mtls {false, true}]
                           [--enable-peer-to-peer-encryption {false, true}]
                           [--enable-workload-profiles {false, true}]
                           [--infrastructure-resource-group]
                           [--infrastructure-subnet-resource-id]
                           [--internal-only {false, true}]
                           [--location]
                           [--logs-destination {azure-monitor, log-analytics, none}]
                           [--logs-dynamic-json-columns {false, true}]
                           [--logs-workspace-id]
                           [--logs-workspace-key]
                           [--mi-system-assigned]
                           [--mi-user-assigned]
                           [--no-wait]
                           [--platform-reserved-cidr]
                           [--platform-reserved-dns-ip]
                           [--public-network-access {Disabled, Enabled}]
                           [--storage-account]
                           [--tags]
                           [--zone-redundant]

Examples

Create an environment with an auto-generated Log Analytics workspace.

az containerapp env create -n MyContainerappEnvironment -g MyResourceGroup \
    --location eastus2

Create a zone-redundant environment

az containerapp env create -n MyContainerappEnvironment -g MyResourceGroup \
    --location eastus2 --zone-redundant

Create an environment with an existing Log Analytics workspace.

az containerapp env create -n MyContainerappEnvironment -g MyResourceGroup \
    --logs-workspace-id myLogsWorkspaceID \
    --logs-workspace-key myLogsWorkspaceKey \
    --location eastus2

Create an environment with workload profiles enabled.

az containerapp env create -n MyContainerappEnvironment -g MyResourceGroup \
    --location eastus2 --enable-workload-profiles

Create an environment without workload profiles enabled.

az containerapp env create -n MyContainerappEnvironment -g MyResourceGroup \
    --location eastus2 --enable-workload-profiles false

Create an environment with system assigned and user assigned identity.

az containerapp env create -n MyContainerappEnvironment -g MyResourceGroup \
    --location eastus2 --mi-system-assigned --mi-user-assigned MyUserIdentityResourceId

Required Parameters

--name -n

Name of the Container Apps environment.

--resource-group -g

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

Optional Parameters

--certificate-akv-url --custom-domain-certificate-akv-url

Preview

The URL pointing to the Azure Key Vault secret that holds the certificate.

--certificate-file --custom-domain-certificate-file

The filepath of the certificate file (.pfx or .pem) for the environment's custom domain. To manage certificates for container apps, use az containerapp env certificate.

--certificate-identity --custom-domain-certificate-identity

Preview

Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity.

--certificate-password --custom-domain-certificate-password

The certificate file password for the environment's custom domain.

--custom-domain-dns-suffix --dns-suffix

The DNS suffix for the environment's custom domain.

--dapr-connection-string -d

Application Insights connection string used by Dapr to export service to service communication telemetry.

--dapr-instrumentation-key

Deprecated

Argument 'instrumentation_key' has been deprecated and will be removed in a future release.

Application Insights instrumentation key used by Dapr to export Service to Service communication telemetry.

--docker-bridge-cidr

Deprecated

Option '--docker-bridge-cidr' has been deprecated and will be removed in the Ignite 2024

CIDR notation IP range assigned to the Docker bridge. It must not overlap with any Subnet IP ranges or the IP range defined in Platform Reserved CIDR, if defined.

--enable-dedicated-gpu

Preview

Boolean indicating if the environment is enabled to have dedicated gpu.

Accepted values: false, true

Default value: False

--enable-mtls

Boolean indicating if mTLS peer authentication is enabled for the environment.

Accepted values: false, true

--enable-peer-to-peer-encryption

Boolean indicating whether the peer-to-peer traffic encryption is enabled for the environment.

Accepted values: false, true

--enable-workload-profiles -w

Boolean indicating if the environment is enabled to have workload profiles.

Accepted values: false, true

Default value: True

--infrastructure-resource-group -i

Preview

Name for resource group that will contain infrastructure resources. If not provided, a resource group name will be generated.

--infrastructure-subnet-resource-id -s

Resource ID of a subnet for infrastructure components and user app containers.

--internal-only

Accepted values: false, true

Default value: False

--location -l

Location of resource. Examples: eastus2, northeurope.

--logs-destination

Logs destination.

Accepted values: azure-monitor, log-analytics, none

Default value: log-analytics

--logs-dynamic-json-columns -j

Preview

Boolean indicating whether to parse json string log into dynamic json columns. Only work for destination log-analytics.

Accepted values: false, true

Default value: False

--logs-workspace-id

--logs-workspace-key

--mi-system-assigned

Preview

Boolean indicating whether to assign system-assigned identity.

Default value: False

--mi-user-assigned

Preview

Space-separated user identities to be assigned.

--no-wait

Do not wait for the long-running operation to finish.

Default value: False

--platform-reserved-cidr

IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. It must not overlap with any other Subnet IP ranges.

--platform-reserved-dns-ip

An IP address from the IP range defined by Platform Reserved CIDR that will be reserved for the internal DNS server.

--public-network-access

Preview

Allow or block all public traffic.

Accepted values: Disabled, Enabled

--storage-account

Name or resource ID of the storage account used for Azure Monitor. If this value is provided, Azure Monitor Diagnostic Settings will be created automatically.

--tags

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

--zone-redundant -z

Enable zone redundancy on the environment. Cannot be used without --infrastructure-subnet-resource-id. If used with --location, the subnet's location must match.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--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.

az containerapp env delete

Edit

Delete a Container Apps environment.

az containerapp env delete [--ids]
                           [--name]
                           [--no-wait]
                           [--resource-group]
                           [--subscription]
                           [--yes]

Examples

Delete an environment.

az containerapp env delete -n MyContainerappEnvironment -g MyResourceGroup

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the Container Apps Environment.

--no-wait

Do not wait for the long-running operation to finish.

Default value: False

--resource-group -g

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

--subscription

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

--yes -y

Do not prompt for confirmation.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--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.

az containerapp env delete (containerapp extension)

Delete a Container Apps environment.

az containerapp env delete [--ids]
                           [--name]
                           [--no-wait]
                           [--resource-group]
                           [--subscription]
                           [--yes]

Examples

Delete an environment.

az containerapp env delete -n MyContainerappEnvironment -g MyResourceGroup

Optional Parameters

--ids

--name -n

Name of the Container Apps Environment.

--no-wait

Do not wait for the long-running operation to finish.

Default value: False

--resource-group -g

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

--subscription

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

--yes -y

Do not prompt for confirmation.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--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.

az containerapp env list

Edit

List Container Apps environments by subscription or resource group.

az containerapp env list [--resource-group]

Examples

List environments in the current subscription.

az containerapp env list

List environments by resource group.

az containerapp env list -g MyResourceGroup

Optional Parameters

--resource-group -g

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--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.

az containerapp env list (containerapp extension)

List Container Apps environments by subscription or resource group.

az containerapp env list [--resource-group]

Examples

List environments in the current subscription.

az containerapp env list

List environments by resource group.

az containerapp env list -g MyResourceGroup

Optional Parameters

--resource-group -g

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--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.

az containerapp env list-usages

Edit

List usages of quotas for specific managed environment.

az containerapp env list-usages [--ids]
                                [--name]
                                [--resource-group]
                                [--subscription]

Examples

List usages of quotas for specific managed environment.

az containerapp env list-usages -n MyEnv -g MyResourceGroup

Optional Parameters

--ids

--name -n

Name of the Container Apps environment.

--resource-group -g

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

--subscription

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--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.

az containerapp env show

Edit

Show details of a Container Apps environment.

az containerapp env show [--ids]
                         [--name]
                         [--resource-group]
                         [--subscription]

Examples

Show the details of an environment.

az containerapp env show -n MyContainerappEnvironment -g MyResourceGroup

Optional Parameters

--ids

--name -n

Name of the Container Apps Environment.

--resource-group -g

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

--subscription

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--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.

az containerapp env show (containerapp extension)

Show details of a Container Apps environment.

az containerapp env show [--ids]
                         [--name]
                         [--resource-group]
                         [--subscription]

Examples

Show the details of an environment.

az containerapp env show -n MyContainerappEnvironment -g MyResourceGroup

Optional Parameters

--ids

--name -n

Name of the Container Apps Environment.

--resource-group -g

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

--subscription

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--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.

az containerapp env update

Edit

Update a Container Apps environment.

az containerapp env update [--certificate-file]
                           [--certificate-password]
                           [--custom-domain-dns-suffix]
                           [--dapr-connection-string]
                           [--enable-mtls {false, true}]
                           [--enable-peer-to-peer-encryption {false, true}]
                           [--ids]
                           [--logs-destination {azure-monitor, log-analytics, none}]
                           [--logs-workspace-id]
                           [--logs-workspace-key]
                           [--max-nodes]
                           [--min-nodes]
                           [--name]
                           [--no-wait]
                           [--resource-group]
                           [--storage-account]
                           [--subscription]
                           [--tags]
                           [--workload-profile-name]
                           [--workload-profile-type]

Examples

Update an environment's custom domain configuration.

az containerapp env update -n MyContainerappEnvironment -g MyResourceGroup \
    --dns-suffix my-suffix.net --certificate-file MyFilePath \
    --certificate-password MyCertPass

Optional Parameters

--certificate-file --custom-domain-certificate-file

The filepath of the certificate file (.pfx or .pem) for the environment's custom domain. To manage certificates for container apps, use az containerapp env certificate.

--certificate-password --custom-domain-certificate-password

The certificate file password for the environment's custom domain.

--custom-domain-dns-suffix --dns-suffix

The DNS suffix for the environment's custom domain.

--dapr-connection-string -d

Application Insights connection string used by Dapr to export service to service communication telemetry. Use "none" to remove it.

--enable-mtls

Boolean indicating if mTLS peer authentication is enabled for the environment.

Accepted values: false, true

--enable-peer-to-peer-encryption

Boolean indicating whether the peer-to-peer traffic encryption is enabled for the environment.

Accepted values: false, true

--ids

--logs-destination

Logs destination.

Accepted values: azure-monitor, log-analytics, none

--logs-workspace-id

--logs-workspace-key

--max-nodes

The maximum nodes for this workload profile, --workload-profile-name required.

--min-nodes

The minimum nodes for this workload profile, --workload-profile-name required.

--name -n

Name of the Container Apps environment.

--no-wait

Do not wait for the long-running operation to finish.

Default value: False

--resource-group -g

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

--storage-account

Name or resource ID of the storage account used for Azure Monitor. If this value is provided, Azure Monitor Diagnostic Settings will be created automatically.

--subscription

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

--tags

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

--workload-profile-name -w

The friendly name for the workload profile.

--workload-profile-type

The type of workload profile to add or update in this environment, --workload-profile-name required.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--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.

az containerapp env update (containerapp extension)

Update a Container Apps environment.

az containerapp env update [--certificate-akv-url]
                           [--certificate-file]
                           [--certificate-identity]
                           [--certificate-password]
                           [--custom-domain-dns-suffix]
                           [--enable-mtls {false, true}]
                           [--enable-peer-to-peer-encryption {false, true}]
                           [--ids]
                           [--logs-destination {azure-monitor, log-analytics, none}]
                           [--logs-dynamic-json-columns {false, true}]
                           [--logs-workspace-id]
                           [--logs-workspace-key]
                           [--max-nodes]
                           [--min-nodes]
                           [--name]
                           [--no-wait]
                           [--public-network-access {Disabled, Enabled}]
                           [--resource-group]
                           [--storage-account]
                           [--subscription]
                           [--tags]
                           [--workload-profile-name]
                           [--workload-profile-type]

Examples

Update an environment's custom domain configuration.

az containerapp env update -n MyContainerappEnvironment -g MyResourceGroup \
    --dns-suffix my-suffix.net --certificate-file MyFilePath \
    --certificate-password MyCertPass

Optional Parameters

--certificate-akv-url --custom-domain-certificate-akv-url

Preview

The URL pointing to the Azure Key Vault secret that holds the certificate.

--certificate-file --custom-domain-certificate-file

The filepath of the certificate file (.pfx or .pem) for the environment's custom domain. To manage certificates for container apps, use az containerapp env certificate.

--certificate-identity --custom-domain-certificate-identity

Preview

Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity.

--certificate-password --custom-domain-certificate-password

The certificate file password for the environment's custom domain.

--custom-domain-dns-suffix --dns-suffix

The DNS suffix for the environment's custom domain.

--enable-mtls

Boolean indicating if mTLS peer authentication is enabled for the environment.

Accepted values: false, true

--enable-peer-to-peer-encryption

Boolean indicating whether the peer-to-peer traffic encryption is enabled for the environment.

Accepted values: false, true

--ids

--logs-destination

Logs destination.

Accepted values: azure-monitor, log-analytics, none

--logs-dynamic-json-columns -j

Preview

Boolean indicating whether to parse json string log into dynamic json columns. Only work for destination log-analytics.

Accepted values: false, true

--logs-workspace-id

--logs-workspace-key

--max-nodes

The maximum nodes for this workload profile, --workload-profile-name required.

--min-nodes

The minimum nodes for this workload profile, --workload-profile-name required.

--name -n

Name of the Container Apps environment.

--no-wait

Do not wait for the long-running operation to finish.

Default value: False

--public-network-access

Preview

Allow or block all public traffic.

Accepted values: Disabled, Enabled

--resource-group -g

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

--storage-account

Name or resource ID of the storage account used for Azure Monitor. If this value is provided, Azure Monitor Diagnostic Settings will be created automatically.

--subscription

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

--tags

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

--workload-profile-name -w

The friendly name for the workload profile.

--workload-profile-type

The type of workload profile to add or update in this environment, --workload-profile-name required.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--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.

Share via

az containerapp env

Commands

az containerapp env create

Examples

Required Parameters

Optional Parameters

az containerapp env create (containerapp extension)

Examples

Required Parameters

Optional Parameters

az containerapp env delete

Examples

Optional Parameters

az containerapp env delete (containerapp extension)

Examples

Optional Parameters

az containerapp env list

Examples

Optional Parameters

az containerapp env list (containerapp extension)

Examples

Optional Parameters

az containerapp env list-usages

Examples

Optional Parameters

az containerapp env show

Examples

Optional Parameters

az containerapp env show (containerapp extension)

Examples

Optional Parameters

az containerapp env update

Examples

Optional Parameters

az containerapp env update (containerapp extension)

Examples

Optional Parameters

Additional resources