az aks mesh

  • 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 Azure Service Mesh.

A group of commands to manage Azure Service Mesh in given cluster.

Commands

Name Description Type Status
az aks mesh disable

Disable Azure Service Mesh.

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

Disable Azure Service Mesh.

 Extension GA
az aks mesh disable-egress-gateway

Disable an Azure Service Mesh egress gateway.

 Extension GA
az aks mesh disable-ingress-gateway

Disable an Azure Service Mesh ingress gateway.

 Core GA
az aks mesh disable-ingress-gateway (aks-preview extension)

Disable an Azure Service Mesh ingress gateway.

 Extension GA
az aks mesh enable

Enable Azure Service Mesh.

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

Enable Azure Service Mesh.

 Extension GA
az aks mesh enable-egress-gateway

Enable an Azure Service Mesh egress gateway.

 Extension GA
az aks mesh enable-ingress-gateway

Enable an Azure Service Mesh ingress gateway.

 Core GA
az aks mesh enable-ingress-gateway (aks-preview extension)

Enable an Azure Service Mesh ingress gateway.

 Extension GA
az aks mesh get-revisions

Discover available Azure Service Mesh revisions and their compatibility.

 Core GA
az aks mesh get-revisions (aks-preview extension)

Discover available Azure Service Mesh revisions and their compatibility.

 Extension GA
az aks mesh get-upgrades

Discover available Azure Service Mesh upgrades.

 Core GA
az aks mesh get-upgrades (aks-preview extension)

Discover available Azure Service Mesh upgrades.

 Extension GA
az aks mesh upgrade

Commands to manage the upgrades for Azure Service Mesh.

 Core and Extension GA
az aks mesh upgrade complete

Complete Azure Service Mesh upgrade.

 Core GA
az aks mesh upgrade complete (aks-preview extension)

Complete Azure Service Mesh upgrade.

 Extension GA
az aks mesh upgrade rollback

Rollback Azure Service Mesh upgrade.

 Core GA
az aks mesh upgrade rollback (aks-preview extension)

Rollback Azure Service Mesh upgrade.

 Extension GA
az aks mesh upgrade start

Initiate Azure Service Mesh upgrade.

 Core GA
az aks mesh upgrade start (aks-preview extension)

Initiate Azure Service Mesh upgrade.

 Extension GA

az aks mesh disable

Edit

Disable Azure Service Mesh.

This command disables Azure Service Mesh in given cluster.

az aks mesh disable --name
                    --resource-group
                    [--no-wait]
                    [--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

--no-wait

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

default value: False
--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 mesh disable (aks-preview extension)

Disable Azure Service Mesh.

This command disables Azure Service Mesh in given cluster.

az aks mesh disable --name
                    --resource-group
                    [--no-wait]
                    [--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

--no-wait

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

default value: False
--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 mesh disable-egress-gateway

Disable an Azure Service Mesh egress gateway.

This command disables an Azure Service Mesh egress gateway in given cluster.

az aks mesh disable-egress-gateway --name
                                   --resource-group
                                   [--no-wait]
                                   [--yes]

Examples

Disable an egress gateway.

az aks mesh disable-egress-gateway --resource-group MyResourceGroup --name MyManagedCluster

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

--no-wait

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

default value: False
--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 mesh disable-ingress-gateway

Edit

Disable an Azure Service Mesh ingress gateway.

This command disables an Azure Service Mesh ingress gateway in given cluster.

az aks mesh disable-ingress-gateway --ingress-gateway-type {External, Internal}
                                    --name
                                    --resource-group
                                    [--no-wait]
                                    [--yes]

Examples

Disable an internal ingress gateway.

az aks mesh disable-ingress-gateway --resource-group MyResourceGroup --name MyManagedCluster --ingress-gateway-type Internal

Required Parameters

--ingress-gateway-type

Specify the type of ingress gateway.

Allowed values are "External" which is backed by a load balancer with an external IP address, "Internal" which is backed by a load balancer with an internal IP address.

accepted values: External, Internal
--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

--no-wait

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

default value: False
--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 mesh disable-ingress-gateway (aks-preview extension)

Disable an Azure Service Mesh ingress gateway.

This command disables an Azure Service Mesh ingress gateway in given cluster.

az aks mesh disable-ingress-gateway --ingress-gateway-type {External, Internal}
                                    --name
                                    --resource-group
                                    [--no-wait]
                                    [--yes]

Examples

Disable an internal ingress gateway.

az aks mesh disable-ingress-gateway --resource-group MyResourceGroup --name MyManagedCluster --ingress-gateway-type Internal

Required Parameters

--ingress-gateway-type

Specify the type of ingress gateway.

Allowed values are "External" which is backed by a load balancer with an external IP address, "Internal" which is backed by a load balancer with an internal IP address.

accepted values: External, Internal
--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

--no-wait

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

default value: False
--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 mesh enable

Edit

Enable Azure Service Mesh.

This command enables Azure Service Mesh in given cluster.

az aks mesh enable --name
                   --resource-group
                   [--ca-cert-object-name]
                   [--ca-key-object-name]
                   [--cert-chain-object-name]
                   [--key-vault-id]
                   [--no-wait]
                   [--revision]
                   [--root-cert-object-name]

Examples

Enable Azure Service Mesh with selfsigned CA.

az aks mesh enable --resource-group MyResourceGroup --name MyManagedCluster

Enable Azure Service Mesh with plugin CA.

az aks mesh enable --resource-group MyResourceGroup --name MyManagedCluster --key-vault-id /subscriptions/00000/resourceGroups/foo/providers/Microsoft.KeyVault/vaults/foo --ca-cert-object-name my-ca-cert --ca-key-object-name my-ca-key --cert-chain-object-name my-cert-chain --root-cert-object-name my-root-cert

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

--ca-cert-object-name

Intermediate cert object name in the Azure Keyvault.

--ca-key-object-name

Intermediate key object name in the Azure Keyvault.

--cert-chain-object-name

Cert chain object name in the Azure Keyvault.

--key-vault-id

The Azure Keyvault id with plugin CA info.

--no-wait

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

default value: False
--revision

Azure Service Mesh revision to install.

--root-cert-object-name

Root cert object name in the Azure Keyvault.

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

Enable Azure Service Mesh.

This command enables Azure Service Mesh in given cluster.

az aks mesh enable --name
                   --resource-group
                   [--ca-cert-object-name]
                   [--ca-key-object-name]
                   [--cert-chain-object-name]
                   [--key-vault-id]
                   [--no-wait]
                   [--revision]
                   [--root-cert-object-name]

Examples

Enable Azure Service Mesh with selfsigned CA.

az aks mesh enable --resource-group MyResourceGroup --name MyManagedCluster

Enable Azure Service Mesh with plugin CA.

az aks mesh enable --resource-group MyResourceGroup --name MyManagedCluster --key-vault-id /subscriptions/8ecadfc9-d1a3-4ea4-b844-0d9f87e4d7c8/resourceGroups/foo/providers/Microsoft.KeyVault/vaults/foo --ca-cert-object-name my-ca-cert --ca-key-object-name my-ca-key --cert-chain-object-name my-cert-chain --root-cert-object-name my-root-cert

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

--ca-cert-object-name

Intermediate cert object name in the Azure Keyvault.

--ca-key-object-name

Intermediate key object name in the Azure Keyvault.

--cert-chain-object-name

Cert chain object name in the Azure Keyvault.

--key-vault-id

The Azure Keyvault id with plugin CA info.

--no-wait

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

default value: False
--revision

Azure Service Mesh revision to install.

--root-cert-object-name

Root cert object name in the Azure Keyvault.

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 mesh enable-egress-gateway

Enable an Azure Service Mesh egress gateway.

This command enables an Azure Service Mesh egress gateway in given cluster.

az aks mesh enable-egress-gateway --name
                                  --resource-group
                                  [--no-wait]

Examples

Enable an egress gateway.

az aks mesh enable-egress-gateway --resource-group MyResourceGroup --name MyManagedCluster

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

--no-wait

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

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

Edit

Enable an Azure Service Mesh ingress gateway.

This command enables an Azure Service Mesh ingress gateway in given cluster.

az aks mesh enable-ingress-gateway --ingress-gateway-type {External, Internal}
                                   --name
                                   --resource-group
                                   [--no-wait]

Examples

Enable an internal ingress gateway.

az aks mesh enable-ingress-gateway --resource-group MyResourceGroup --name MyManagedCluster --ingress-gateway-type Internal

Required Parameters

--ingress-gateway-type

Specify the type of ingress gateway.

Allowed values are "External" which is backed by a load balancer with an external IP address; "Internal" which is backed by a load balancer with an internal IP address.

accepted values: External, Internal
--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

--no-wait

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

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 mesh enable-ingress-gateway (aks-preview extension)

Enable an Azure Service Mesh ingress gateway.

This command enables an Azure Service Mesh ingress gateway in given cluster.

az aks mesh enable-ingress-gateway --ingress-gateway-type {External, Internal}
                                   --name
                                   --resource-group
                                   [--no-wait]

Examples

Enable an internal ingress gateway.

az aks mesh enable-ingress-gateway --resource-group MyResourceGroup --name MyManagedCluster --ingress-gateway-type Internal

Required Parameters

--ingress-gateway-type

Specify the type of ingress gateway.

Allowed values are "External" which is backed by a load balancer with an external IP address; "Internal" which is backed by a load balancer with an internal IP address.

accepted values: External, Internal
--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

--no-wait

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

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 mesh get-revisions

Edit

Discover available Azure Service Mesh revisions and their compatibility.

This command lists available Azure Service Mesh revisions and their compatibility information for the given location.

az aks mesh get-revisions --location

Examples

Discover Azure Service Mesh revisions.

az aks mesh get-revisions --location westus2

Required Parameters

--location -l

Location in which to discover available Azure Service Mesh revisions.

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 mesh get-revisions (aks-preview extension)

Discover available Azure Service Mesh revisions and their compatibility.

This command discovers available Azure Service Mesh revisions and their compatibility information for the given location.

az aks mesh get-revisions --location

Examples

Discover Azure Service Mesh revisions.

az aks mesh get-revisions --location westus2

Required Parameters

--location -l

Location in which to discover available Azure Service Mesh revisions.

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 mesh get-upgrades

Edit

Discover available Azure Service Mesh upgrades.

This command lists available Azure Service Mesh upgrades for the mesh revision installed on the cluster.

az aks mesh get-upgrades --name
                         --resource-group

Examples

Discover Azure Service Mesh upgrades.

az aks mesh get-upgrades --resource-group MyResourceGroup --name MyManagedCluster

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

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 mesh get-upgrades (aks-preview extension)

Discover available Azure Service Mesh upgrades.

This command discovers available Azure Service Mesh upgrades for the mesh revision installed on the cluster.

az aks mesh get-upgrades --name
                         --resource-group

Examples

Discover Azure Service Mesh upgrades.

az aks mesh get-upgrades --resource-group MyResourceGroup --name MyManagedCluster

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

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.