Share via

az containerapp ingress

Commands to manage ingress and traffic-splitting.

Commands

Name Description Type Status
az containerapp ingress access-restriction

Commands to manage IP access restrictions.

 Core GA
az containerapp ingress access-restriction list

List IP access restrictions for a container app.

 Core GA
az containerapp ingress access-restriction remove

Remove IP access restrictions from a container app.

 Core GA
az containerapp ingress access-restriction set

Configure IP access restrictions for a container app.

 Core GA
az containerapp ingress cors

Commands to manage CORS policy for a container app.

 Core GA
az containerapp ingress cors disable

Disable CORS policy for a container app.

 Core GA
az containerapp ingress cors enable

Enable CORS policy for a container app.

 Core GA
az containerapp ingress cors show

Show CORS policy for a container app.

 Core GA
az containerapp ingress cors update

Update CORS policy for a container app.

 Core GA
az containerapp ingress disable

Disable ingress for a container app.

 Core GA
az containerapp ingress enable

Enable or update ingress for a container app.

 Core GA
az containerapp ingress show

Show details of a container app's ingress.

 Core GA
az containerapp ingress sticky-sessions

Commands to set Sticky session affinity for a container app.

 Core GA
az containerapp ingress sticky-sessions set

Configure Sticky session for a container app.

 Core GA
az containerapp ingress sticky-sessions show

Show the Affinity for a container app.

 Core GA
az containerapp ingress traffic

Commands to manage traffic-splitting.

 Core GA
az containerapp ingress traffic set

Configure traffic-splitting for a container app.

 Core GA
az containerapp ingress traffic show

Show traffic-splitting configuration for a container app.

 Core GA
az containerapp ingress update

Update ingress for a container app.

 Core GA

az containerapp ingress disable

Edit

Disable ingress for a container app.

az containerapp ingress disable [--ids]
                                [--name]
                                [--resource-group]
                                [--subscription]

Examples

Disable ingress for a container app.

az containerapp ingress disable -n my-containerapp -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.

--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 Containerapp. 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 32 characters.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

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

Edit

Enable or update ingress for a container app.

az containerapp ingress enable --type {external, internal}
                               [--allow-insecure {false, true}]
                               [--exposed-port]
                               [--ids]
                               [--name]
                               [--resource-group]
                               [--subscription]
                               [--target-port]
                               [--transport {auto, http, http2, tcp}]

Examples

Enable or update ingress for a container app.

az containerapp ingress enable -n my-containerapp -g MyResourceGroup \
    --type external --allow-insecure --target-port 80 --transport auto

Required Parameters

--type

The ingress type.

Property Value
Accepted values: external, internal

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--allow-insecure

Allow insecure connections for ingress traffic.

Property Value
Default value: False
Accepted values: false, true
--exposed-port

Additional exposed port. Only supported by tcp transport protocol. Must be unique per environment if the app ingress is external.

Property Value
Parameter group: Ingress Arguments
--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 Containerapp. 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 32 characters.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

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

The application port used for ingress traffic.

Property Value
Parameter group: Ingress Arguments
--transport

The transport protocol used for ingress traffic.

Property Value
Parameter group: Ingress Arguments
Default value: auto
Accepted values: auto, http, http2, tcp
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 ingress show

Edit

Show details of a container app's ingress.

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

Examples

Show the details of a container app's ingress.

az containerapp ingress show -n my-containerapp -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.

--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 Containerapp. 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 32 characters.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

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

Edit

Update ingress for a container app.

az containerapp ingress update [--allow-insecure {false, true}]
                               [--exposed-port]
                               [--ids]
                               [--name]
                               [--resource-group]
                               [--subscription]
                               [--target-port]
                               [--transport {auto, http, http2, tcp}]
                               [--type {external, internal}]

Examples

Update ingress for a container app.

az containerapp ingress update -n my-containerapp -g MyResourceGroup \
    --target-port 8080

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--allow-insecure

Allow insecure connections for ingress traffic.

Property Value
Default value: False
Accepted values: false, true
--exposed-port

Additional exposed port. Only supported by tcp transport protocol. Must be unique per environment if the app ingress is external.

Property Value
Parameter group: Ingress Arguments
--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 Containerapp. 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 32 characters.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

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

The application port used for ingress traffic.

Property Value
Parameter group: Ingress Arguments
--transport

The transport protocol used for ingress traffic.

Property Value
Parameter group: Ingress Arguments
Accepted values: auto, http, http2, tcp
--type

The ingress type.

Property Value
Accepted values: external, internal
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