Share via

az containerapp env dapr-component resiliency

  • Preview

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 env dapr-component resiliency 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 resiliency policies for a dapr component.

Commands

Name Description Type Status
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 resiliency create

Preview

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

Create resiliency policies for a dapr component.

az containerapp env dapr-component resiliency create --dapr-component-name
                                                     --environment
                                                     --name
                                                     --resource-group
                                                     [--in-cb-interval]
                                                     [--in-cb-sequential-err]
                                                     [--in-cb-timeout]
                                                     [--in-http-delay]
                                                     [--in-http-interval]
                                                     [--in-http-retries]
                                                     [--in-timeout]
                                                     [--no-wait]
                                                     [--out-cb-interval]
                                                     [--out-cb-sequential-err]
                                                     [--out-cb-timeout]
                                                     [--out-http-delay]
                                                     [--out-http-interval]
                                                     [--out-http-retries]
                                                     [--out-timeout]
                                                     [--yaml]

Examples

Create timeout resiliency policy for a dapr component.

az containerapp env dapr-component resiliency create -g MyResourceGroup \
  -n MyDaprResiliency --dapr-component-name MyDaprComponentName \
  --environment MyEnvironment --out-timeout 45

Create resiliency policies for a dapr component using a yaml configuration.

az containerapp env dapr-component resiliency create -g MyResourceGroup \
  -n MyDaprResiliency --dapr-component-name MyDaprComponentName \
  --environment MyEnvironment --yaml "path/to/yaml/file.yml"

Required Parameters

--dapr-component-name

The name of the existing Dapr Component.

--environment

The environment name.

--name -n

The name of the Dapr Component Resiliency Policy. A name must consist of lower case alphanumeric characters or '-', start with a letter, end with an alphanumeric character, cannot have '--', and must be less than 30 characters.

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

--in-cb-interval

The optional interval in seconds after which the error count resets to 0. An interval of 0 will never reset. If not specified, the timeout value will be used.

Property Value
Parameter group: Inbound Circuit Breaker Policy Arguments
--in-cb-sequential-err

The number of consecutive errors before the circuit is opened.

Property Value
Parameter group: Inbound Circuit Breaker Policy Arguments
--in-cb-timeout

The interval in seconds until a retry attempt is made after the circuit is opened.

Property Value
Parameter group: Inbound Circuit Breaker Policy Arguments
--in-http-delay

Specify the base interval in milliseconds between retries for the inbound policy. Default: 1000.

Property Value
Parameter group: Inbound HTTP Retry Policy Arguments
--in-http-interval

Specify the maximum interval in milliseconds between retries for the inbound policy. Default: 10000.

Property Value
Parameter group: Inbound HTTP Retry Policy Arguments
--in-http-retries

Specify the max number of retries for the inbound policy. Default: 3.

Property Value
Parameter group: Inbound HTTP Retry Policy Arguments
--in-timeout

Specify the response timeout in seconds for the inbound policy. This spans between the point at which the entire request has been processed and when the response has been completely processed. This timeout includes all retries.

Property Value
Parameter group: Inbound Timeout Policy Arguments
--no-wait

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

Property Value
Default value: False
--out-cb-interval

The optional interval in seconds after which the error count resets to 0. An interval of 0 will never reset. If not specified, the timeout value will be used.

Property Value
Parameter group: Outbound Circuit Breaker Policy Arguments
--out-cb-sequential-err

The number of consecutive errors before the circuit is opened.

Property Value
Parameter group: Outbound Circuit Breaker Policy Arguments
--out-cb-timeout

The interval in seconds until a retry attempt is made after the circuit is opened.

Property Value
Parameter group: Outbound Circuit Breaker Policy Arguments
--out-http-delay

Specify the base interval in milliseconds between retries for the outbound policy. Default: 1000.

Property Value
Parameter group: Outbound HTTP Retry Policy Arguments
--out-http-interval

Specify the maximum interval in milliseconds between retries for the outbound policy. Default: 10000.

Property Value
Parameter group: Outbound HTTP Retry Policy Arguments
--out-http-retries

Specify the max number of retries for the outbound policy. Default: 3.

Property Value
Parameter group: Outbound HTTP Retry Policy Arguments
--out-timeout

Specify the response timeout in seconds for the outbound policy. This spans between the point at which the entire request has been processed and when the response has been completely processed. This timeout includes all retries.

Property Value
Parameter group: Outbound Timeout Policy Arguments
--yaml

Path to a .yaml file with the configuration of a dapr component resiliency policy. All other parameters will be ignored.

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 env dapr-component resiliency delete

Preview

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

Delete resiliency policies for a dapr component.

az containerapp env dapr-component resiliency delete --dapr-component-name
                                                     --environment
                                                     --resource-group
                                                     [--ids]
                                                     [--name]
                                                     [--no-wait]
                                                     [--subscription]
                                                     [--yes]

Examples

Delete resiliency policies for a dapr component.

az containerapp env dapr-component resiliency delete -g MyResourceGroup \
  -n MyDaprResiliency --dapr-component-name MyDaprComponentName \
  --environment MyEnvironment

Required Parameters

--dapr-component-name

The name of the existing Dapr Component.

--environment

The environment name.

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

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

Property Value
Parameter group: Resource Id Arguments
--name -n

The name of the Dapr Component Resiliency Policy. A name must consist of lower case alphanumeric characters or '-', start with a letter, end with an alphanumeric character, cannot have '--', and must be less than 30 characters.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

Property Value
Default value: False
--subscription

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
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
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.

--verbose

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

Property Value
Default value: False

az containerapp env dapr-component resiliency list

Preview

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

List resiliency policies for a dapr component.

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

Examples

List resiliency policies for a dapr component.

az containerapp env dapr-component resiliency list -g MyResourceGroup \
 --dapr-component-name MyDaprComponentName --environment MyEnvironment

Required Parameters

--dapr-component-name

The name of the existing Dapr Component.

--environment

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.

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

Preview

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

Show resiliency policies for a dapr component.

az containerapp env dapr-component resiliency show --dapr-component-name
                                                   --environment
                                                   --resource-group
                                                   [--ids]
                                                   [--name]
                                                   [--subscription]

Examples

Show resiliency policies for a dapr component.

az containerapp env dapr-component resiliency show -g MyResourceGroup \
  -n MyDaprResiliency --dapr-component-name MyDaprComponentName \
  --environment MyEnvironment

Required Parameters

--dapr-component-name

The name of the existing Dapr Component.

--environment

The environment name.

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

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

Property Value
Parameter group: Resource Id Arguments
--name -n

The name of the Dapr Component Resiliency Policy. A name must consist of lower case alphanumeric characters or '-', start with a letter, end with an alphanumeric character, cannot have '--', and must be less than 30 characters.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

--verbose

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

Property Value
Default value: False

az containerapp env dapr-component resiliency update

Preview

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

Update resiliency policies for a dapr component.

az containerapp env dapr-component resiliency update --dapr-component-name
                                                     --environment
                                                     --resource-group
                                                     [--ids]
                                                     [--in-cb-interval]
                                                     [--in-cb-sequential-err]
                                                     [--in-cb-timeout]
                                                     [--in-http-delay]
                                                     [--in-http-interval]
                                                     [--in-http-retries]
                                                     [--in-timeout]
                                                     [--name]
                                                     [--no-wait]
                                                     [--out-cb-interval]
                                                     [--out-cb-sequential-err]
                                                     [--out-cb-timeout]
                                                     [--out-http-delay]
                                                     [--out-http-interval]
                                                     [--out-http-retries]
                                                     [--out-timeout]
                                                     [--subscription]
                                                     [--yaml]

Examples

Update timeout resiliency policy for a dapr component.

az containerapp env dapr-component resiliency update -g MyResourceGroup \
  -n MyDaprResiliency --dapr-component-name MyDaprComponentName \
  --environment MyEnvironment --in-timeout 45

Update resiliency policies for a dapr component using a yaml configuration.

az containerapp env dapr-component resiliency update -g MyResourceGroup \
  -n MyDaprResiliency --dapr-component-name MyDaprComponentName \
  --environment MyEnvironment --yaml "path/to/yaml/file.yml"

Required Parameters

--dapr-component-name

The name of the existing Dapr Component.

--environment

The environment name.

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

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

Property Value
Parameter group: Resource Id Arguments
--in-cb-interval

The optional interval in seconds after which the error count resets to 0. An interval of 0 will never reset. If not specified, the timeout value will be used.

Property Value
Parameter group: Inbound Circuit Breaker Policy Arguments
--in-cb-sequential-err

The number of consecutive errors before the circuit is opened.

Property Value
Parameter group: Inbound Circuit Breaker Policy Arguments
--in-cb-timeout

The interval in seconds until a retry attempt is made after the circuit is opened.

Property Value
Parameter group: Inbound Circuit Breaker Policy Arguments
--in-http-delay

Specify the base interval in milliseconds between retries for the inbound policy. Default: 1000.

Property Value
Parameter group: Inbound HTTP Retry Policy Arguments
--in-http-interval

Specify the maximum interval in milliseconds between retries for the inbound policy. Default: 10000.

Property Value
Parameter group: Inbound HTTP Retry Policy Arguments
--in-http-retries

Specify the max number of retries for the inbound policy. Default: 3.

Property Value
Parameter group: Inbound HTTP Retry Policy Arguments
--in-timeout

Specify the response timeout in seconds for the inbound policy. This spans between the point at which the entire request has been processed and when the response has been completely processed. This timeout includes all retries.

Property Value
Parameter group: Inbound Timeout Policy Arguments
--name -n

The name of the Dapr Component Resiliency Policy. A name must consist of lower case alphanumeric characters or '-', start with a letter, end with an alphanumeric character, cannot have '--', and must be less than 30 characters.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

Property Value
Default value: False
--out-cb-interval

The optional interval in seconds after which the error count resets to 0. An interval of 0 will never reset. If not specified, the timeout value will be used.

Property Value
Parameter group: Outbound Circuit Breaker Policy Arguments
--out-cb-sequential-err

The number of consecutive errors before the circuit is opened.

Property Value
Parameter group: Outbound Circuit Breaker Policy Arguments
--out-cb-timeout

The interval in seconds until a retry attempt is made after the circuit is opened.

Property Value
Parameter group: Outbound Circuit Breaker Policy Arguments
--out-http-delay

Specify the base interval in milliseconds between retries for the outbound policy. Default: 1000.

Property Value
Parameter group: Outbound HTTP Retry Policy Arguments
--out-http-interval

Specify the maximum interval in milliseconds between retries for the outbound policy. Default: 10000.

Property Value
Parameter group: Outbound HTTP Retry Policy Arguments
--out-http-retries

Specify the max number of retries for the outbound policy. Default: 3.

Property Value
Parameter group: Outbound HTTP Retry Policy Arguments
--out-timeout

Specify the response timeout in seconds for the outbound policy. This spans between the point at which the entire request has been processed and when the response has been completely processed. This timeout includes all retries.

Property Value
Parameter group: Outbound Timeout Policy Arguments
--subscription

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

Path to a .yaml file with the configuration of a dapr component resiliency policy. All other parameters will be ignored.

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.

--verbose

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

Property Value
Default value: False