Share via

az containerapp env dapr-component

  • 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 Dapr components for the Container Apps environment.

Commands

Name Description Type Status
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 dapr-component init

Preview

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

Initializes Dapr components and dev services for an environment.

az containerapp env dapr-component init --name
                                        --resource-group
                                        [--pubsub]
                                        [--statestore]

Examples

Initialize Dapr components with default statestore and pubsub.

az containerapp env dapr-component init -g MyResourceGroup --name MyEnvironment

Initialize Dapr components with Postgres statestore and Kafka pubsub.

az containerapp env dapr-component init -g MyResourceGroup --name MyEnvironment --statestore postgres --pubsub kafka

Required Parameters

--name -n

The environment name.

--resource-group -g

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

Optional Parameters

--pubsub

The pubsub component and dev service to create.

Default value: redis
--statestore

The state store component and dev service to create.

Default value: redis
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 dapr-component list

Edit

List Dapr components for an environment.

az containerapp env dapr-component list --name
                                        --resource-group

Examples

List Dapr components for an environment.

az containerapp env dapr-component list -g MyResourceGroup --name MyEnvironment

Required Parameters

--name -n

The environment name.

--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 dapr-component remove

Edit

Remove a Dapr component from an environment.

az containerapp env dapr-component remove --dapr-component-name
                                          --name
                                          --resource-group

Examples

Remove a Dapr component from a Container Apps environment.

az containerapp env dapr-component remove -g MyResourceGroup --dapr-component-name MyDaprComponentName --name MyEnvironment

Required Parameters

--dapr-component-name

The Dapr component name.

--name -n

The environment name.

--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 dapr-component set

Edit

Create or update a Dapr component.

az containerapp env dapr-component set --dapr-component-name
                                       --name
                                       --resource-group
                                       --yaml

Examples

Create a Dapr component.

az containerapp env dapr-component set -g MyResourceGroup --name MyEnv --yaml MyYAMLPath --dapr-component-name MyDaprComponentName

Required Parameters

--dapr-component-name

The Dapr component name.

--name -n

The environment name.

--resource-group -g

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

--yaml

Path to a .yaml file with the configuration of a Dapr component. All other parameters will be ignored. For an example, see https://zcusa.951200.xyz/en-us/azure/container-apps/dapr-overview?tabs=bicep1%2Cyaml#component-schema.

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 dapr-component show

Edit

Show the details of a Dapr component.

az containerapp env dapr-component show --dapr-component-name
                                        --name
                                        --resource-group

Examples

Show the details of a Dapr component.

az containerapp env dapr-component show -g MyResourceGroup --dapr-component-name MyDaprComponentName --name MyEnvironment

Required Parameters

--dapr-component-name

The Dapr component name.

--name -n

The environment name.

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