Share via

az containerapp env premium-ingress

  • 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 premium-ingress command. Learn more about extensions.

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

Configure premium ingress settings for the environment.

Premium ingress settings apply to all applications in the environment. They allow moving the ingress instances to a workload profile and scaling them beyond the system defaults to enable high traffic workloads. Other settings include request idle timeouts, header count limits, and the termination grace period.

Commands

Name Description Type Status
az containerapp env premium-ingress add

Enable the premium ingress settings for the environment.

 Extension Preview
az containerapp env premium-ingress remove

Remove the ingress settings and restores the system to default values.

 Extension Preview
az containerapp env premium-ingress show

Show the premium ingress settings for the environment.

 Extension Preview
az containerapp env premium-ingress update

Update the premium ingress settings for the environment.

 Extension Preview

az containerapp env premium-ingress add

Preview

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

Enable the premium ingress settings for the environment.

Unspecified optional parameters will be cleared from any existing configuration.

az containerapp env premium-ingress add --max-replicas
                                        --min-replicas
                                        --resource-group
                                        --workload-profile-name
                                        [--header-count-limit]
                                        [--ids]
                                        [--name]
                                        [--request-idle-timeout]
                                        [--subscription]
                                        [--termination-grace-period]

Examples

Add the premium ingress settings for the environment.

az containerapp env premium-ingress add -g MyResourceGroup -n MyEnvironment -w WorkloadProfileName --min-replicas 2 --max-replicas 10

Required Parameters

--max-replicas

Maximum number of replicas to run. Default 10. The upper limit is the maximum cores available in the workload profile.

--min-replicas

Minimum number of replicas to run. Default 2, minimum 2.

--resource-group -g

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

--workload-profile-name -w

The workload profile to run ingress replicas on. This profile must not be shared with any container app or job.

Optional Parameters

--header-count-limit

Limit of http headers per request. Default 100, minimum 1.

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

The name of the managed environment.

--request-idle-timeout

Timeout in minutes for idle requests. Default 4, minimum 1.

--subscription

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

--termination-grace-period -t

Time in seconds to drain requests during ingress shutdown. Default 500, minimum 0, maximum 3600.

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 premium-ingress remove

Preview

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

Remove the ingress settings and restores the system to default values.

az containerapp env premium-ingress remove --resource-group
                                           [--ids]
                                           [--name]
                                           [--subscription]
                                           [--yes]

Examples

Reset the ingress settings for the environment to its default values

az containerapp env premium-ingress remove -g MyResourceGroup -n MyEnvironment

Required Parameters

--resource-group -g

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

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

The name of the managed environment.

--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 premium-ingress show

Preview

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

Show the premium ingress settings for the environment.

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

Examples

Show the premium ingress settings for the environment.

az containerapp env premium-ingress show -g MyResourceGroup -n MyEnvironment

Required Parameters

--resource-group -g

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

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

The name of the managed environment.

--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 premium-ingress update

Preview

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

Update the premium ingress settings for the environment.

az containerapp env premium-ingress update --resource-group
                                           [--header-count-limit]
                                           [--ids]
                                           [--max-replicas]
                                           [--min-replicas]
                                           [--name]
                                           [--request-idle-timeout]
                                           [--subscription]
                                           [--termination-grace-period]
                                           [--workload-profile-name]

Examples

Update the workload profile used for premium ingress.

az containerapp env premium-ingress update -g MyResourceGroup -n MyEnvironment -w WorkloadProfileName

Required Parameters

--resource-group -g

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

Optional Parameters

--header-count-limit

Limit of http headers per request. Default 100, minimum 1.

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

--max-replicas

Maximum number of replicas to run. Default 10. The upper limit is the maximum cores available in the workload profile.

--min-replicas

Minimum number of replicas to run. Default 2, minimum 2.

--name -n

The name of the managed environment.

--request-idle-timeout

Timeout in minutes for idle requests. Default 4, minimum 1.

--subscription

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

--termination-grace-period -t

Time in seconds to drain requests during ingress shutdown. Default 500, minimum 0, maximum 3600.

--workload-profile-name -w

The workload profile to run ingress replicas on. This profile must not be shared with any container app or job.

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.