az containerapp connected-env

Preview
Reference

Note

This reference is part of the containerapp extension for the Azure CLI (version 2.62.0 or higher). The extension will automatically install the first time you run an az containerapp connected-env command. Learn more about extensions.

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Commands to manage Container Apps Connected environments for use with Arc enabled Container Apps.

Commands

Name	Description	Type	Status
az containerapp connected-env certificate	Commands to manage certificates for the Container Apps connected environment.	Extension	Preview
az containerapp connected-env certificate delete	Delete a certificate from the Container Apps connected environment.	Extension	Preview
az containerapp connected-env certificate list	List certificates for a connected environment.	Extension	Preview
az containerapp connected-env certificate upload	Add or update a certificate.	Extension	Preview
az containerapp connected-env create	Create a Container Apps connected environment.	Extension	Preview
az containerapp connected-env dapr-component	Commands to manage Dapr components for Container Apps connected environments.	Extension	Preview
az containerapp connected-env dapr-component list	List Dapr components for a connected environment.	Extension	Preview
az containerapp connected-env dapr-component remove	Remove a Dapr component from a connected environment.	Extension	Preview
az containerapp connected-env dapr-component set	Create or update a Dapr component.	Extension	Preview
az containerapp connected-env dapr-component show	Show the details of a Dapr component.	Extension	Preview
az containerapp connected-env delete	Delete a Container Apps connected environment.	Extension	Preview
az containerapp connected-env list	List Container Apps connected environments by subscription or resource group.	Extension	Preview
az containerapp connected-env show	Show details of a Container Apps connected environment.	Extension	Preview
az containerapp connected-env storage	Commands to manage storage for the Container Apps connected environment.	Extension	Preview
az containerapp connected-env storage list	List the storages for a connected environment.	Extension	Preview
az containerapp connected-env storage remove	Remove a storage from a connected environment.	Extension	Preview
az containerapp connected-env storage set	Create or update a storage.	Extension	Preview
az containerapp connected-env storage show	Show the details of a storage.	Extension	Preview

az containerapp connected-env create

Preview

Command group 'containerapp connected-env' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a Container Apps connected environment.

Create a Container Apps Connected environment for use with Arc enabled Container Apps. Environments are an isolation boundary around a collection of container apps.

az containerapp connected-env create --custom-location
                                     --name
                                     --resource-group
                                     [--dapr-ai-connection-string]
                                     [--location]
                                     [--no-wait]
                                     [--static-ip]
                                     [--tags]

Examples

Create a connected environment

az containerapp connected-env create -n MyContainerappConnectedEnv -g MyResourceGroup \
    --location eastus --custom-location MyCustomLocationResourceID

Required Parameters

--custom-location

Resource ID of custom location. List using 'az customlocation list'.

--name -n

Name of the Container Apps connected environment.

--resource-group -g

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

Optional Parameters

--dapr-ai-connection-string -d

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

--location -l

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

--no-wait

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

Default value: False

--static-ip

Static IP of the connectedEnvironment.

--tags

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

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 connected-env delete

Preview

Command group 'containerapp connected-env' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a Container Apps connected environment.

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

Examples

Delete a connected environment.

az containerapp connected-env delete -n MyContainerappConnectedEnv -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 connected 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 connected-env list

Preview

Command group 'containerapp connected-env' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List Container Apps connected environments by subscription or resource group.

az containerapp connected-env list [--custom-location]
                                   [--resource-group]

Examples

List connected environments in the current subscription.

az containerapp connected-env list

List connected environments by resource group.

az containerapp connected-env list -g MyResourceGroup

Optional Parameters

--custom-location

Resource ID of custom location. List using 'az customlocation list'.

--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 connected-env show

Preview

Command group 'containerapp connected-env' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show details of a Container Apps connected environment.

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

Examples

Show the details of a connected environment.

az containerapp connected-env show -n MyContainerappConnectedEnv -g MyResourceGroup

Optional Parameters

--ids

--name -n

Name of the Container Apps connected 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.

Share via

az containerapp connected-env

Commands

az containerapp connected-env create

Examples

Required Parameters

Optional Parameters

az containerapp connected-env delete

Examples

Optional Parameters

az containerapp connected-env list

Examples

Optional Parameters

az containerapp connected-env show

Examples

Optional Parameters

Additional resources