az aks connection update

Command group 'aks connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a aks connection.

Commands

Name	Description	Type	Status
az aks connection update app-insights	Update a aks to app-insights connection.	Core	Preview
az aks connection update appconfig	Update a aks to appconfig connection.	Core	Preview
az aks connection update confluent-cloud	Update a aks to confluent-cloud connection.	Core	Preview
az aks connection update cosmos-cassandra	Update a aks to cosmos-cassandra connection.	Core	Preview
az aks connection update cosmos-gremlin	Update a aks to cosmos-gremlin connection.	Core	Preview
az aks connection update cosmos-mongo	Update a aks to cosmos-mongo connection.	Core	Preview
az aks connection update cosmos-sql	Update a aks to cosmos-sql connection.	Core	Preview
az aks connection update cosmos-table	Update a aks to cosmos-table connection.	Core	Preview
az aks connection update eventhub	Update a aks to eventhub connection.	Core	Preview
az aks connection update keyvault	Update a aks to keyvault connection.	Core	Preview
az aks connection update mysql	Update a aks to mysql connection.	Core	Preview and Deprecated
az aks connection update mysql-flexible	Update a aks to mysql-flexible connection.	Core	Preview
az aks connection update postgres	Update a aks to postgres connection.	Core	Preview and Deprecated
az aks connection update postgres-flexible	Update a aks to postgres-flexible connection.	Core	Preview
az aks connection update redis	Update a aks to redis connection.	Core	Preview
az aks connection update redis-enterprise	Update a aks to redis-enterprise connection.	Core	Preview
az aks connection update servicebus	Update a aks to servicebus connection.	Core	Preview
az aks connection update signalr	Update a aks to signalr connection.	Core	Preview
az aks connection update sql	Update a aks to sql connection.	Core	Preview
az aks connection update storage-blob	Update a aks to storage-blob connection.	Core	Preview
az aks connection update storage-file	Update a aks to storage-file connection.	Core	Preview
az aks connection update storage-queue	Update a aks to storage-queue connection.	Core	Preview
az aks connection update storage-table	Update a aks to storage-table connection.	Core	Preview
az aks connection update webpubsub	Update a aks to webpubsub connection.	Core	Preview

az aks connection update app-insights

Preview

Command group 'aks connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a aks to app-insights connection.

az aks connection update app-insights [--appconfig-id]
                                      [--client-type {dotnet, dotnet-internal, go, java, nodejs, none, python}]
                                      [--connection]
                                      [--customized-keys]
                                      [--enable-csi {false, true}]
                                      [--id]
                                      [--kube-namespace]
                                      [--name]
                                      [--no-wait]
                                      [--opt-out {auth, configinfo, publicnetwork}]
                                      [--resource-group]
                                      [--secret]

Examples

Update the client type of a connection with resource name

az aks connection update app-insights -g ClusterRG -n MyCluster --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az aks connection update app-insights --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the aks.

accepted values: dotnet, dotnet-internal, go, java, nodejs, none, python

--connection

Name of the aks connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--enable-csi

Use keyvault as a secrets store via a CSI volume. If specified, AuthType Arguments are not needed.

accepted values: false, true

default value: False

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--kube-namespace

The kubernetes namespace where the connection information will be saved into (as kubernetes secret).

default value: default

--name -n

Name of the managed cluster. Required if '--id' is not specified.None.

--no-wait

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

default value: False

--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

accepted values: auth, configinfo, publicnetwork

--resource-group -g

The resource group which contains the managed cluster. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

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 connection update appconfig

Preview

Command group 'aks connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a aks to appconfig connection.

az aks connection update appconfig [--appconfig-id]
                                   [--client-type {dotnet, dotnet-internal, java, nodejs, none, python}]
                                   [--connection]
                                   [--customized-keys]
                                   [--enable-csi {false, true}]
                                   [--id]
                                   [--kube-namespace]
                                   [--name]
                                   [--no-wait]
                                   [--opt-out {auth, configinfo, publicnetwork}]
                                   [--private-endpoint {false, true}]
                                   [--resource-group]
                                   [--secret]
                                   [--service-principal]
                                   [--workload-identity]

Examples

Update the client type of a connection with resource name

az aks connection update appconfig -g ClusterRG -n MyCluster --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az aks connection update appconfig --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the aks.

accepted values: dotnet, dotnet-internal, java, nodejs, none, python

--connection

Name of the aks connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--enable-csi

Use keyvault as a secrets store via a CSI volume. If specified, AuthType Arguments are not needed.

accepted values: false, true

default value: False

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--kube-namespace

The kubernetes namespace where the connection information will be saved into (as kubernetes secret).

default value: default

--name -n

Name of the managed cluster. Required if '--id' is not specified.None.

--no-wait

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

default value: False

--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

accepted values: auth, configinfo, publicnetwork

--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true

--resource-group -g

The resource group which contains the managed cluster. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--workload-identity

The user-assigned managed identity used to create workload identity federation.

Usage: --workload-identity

user-identity-resource-id: Required. The resource id of the user assigned identity. Please DO NOT use AKS control plane identity and kubelet identity which is not supported by federated identity credential.

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 connection update confluent-cloud

Preview

Command group 'aks connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a aks to confluent-cloud connection.

az aks connection update confluent-cloud --connection
                                         [--appconfig-id]
                                         [--bootstrap-server]
                                         [--client-type {dotnet, dotnet-internal, go, java, none, python, springBoot}]
                                         [--customized-keys]
                                         [--kafka-key]
                                         [--kafka-secret]
                                         [--name]
                                         [--no-wait]
                                         [--opt-out {auth, configinfo, publicnetwork}]
                                         [--resource-group]
                                         [--schema-key]
                                         [--schema-registry]
                                         [--schema-secret]
                                         [--source-id]

Examples

Update the client-type of a bootstrap server connection

az aks connection update confluent-cloud -g ClusterRG -n MyCluster --connection MyConnection --client python

Update the auth configurations of a bootstrap server connection

az aks connection update confluent-cloud -g ClusterRG -n MyCluster --connection MyConnection --bootstrap-server xxx.eastus.azure.confluent.cloud:9092 --kafka-key Name --kafka-secret Secret

Update the client-type of a schema registry connection

az aks connection update confluent-cloud -g ClusterRG -n MyCluster --connection MyConnection_schema --client python

Update the auth configurations of a schema registry connection

az aks connection update confluent-cloud -g ClusterRG -n MyCluster --connection MyConnection_schema --schema-registry https://xxx.eastus.azure.confluent.cloud --schema-key Name --schema-secret Secret

Required Parameters

--connection

Name of the connection.

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

--bootstrap-server

Kafka bootstrap server url.

--client-type

The client type used on the aks.

accepted values: dotnet, dotnet-internal, go, java, none, python, springBoot

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--kafka-key

Kafka API-Key (key).

--kafka-secret

Kafka API-Key (secret).

--name -n

Name of the managed cluster. Required if '--source-id' is not specified.None.

--no-wait

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

default value: False

--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

accepted values: auth, configinfo, publicnetwork

--resource-group -g

The resource group which contains the managed cluster. Required if '--source-id' is not specified.None.

--schema-key

Schema registry API-Key (key).

--schema-registry

Schema registry url.

--schema-secret

Schema registry API-Key (secret).

--source-id

The resource id of a aks. Required if ['--resource-group', '--name'] are not specified.

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 connection update cosmos-cassandra

Preview

Command group 'aks connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a aks to cosmos-cassandra connection.

az aks connection update cosmos-cassandra [--appconfig-id]
                                          [--client-type {dotnet, dotnet-internal, go, java, nodejs, none, python, springBoot}]
                                          [--connection]
                                          [--customized-keys]
                                          [--enable-csi {false, true}]
                                          [--id]
                                          [--kube-namespace]
                                          [--name]
                                          [--no-wait]
                                          [--opt-out {auth, configinfo, publicnetwork}]
                                          [--private-endpoint {false, true}]
                                          [--resource-group]
                                          [--secret]
                                          [--service-endpoint {false, true}]
                                          [--service-principal]
                                          [--workload-identity]

Examples

Update the client type of a connection with resource name

az aks connection update cosmos-cassandra -g ClusterRG -n MyCluster --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az aks connection update cosmos-cassandra --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the aks.

accepted values: dotnet, dotnet-internal, go, java, nodejs, none, python, springBoot

--connection

Name of the aks connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--enable-csi

Use keyvault as a secrets store via a CSI volume. If specified, AuthType Arguments are not needed.

accepted values: false, true

default value: False

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--kube-namespace

The kubernetes namespace where the connection information will be saved into (as kubernetes secret).

default value: default

--name -n

Name of the managed cluster. Required if '--id' is not specified.None.

--no-wait

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

default value: False

--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

accepted values: auth, configinfo, publicnetwork

--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true

--resource-group -g

The resource group which contains the managed cluster. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service-endpoint

Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.

accepted values: false, true

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--workload-identity

The user-assigned managed identity used to create workload identity federation.

Usage: --workload-identity

user-identity-resource-id: Required. The resource id of the user assigned identity. Please DO NOT use AKS control plane identity and kubelet identity which is not supported by federated identity credential.

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 connection update cosmos-gremlin

Preview

Command group 'aks connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a aks to cosmos-gremlin connection.

az aks connection update cosmos-gremlin [--appconfig-id]
                                        [--client-type {dotnet, dotnet-internal, java, nodejs, none, php, python}]
                                        [--connection]
                                        [--customized-keys]
                                        [--enable-csi {false, true}]
                                        [--id]
                                        [--kube-namespace]
                                        [--name]
                                        [--no-wait]
                                        [--opt-out {auth, configinfo, publicnetwork}]
                                        [--private-endpoint {false, true}]
                                        [--resource-group]
                                        [--secret]
                                        [--service-endpoint {false, true}]
                                        [--service-principal]
                                        [--workload-identity]

Examples

Update the client type of a connection with resource name

az aks connection update cosmos-gremlin -g ClusterRG -n MyCluster --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az aks connection update cosmos-gremlin --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the aks.

accepted values: dotnet, dotnet-internal, java, nodejs, none, php, python

--connection

Name of the aks connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--enable-csi

Use keyvault as a secrets store via a CSI volume. If specified, AuthType Arguments are not needed.

accepted values: false, true

default value: False

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--kube-namespace

The kubernetes namespace where the connection information will be saved into (as kubernetes secret).

default value: default

--name -n

Name of the managed cluster. Required if '--id' is not specified.None.

--no-wait

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

default value: False

--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

accepted values: auth, configinfo, publicnetwork

--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true

--resource-group -g

The resource group which contains the managed cluster. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service-endpoint

Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.

accepted values: false, true

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--workload-identity

The user-assigned managed identity used to create workload identity federation.

Usage: --workload-identity

user-identity-resource-id: Required. The resource id of the user assigned identity. Please DO NOT use AKS control plane identity and kubelet identity which is not supported by federated identity credential.

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 connection update cosmos-mongo

Preview

Command group 'aks connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a aks to cosmos-mongo connection.

az aks connection update cosmos-mongo [--appconfig-id]
                                      [--client-type {dotnet, dotnet-internal, go, java, nodejs, none, springBoot}]
                                      [--connection]
                                      [--customized-keys]
                                      [--enable-csi {false, true}]
                                      [--id]
                                      [--kube-namespace]
                                      [--name]
                                      [--no-wait]
                                      [--opt-out {auth, configinfo, publicnetwork}]
                                      [--private-endpoint {false, true}]
                                      [--resource-group]
                                      [--secret]
                                      [--service-endpoint {false, true}]
                                      [--service-principal]
                                      [--workload-identity]

Examples

Update the client type of a connection with resource name

az aks connection update cosmos-mongo -g ClusterRG -n MyCluster --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az aks connection update cosmos-mongo --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the aks.

accepted values: dotnet, dotnet-internal, go, java, nodejs, none, springBoot

--connection

Name of the aks connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--enable-csi

Use keyvault as a secrets store via a CSI volume. If specified, AuthType Arguments are not needed.

accepted values: false, true

default value: False

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--kube-namespace

The kubernetes namespace where the connection information will be saved into (as kubernetes secret).

default value: default

--name -n

Name of the managed cluster. Required if '--id' is not specified.None.

--no-wait

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

default value: False

--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

accepted values: auth, configinfo, publicnetwork

--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true

--resource-group -g

The resource group which contains the managed cluster. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service-endpoint

Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.

accepted values: false, true

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--workload-identity

The user-assigned managed identity used to create workload identity federation.

Usage: --workload-identity

user-identity-resource-id: Required. The resource id of the user assigned identity. Please DO NOT use AKS control plane identity and kubelet identity which is not supported by federated identity credential.

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 connection update cosmos-sql

Preview

Command group 'aks connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a aks to cosmos-sql connection.

az aks connection update cosmos-sql [--appconfig-id]
                                    [--client-type {dotnet, dotnet-internal, java, nodejs, none, python, springBoot}]
                                    [--connection]
                                    [--customized-keys]
                                    [--enable-csi {false, true}]
                                    [--id]
                                    [--kube-namespace]
                                    [--name]
                                    [--no-wait]
                                    [--opt-out {auth, configinfo, publicnetwork}]
                                    [--private-endpoint {false, true}]
                                    [--resource-group]
                                    [--secret]
                                    [--service-endpoint {false, true}]
                                    [--service-principal]
                                    [--workload-identity]

Examples

Update the client type of a connection with resource name

az aks connection update cosmos-sql -g ClusterRG -n MyCluster --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az aks connection update cosmos-sql --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the aks.

accepted values: dotnet, dotnet-internal, java, nodejs, none, python, springBoot

--connection

Name of the aks connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--enable-csi

Use keyvault as a secrets store via a CSI volume. If specified, AuthType Arguments are not needed.

accepted values: false, true

default value: False

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--kube-namespace

The kubernetes namespace where the connection information will be saved into (as kubernetes secret).

default value: default

--name -n

Name of the managed cluster. Required if '--id' is not specified.None.

--no-wait

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

default value: False

--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

accepted values: auth, configinfo, publicnetwork

--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true

--resource-group -g

The resource group which contains the managed cluster. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service-endpoint

Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.

accepted values: false, true

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--workload-identity

The user-assigned managed identity used to create workload identity federation.

Usage: --workload-identity

user-identity-resource-id: Required. The resource id of the user assigned identity. Please DO NOT use AKS control plane identity and kubelet identity which is not supported by federated identity credential.

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 connection update cosmos-table

Preview

Command group 'aks connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a aks to cosmos-table connection.

az aks connection update cosmos-table [--appconfig-id]
                                      [--client-type {dotnet, dotnet-internal, java, nodejs, none, python, springBoot}]
                                      [--connection]
                                      [--customized-keys]
                                      [--enable-csi {false, true}]
                                      [--id]
                                      [--kube-namespace]
                                      [--name]
                                      [--no-wait]
                                      [--opt-out {auth, configinfo, publicnetwork}]
                                      [--private-endpoint {false, true}]
                                      [--resource-group]
                                      [--secret]
                                      [--service-endpoint {false, true}]
                                      [--service-principal]
                                      [--workload-identity]

Examples

Update the client type of a connection with resource name

az aks connection update cosmos-table -g ClusterRG -n MyCluster --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az aks connection update cosmos-table --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the aks.

accepted values: dotnet, dotnet-internal, java, nodejs, none, python, springBoot

--connection

Name of the aks connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--enable-csi

Use keyvault as a secrets store via a CSI volume. If specified, AuthType Arguments are not needed.

accepted values: false, true

default value: False

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--kube-namespace

The kubernetes namespace where the connection information will be saved into (as kubernetes secret).

default value: default

--name -n

Name of the managed cluster. Required if '--id' is not specified.None.

--no-wait

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

default value: False

--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

accepted values: auth, configinfo, publicnetwork

--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true

--resource-group -g

The resource group which contains the managed cluster. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service-endpoint

Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.

accepted values: false, true

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--workload-identity

The user-assigned managed identity used to create workload identity federation.

Usage: --workload-identity

user-identity-resource-id: Required. The resource id of the user assigned identity. Please DO NOT use AKS control plane identity and kubelet identity which is not supported by federated identity credential.

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 connection update eventhub

Preview

Command group 'aks connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a aks to eventhub connection.

az aks connection update eventhub [--appconfig-id]
                                  [--client-type {dotnet, dotnet-internal, go, java, kafka-springBoot, nodejs, none, python, springBoot}]
                                  [--connection]
                                  [--customized-keys]
                                  [--enable-csi {false, true}]
                                  [--id]
                                  [--kube-namespace]
                                  [--name]
                                  [--no-wait]
                                  [--opt-out {auth, configinfo, publicnetwork}]
                                  [--private-endpoint {false, true}]
                                  [--resource-group]
                                  [--secret]
                                  [--service-endpoint {false, true}]
                                  [--service-principal]
                                  [--workload-identity]

Examples

Update the client type of a connection with resource name

az aks connection update eventhub -g ClusterRG -n MyCluster --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az aks connection update eventhub --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the aks.

accepted values: dotnet, dotnet-internal, go, java, kafka-springBoot, nodejs, none, python, springBoot

--connection

Name of the aks connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--enable-csi

Use keyvault as a secrets store via a CSI volume. If specified, AuthType Arguments are not needed.

accepted values: false, true

default value: False

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--kube-namespace

The kubernetes namespace where the connection information will be saved into (as kubernetes secret).

default value: default

--name -n

Name of the managed cluster. Required if '--id' is not specified.None.

--no-wait

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

default value: False

--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

accepted values: auth, configinfo, publicnetwork

--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true

--resource-group -g

The resource group which contains the managed cluster. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service-endpoint

Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.

accepted values: false, true

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--workload-identity

The user-assigned managed identity used to create workload identity federation.

Usage: --workload-identity

user-identity-resource-id: Required. The resource id of the user assigned identity. Please DO NOT use AKS control plane identity and kubelet identity which is not supported by federated identity credential.

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 connection update keyvault

Preview

Command group 'aks connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a aks to keyvault connection.

az aks connection update keyvault [--appconfig-id]
                                  [--client-type {dotnet, dotnet-internal, java, nodejs, none, python, springBoot}]
                                  [--connection]
                                  [--customized-keys]
                                  [--enable-csi {false, true}]
                                  [--id]
                                  [--kube-namespace]
                                  [--name]
                                  [--no-wait]
                                  [--opt-out {auth, configinfo, publicnetwork}]
                                  [--private-endpoint {false, true}]
                                  [--resource-group]
                                  [--service-endpoint {false, true}]
                                  [--service-principal]
                                  [--workload-identity]

Examples

Update the client type of a connection with resource name

az aks connection update keyvault -g ClusterRG -n MyCluster --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az aks connection update keyvault --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the aks.

accepted values: dotnet, dotnet-internal, java, nodejs, none, python, springBoot

--connection

Name of the aks connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--enable-csi

Use keyvault as a secrets store via a CSI volume. If specified, AuthType Arguments are not needed.

accepted values: false, true

default value: False

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--kube-namespace

The kubernetes namespace where the connection information will be saved into (as kubernetes secret).

default value: default

--name -n

Name of the managed cluster. Required if '--id' is not specified.None.

--no-wait

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

default value: False

--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

accepted values: auth, configinfo, publicnetwork

--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true

--resource-group -g

The resource group which contains the managed cluster. Required if '--id' is not specified.None.

--service-endpoint

Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.

accepted values: false, true

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--workload-identity

The user-assigned managed identity used to create workload identity federation.

Usage: --workload-identity

user-identity-resource-id: Required. The resource id of the user assigned identity. Please DO NOT use AKS control plane identity and kubelet identity which is not supported by federated identity credential.

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 connection update mysql

Preview Deprecated

Command group 'aks connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

This command has been deprecated and will be removed in a future release.

Update a aks to mysql connection.

az aks connection update mysql [--appconfig-id]
                               [--client-type {django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot}]
                               [--connection]
                               [--customized-keys]
                               [--enable-csi {false, true}]
                               [--id]
                               [--kube-namespace]
                               [--name]
                               [--no-wait]
                               [--opt-out {auth, configinfo, publicnetwork}]
                               [--private-endpoint {false, true}]
                               [--resource-group]
                               [--secret]
                               [--service-endpoint {false, true}]

Examples

Update the client type of a connection with resource name

az aks connection update mysql -g ClusterRG -n MyCluster --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az aks connection update mysql --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the aks.

accepted values: django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot

--connection

Name of the aks connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--enable-csi

Use keyvault as a secrets store via a CSI volume. If specified, AuthType Arguments are not needed.

accepted values: false, true

default value: False

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--kube-namespace

The kubernetes namespace where the connection information will be saved into (as kubernetes secret).

default value: default

--name -n

Name of the managed cluster. Required if '--id' is not specified.None.

--no-wait

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

default value: False

--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

accepted values: auth, configinfo, publicnetwork

--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true

--resource-group -g

The resource group which contains the managed cluster. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret name=XX secret=XX --secret name=XX secret-name=XX

name : Required. Username or account name for secret auth. secret : One of <secret, secret-uri, secret-name> is required. Password or account key for secret auth. secret-name : One of <secret, secret-uri, secret-name> is required. Keyvault secret name which stores password. It's for AKS only.

--service-endpoint

Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.

accepted values: false, true

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 connection update mysql-flexible

Preview

Command group 'aks connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a aks to mysql-flexible connection.

az aks connection update mysql-flexible [--appconfig-id]
                                        [--client-type {django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot}]
                                        [--connection]
                                        [--customized-keys]
                                        [--enable-csi {false, true}]
                                        [--id]
                                        [--kube-namespace]
                                        [--name]
                                        [--no-wait]
                                        [--opt-out {auth, configinfo, publicnetwork}]
                                        [--resource-group]
                                        [--secret]

Examples

Update the client type of a connection with resource name

az aks connection update mysql-flexible -g ClusterRG -n MyCluster --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az aks connection update mysql-flexible --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the aks.

accepted values: django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot

--connection

Name of the aks connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--enable-csi

Use keyvault as a secrets store via a CSI volume. If specified, AuthType Arguments are not needed.

accepted values: false, true

default value: False

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--kube-namespace

The kubernetes namespace where the connection information will be saved into (as kubernetes secret).

default value: default

--name -n

Name of the managed cluster. Required if '--id' is not specified.None.

--no-wait

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

default value: False

--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

accepted values: auth, configinfo, publicnetwork

--resource-group -g

The resource group which contains the managed cluster. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret name=XX secret=XX --secret name=XX secret-name=XX

name : Required. Username or account name for secret auth. secret : One of <secret, secret-uri, secret-name> is required. Password or account key for secret auth. secret-name : One of <secret, secret-uri, secret-name> is required. Keyvault secret name which stores password. It's for AKS only.

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 connection update postgres

Preview Deprecated

Command group 'aks connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

This command has been deprecated and will be removed in a future release.

Update a aks to postgres connection.

az aks connection update postgres [--appconfig-id]
                                  [--client-type {django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot}]
                                  [--connection]
                                  [--customized-keys]
                                  [--enable-csi {false, true}]
                                  [--id]
                                  [--kube-namespace]
                                  [--name]
                                  [--no-wait]
                                  [--opt-out {auth, configinfo, publicnetwork}]
                                  [--private-endpoint {false, true}]
                                  [--resource-group]
                                  [--secret]
                                  [--service-endpoint {false, true}]

Examples

Update the client type of a connection with resource name

az aks connection update postgres -g ClusterRG -n MyCluster --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az aks connection update postgres --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the aks.

accepted values: django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot

--connection

Name of the aks connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--enable-csi

Use keyvault as a secrets store via a CSI volume. If specified, AuthType Arguments are not needed.

accepted values: false, true

default value: False

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--kube-namespace

The kubernetes namespace where the connection information will be saved into (as kubernetes secret).

default value: default

--name -n

Name of the managed cluster. Required if '--id' is not specified.None.

--no-wait

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

default value: False

--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

accepted values: auth, configinfo, publicnetwork

--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true

--resource-group -g

The resource group which contains the managed cluster. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret name=XX secret=XX --secret name=XX secret-name=XX

name : Required. Username or account name for secret auth. secret : One of <secret, secret-uri, secret-name> is required. Password or account key for secret auth. secret-name : One of <secret, secret-uri, secret-name> is required. Keyvault secret name which stores password. It's for AKS only.

--service-endpoint

Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.

accepted values: false, true

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 connection update postgres-flexible

Preview

Command group 'aks connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a aks to postgres-flexible connection.

az aks connection update postgres-flexible [--appconfig-id]
                                           [--client-type {django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot}]
                                           [--connection]
                                           [--customized-keys]
                                           [--enable-csi {false, true}]
                                           [--id]
                                           [--kube-namespace]
                                           [--name]
                                           [--no-wait]
                                           [--opt-out {auth, configinfo, publicnetwork}]
                                           [--resource-group]
                                           [--secret]

Examples

Update the client type of a connection with resource name

az aks connection update postgres-flexible -g ClusterRG -n MyCluster --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az aks connection update postgres-flexible --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the aks.

accepted values: django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot

--connection

Name of the aks connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--enable-csi

Use keyvault as a secrets store via a CSI volume. If specified, AuthType Arguments are not needed.

accepted values: false, true

default value: False

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--kube-namespace

The kubernetes namespace where the connection information will be saved into (as kubernetes secret).

default value: default

--name -n

Name of the managed cluster. Required if '--id' is not specified.None.

--no-wait

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

default value: False

--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

accepted values: auth, configinfo, publicnetwork

--resource-group -g

The resource group which contains the managed cluster. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret name=XX secret=XX --secret name=XX secret-name=XX

name : Required. Username or account name for secret auth. secret : One of <secret, secret-uri, secret-name> is required. Password or account key for secret auth. secret-name : One of <secret, secret-uri, secret-name> is required. Keyvault secret name which stores password. It's for AKS only.

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 connection update redis

Preview

Command group 'aks connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a aks to redis connection.

az aks connection update redis [--appconfig-id]
                               [--client-type {dotnet, dotnet-internal, go, java, nodejs, none, python, springBoot}]
                               [--connection]
                               [--customized-keys]
                               [--enable-csi {false, true}]
                               [--id]
                               [--kube-namespace]
                               [--name]
                               [--no-wait]
                               [--opt-out {auth, configinfo, publicnetwork}]
                               [--private-endpoint {false, true}]
                               [--resource-group]
                               [--secret]

Examples

Update the client type of a connection with resource name

az aks connection update redis -g ClusterRG -n MyCluster --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az aks connection update redis --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the aks.

accepted values: dotnet, dotnet-internal, go, java, nodejs, none, python, springBoot

--connection

Name of the aks connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--enable-csi

Use keyvault as a secrets store via a CSI volume. If specified, AuthType Arguments are not needed.

accepted values: false, true

default value: False

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--kube-namespace

The kubernetes namespace where the connection information will be saved into (as kubernetes secret).

default value: default

--name -n

Name of the managed cluster. Required if '--id' is not specified.None.

--no-wait

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

default value: False

--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

accepted values: auth, configinfo, publicnetwork

--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true

--resource-group -g

The resource group which contains the managed cluster. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

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 connection update redis-enterprise

Preview

Command group 'aks connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a aks to redis-enterprise connection.

az aks connection update redis-enterprise [--appconfig-id]
                                          [--client-type {dotnet, dotnet-internal, go, java, nodejs, none, python, springBoot}]
                                          [--connection]
                                          [--customized-keys]
                                          [--enable-csi {false, true}]
                                          [--id]
                                          [--kube-namespace]
                                          [--name]
                                          [--no-wait]
                                          [--opt-out {auth, configinfo, publicnetwork}]
                                          [--resource-group]
                                          [--secret]

Examples

Update the client type of a connection with resource name

az aks connection update redis-enterprise -g ClusterRG -n MyCluster --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az aks connection update redis-enterprise --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the aks.

accepted values: dotnet, dotnet-internal, go, java, nodejs, none, python, springBoot

--connection

Name of the aks connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--enable-csi

Use keyvault as a secrets store via a CSI volume. If specified, AuthType Arguments are not needed.

accepted values: false, true

default value: False

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--kube-namespace

The kubernetes namespace where the connection information will be saved into (as kubernetes secret).

default value: default

--name -n

Name of the managed cluster. Required if '--id' is not specified.None.

--no-wait

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

default value: False

--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

accepted values: auth, configinfo, publicnetwork

--resource-group -g

The resource group which contains the managed cluster. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

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 connection update servicebus

Preview

Command group 'aks connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a aks to servicebus connection.

az aks connection update servicebus [--appconfig-id]
                                    [--client-type {dotnet, dotnet-internal, go, java, nodejs, none, python, springBoot}]
                                    [--connection]
                                    [--customized-keys]
                                    [--enable-csi {false, true}]
                                    [--id]
                                    [--kube-namespace]
                                    [--name]
                                    [--no-wait]
                                    [--opt-out {auth, configinfo, publicnetwork}]
                                    [--private-endpoint {false, true}]
                                    [--resource-group]
                                    [--secret]
                                    [--service-endpoint {false, true}]
                                    [--service-principal]
                                    [--workload-identity]

Examples

Update the client type of a connection with resource name

az aks connection update servicebus -g ClusterRG -n MyCluster --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az aks connection update servicebus --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the aks.

accepted values: dotnet, dotnet-internal, go, java, nodejs, none, python, springBoot

--connection

Name of the aks connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--enable-csi

Use keyvault as a secrets store via a CSI volume. If specified, AuthType Arguments are not needed.

accepted values: false, true

default value: False

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--kube-namespace

The kubernetes namespace where the connection information will be saved into (as kubernetes secret).

default value: default

--name -n

Name of the managed cluster. Required if '--id' is not specified.None.

--no-wait

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

default value: False

--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

accepted values: auth, configinfo, publicnetwork

--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true

--resource-group -g

The resource group which contains the managed cluster. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service-endpoint

Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.

accepted values: false, true

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--workload-identity

The user-assigned managed identity used to create workload identity federation.

Usage: --workload-identity

user-identity-resource-id: Required. The resource id of the user assigned identity. Please DO NOT use AKS control plane identity and kubelet identity which is not supported by federated identity credential.

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 connection update signalr

Preview

Command group 'aks connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a aks to signalr connection.

az aks connection update signalr [--appconfig-id]
                                 [--client-type {dotnet, dotnet-internal, none}]
                                 [--connection]
                                 [--customized-keys]
                                 [--enable-csi {false, true}]
                                 [--id]
                                 [--kube-namespace]
                                 [--name]
                                 [--no-wait]
                                 [--opt-out {auth, configinfo, publicnetwork}]
                                 [--private-endpoint {false, true}]
                                 [--resource-group]
                                 [--secret]
                                 [--service-principal]
                                 [--workload-identity]

Examples

Update the client type of a connection with resource name

az aks connection update signalr -g ClusterRG -n MyCluster --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az aks connection update signalr --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the aks.

accepted values: dotnet, dotnet-internal, none

--connection

Name of the aks connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--enable-csi

Use keyvault as a secrets store via a CSI volume. If specified, AuthType Arguments are not needed.

accepted values: false, true

default value: False

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--kube-namespace

The kubernetes namespace where the connection information will be saved into (as kubernetes secret).

default value: default

--name -n

Name of the managed cluster. Required if '--id' is not specified.None.

--no-wait

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

default value: False

--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

accepted values: auth, configinfo, publicnetwork

--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true

--resource-group -g

The resource group which contains the managed cluster. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--workload-identity

The user-assigned managed identity used to create workload identity federation.

Usage: --workload-identity

user-identity-resource-id: Required. The resource id of the user assigned identity. Please DO NOT use AKS control plane identity and kubelet identity which is not supported by federated identity credential.

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 connection update sql

Preview

Command group 'aks connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a aks to sql connection.

az aks connection update sql [--appconfig-id]
                             [--client-type {django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot}]
                             [--connection]
                             [--customized-keys]
                             [--enable-csi {false, true}]
                             [--id]
                             [--kube-namespace]
                             [--name]
                             [--no-wait]
                             [--opt-out {auth, configinfo, publicnetwork}]
                             [--private-endpoint {false, true}]
                             [--resource-group]
                             [--secret]
                             [--service-endpoint {false, true}]

Examples

Update the client type of a connection with resource name

az aks connection update sql -g ClusterRG -n MyCluster --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az aks connection update sql --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the aks.

accepted values: django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot

--connection

Name of the aks connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--enable-csi

Use keyvault as a secrets store via a CSI volume. If specified, AuthType Arguments are not needed.

accepted values: false, true

default value: False

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--kube-namespace

The kubernetes namespace where the connection information will be saved into (as kubernetes secret).

default value: default

--name -n

Name of the managed cluster. Required if '--id' is not specified.None.

--no-wait

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

default value: False

--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

accepted values: auth, configinfo, publicnetwork

--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true

--resource-group -g

The resource group which contains the managed cluster. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret name=XX secret=XX --secret name=XX secret-name=XX

name : Required. Username or account name for secret auth. secret : One of <secret, secret-uri, secret-name> is required. Password or account key for secret auth. secret-name : One of <secret, secret-uri, secret-name> is required. Keyvault secret name which stores password. It's for AKS only.

--service-endpoint

Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.

accepted values: false, true

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 connection update storage-blob

Preview

Command group 'aks connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a aks to storage-blob connection.

az aks connection update storage-blob [--appconfig-id]
                                      [--client-type {dotnet, dotnet-internal, java, nodejs, none, python, springBoot}]
                                      [--connection]
                                      [--customized-keys]
                                      [--enable-csi {false, true}]
                                      [--id]
                                      [--kube-namespace]
                                      [--name]
                                      [--no-wait]
                                      [--opt-out {auth, configinfo, publicnetwork}]
                                      [--private-endpoint {false, true}]
                                      [--resource-group]
                                      [--secret]
                                      [--service-endpoint {false, true}]
                                      [--service-principal]
                                      [--workload-identity]

Examples

Update the client type of a connection with resource name

az aks connection update storage-blob -g ClusterRG -n MyCluster --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az aks connection update storage-blob --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the aks.

accepted values: dotnet, dotnet-internal, java, nodejs, none, python, springBoot

--connection

Name of the aks connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--enable-csi

Use keyvault as a secrets store via a CSI volume. If specified, AuthType Arguments are not needed.

accepted values: false, true

default value: False

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--kube-namespace

The kubernetes namespace where the connection information will be saved into (as kubernetes secret).

default value: default

--name -n

Name of the managed cluster. Required if '--id' is not specified.None.

--no-wait

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

default value: False

--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

accepted values: auth, configinfo, publicnetwork

--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true

--resource-group -g

The resource group which contains the managed cluster. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service-endpoint

Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.

accepted values: false, true

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--workload-identity

The user-assigned managed identity used to create workload identity federation.

Usage: --workload-identity

user-identity-resource-id: Required. The resource id of the user assigned identity. Please DO NOT use AKS control plane identity and kubelet identity which is not supported by federated identity credential.

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 connection update storage-file

Preview

Command group 'aks connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a aks to storage-file connection.

az aks connection update storage-file [--appconfig-id]
                                      [--client-type {dotnet, dotnet-internal, java, nodejs, none, php, python, ruby, springBoot}]
                                      [--connection]
                                      [--customized-keys]
                                      [--enable-csi {false, true}]
                                      [--id]
                                      [--kube-namespace]
                                      [--name]
                                      [--no-wait]
                                      [--opt-out {auth, configinfo, publicnetwork}]
                                      [--private-endpoint {false, true}]
                                      [--resource-group]
                                      [--secret]
                                      [--service-endpoint {false, true}]

Examples

Update the client type of a connection with resource name

az aks connection update storage-file -g ClusterRG -n MyCluster --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az aks connection update storage-file --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the aks.

accepted values: dotnet, dotnet-internal, java, nodejs, none, php, python, ruby, springBoot

--connection

Name of the aks connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--enable-csi

Use keyvault as a secrets store via a CSI volume. If specified, AuthType Arguments are not needed.

accepted values: false, true

default value: False

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--kube-namespace

The kubernetes namespace where the connection information will be saved into (as kubernetes secret).

default value: default

--name -n

Name of the managed cluster. Required if '--id' is not specified.None.

--no-wait

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

default value: False

--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

accepted values: auth, configinfo, publicnetwork

--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true

--resource-group -g

The resource group which contains the managed cluster. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service-endpoint

Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.

accepted values: false, true

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 connection update storage-queue

Preview

Command group 'aks connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a aks to storage-queue connection.

az aks connection update storage-queue [--appconfig-id]
                                       [--client-type {dotnet, dotnet-internal, java, nodejs, none, python, springBoot}]
                                       [--connection]
                                       [--customized-keys]
                                       [--enable-csi {false, true}]
                                       [--id]
                                       [--kube-namespace]
                                       [--name]
                                       [--no-wait]
                                       [--opt-out {auth, configinfo, publicnetwork}]
                                       [--private-endpoint {false, true}]
                                       [--resource-group]
                                       [--secret]
                                       [--service-endpoint {false, true}]
                                       [--service-principal]
                                       [--workload-identity]

Examples

Update the client type of a connection with resource name

az aks connection update storage-queue -g ClusterRG -n MyCluster --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az aks connection update storage-queue --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the aks.

accepted values: dotnet, dotnet-internal, java, nodejs, none, python, springBoot

--connection

Name of the aks connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--enable-csi

Use keyvault as a secrets store via a CSI volume. If specified, AuthType Arguments are not needed.

accepted values: false, true

default value: False

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--kube-namespace

The kubernetes namespace where the connection information will be saved into (as kubernetes secret).

default value: default

--name -n

Name of the managed cluster. Required if '--id' is not specified.None.

--no-wait

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

default value: False

--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

accepted values: auth, configinfo, publicnetwork

--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true

--resource-group -g

The resource group which contains the managed cluster. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service-endpoint

Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.

accepted values: false, true

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--workload-identity

The user-assigned managed identity used to create workload identity federation.

Usage: --workload-identity

user-identity-resource-id: Required. The resource id of the user assigned identity. Please DO NOT use AKS control plane identity and kubelet identity which is not supported by federated identity credential.

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 connection update storage-table

Preview

Command group 'aks connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a aks to storage-table connection.

az aks connection update storage-table [--appconfig-id]
                                       [--client-type {dotnet, dotnet-internal, java, nodejs, none, python}]
                                       [--connection]
                                       [--customized-keys]
                                       [--enable-csi {false, true}]
                                       [--id]
                                       [--kube-namespace]
                                       [--name]
                                       [--no-wait]
                                       [--opt-out {auth, configinfo, publicnetwork}]
                                       [--private-endpoint {false, true}]
                                       [--resource-group]
                                       [--secret]
                                       [--service-endpoint {false, true}]
                                       [--service-principal]
                                       [--workload-identity]

Examples

Update the client type of a connection with resource name

az aks connection update storage-table -g ClusterRG -n MyCluster --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az aks connection update storage-table --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the aks.

accepted values: dotnet, dotnet-internal, java, nodejs, none, python

--connection

Name of the aks connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--enable-csi

Use keyvault as a secrets store via a CSI volume. If specified, AuthType Arguments are not needed.

accepted values: false, true

default value: False

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--kube-namespace

The kubernetes namespace where the connection information will be saved into (as kubernetes secret).

default value: default

--name -n

Name of the managed cluster. Required if '--id' is not specified.None.

--no-wait

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

default value: False

--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

accepted values: auth, configinfo, publicnetwork

--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true

--resource-group -g

The resource group which contains the managed cluster. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service-endpoint

Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.

accepted values: false, true

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--workload-identity

The user-assigned managed identity used to create workload identity federation.

Usage: --workload-identity

user-identity-resource-id: Required. The resource id of the user assigned identity. Please DO NOT use AKS control plane identity and kubelet identity which is not supported by federated identity credential.

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 connection update webpubsub

Preview

Command group 'aks connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a aks to webpubsub connection.

az aks connection update webpubsub [--appconfig-id]
                                   [--client-type {dotnet, dotnet-internal, java, nodejs, none, python}]
                                   [--connection]
                                   [--customized-keys]
                                   [--enable-csi {false, true}]
                                   [--id]
                                   [--kube-namespace]
                                   [--name]
                                   [--no-wait]
                                   [--opt-out {auth, configinfo, publicnetwork}]
                                   [--private-endpoint {false, true}]
                                   [--resource-group]
                                   [--secret]
                                   [--service-principal]
                                   [--workload-identity]

Examples

Update the client type of a connection with resource name

az aks connection update webpubsub -g ClusterRG -n MyCluster --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az aks connection update webpubsub --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the aks.

accepted values: dotnet, dotnet-internal, java, nodejs, none, python

--connection

Name of the aks connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--enable-csi

Use keyvault as a secrets store via a CSI volume. If specified, AuthType Arguments are not needed.

accepted values: false, true

default value: False

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--kube-namespace

The kubernetes namespace where the connection information will be saved into (as kubernetes secret).

default value: default

--name -n

Name of the managed cluster. Required if '--id' is not specified.None.

--no-wait

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

default value: False

--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

accepted values: auth, configinfo, publicnetwork

--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true

--resource-group -g

The resource group which contains the managed cluster. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--workload-identity

The user-assigned managed identity used to create workload identity federation.

Usage: --workload-identity

user-identity-resource-id: Required. The resource id of the user assigned identity. Please DO NOT use AKS control plane identity and kubelet identity which is not supported by federated identity credential.

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.