Share via

az aks approuting

  • 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 App Routing aadon.

A group of commands to manage App Routing in given cluster.

Commands

Name Description Type Status
az aks approuting disable

Disable App Routing addon.

 Core GA
az aks approuting disable (aks-preview extension)

Disable App Routing addon.

 Extension GA
az aks approuting enable

Enable App Routing.

 Core GA
az aks approuting enable (aks-preview extension)

Enable App Routing.

 Extension GA
az aks approuting update

Update App Routing addon.

 Core GA
az aks approuting update (aks-preview extension)

Update App Routing addon.

 Extension GA
az aks approuting zone

Commands to manage App Routing DNS Zones.

 Core and Extension GA
az aks approuting zone add

Add DNS Zone(s) to App Routing.

 Core GA
az aks approuting zone add (aks-preview extension)

Add DNS Zone(s) to App Routing.

 Extension GA
az aks approuting zone delete

Delete DNS Zone(s) from App Routing.

 Core GA
az aks approuting zone delete (aks-preview extension)

Delete DNS Zone(s) from App Routing.

 Extension GA
az aks approuting zone list

List DNS Zone IDs in App Routing.

 Core GA
az aks approuting zone list (aks-preview extension)

List DNS Zone IDs in App Routing.

 Extension GA
az aks approuting zone update

Replace DNS Zone(s) in App Routing.

 Core GA
az aks approuting zone update (aks-preview extension)

Replace DNS Zone(s) in App Routing.

 Extension GA

az aks approuting disable

Edit

Disable App Routing addon.

This command disables App Routing in given cluster.

az aks approuting disable --name
                          --resource-group
                          [--yes]

Required Parameters

--name -n

Name of the managed cluster.

--resource-group -g

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

Optional Parameters

--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 aks approuting disable (aks-preview extension)

Disable App Routing addon.

This command disables App Routing in given cluster.

az aks approuting disable --name
                          --resource-group
                          [--yes]

Required Parameters

--name -n

Name of the managed cluster.

--resource-group -g

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

Optional Parameters

--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 aks approuting enable

Edit

Enable App Routing.

This command enables App Routing in given cluster.

az aks approuting enable --name
                         --resource-group
                         [--attach-kv]
                         [--enable-kv]

Required Parameters

--name -n

Name of the managed cluster.

--resource-group -g

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

Optional Parameters

--attach-kv

Attach a keyvault id to access secrets and certificates.

This optional flag attaches a keyvault id to access secrets and certificates.

--enable-kv

Enable the keyvault secrets provider.

This optional flag enables the keyvault-secrets-provider addon in given cluster. This is required for most App Routing use-cases.

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 aks approuting enable (aks-preview extension)

Enable App Routing.

This command enables App Routing in given cluster.

az aks approuting enable --name
                         --resource-group
                         [--attach-kv]
                         [--enable-kv]
                         [--nginx {AnnotationControlled, External, Internal, None}]

Required Parameters

--name -n

Name of the managed cluster.

--resource-group -g

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

Optional Parameters

--attach-kv

Attach a keyvault id to access secrets and certificates.

This optional flag attaches a keyvault id to access secrets and certificates.

--enable-kv

Enable the keyvault secrets provider.

This optional flag enables the keyvault-secrets-provider addon in given cluster. This is required for most App Routing use-cases.

Default value: False
--nginx

Configure default NginxIngressController resource.

Configure default nginx ingress controller type. Valid values are annotationControlled (default behavior), external, internal, or none.

Accepted values: AnnotationControlled, External, Internal, None
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 aks approuting update

Edit

Update App Routing addon.

This command is used to update keyvault id in App Routing addon.

az aks approuting update --name
                         --resource-group
                         [--attach-kv]
                         [--enable-kv]

Required Parameters

--name -n

Name of the managed cluster.

--resource-group -g

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

Optional Parameters

--attach-kv

Attach a keyvault id to access secrets and certificates.

This optional flag attaches a keyvault id to access secrets and certificates.

--enable-kv

Enable the keyvault secrets provider addon.

This optional flag enables the keyvault-secrets-provider addon in given cluster. This is required for most App Routing use-cases.

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 aks approuting update (aks-preview extension)

Update App Routing addon.

This command is used to update keyvault id in App Routing addon.

az aks approuting update --name
                         --resource-group
                         [--attach-kv]
                         [--enable-kv]
                         [--nginx {AnnotationControlled, External, Internal, None}]

Required Parameters

--name -n

Name of the managed cluster.

--resource-group -g

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

Optional Parameters

--attach-kv

Attach a keyvault id to access secrets and certificates.

This optional flag attaches a keyvault id to access secrets and certificates.

--enable-kv

Enable the keyvault secrets provider addon.

This optional flag enables the keyvault-secrets-provider addon in given cluster. This is required for most App Routing use-cases.

Default value: False
--nginx

Configure default NginxIngressController resource.

Configure default nginx ingress controller type. Valid values are annotationControlled (default behavior), external, internal, or none.

Accepted values: AnnotationControlled, External, Internal, None
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.