az containerapp connected-env
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
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
Resource ID of custom location. List using 'az customlocation list'.
Name of the Container Apps connected environment.
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.
Application Insights connection string used by Dapr to export Service to Service communication telemetry.
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Default value: | False |
Static IP of the connectedEnvironment.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az containerapp connected-env delete
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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of the Container Apps connected environment.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Default value: | False |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Do not prompt for confirmation.
Property | Value |
---|---|
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az containerapp connected-env list
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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Resource ID of custom location. List using 'az customlocation list'.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az containerapp connected-env show
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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of the Container Apps connected environment.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |