Share via


az aks connection

Note

This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.

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

Commands to manage aks connections.

Commands

Name Description Type Status
az aks connection create

Create a connection between a aks and a target resource.

Core and Extension Preview
az aks connection create app-insights

Create a aks connection to app-insights.

Core Preview
az aks connection create appconfig

Create a aks connection to appconfig.

Core Preview
az aks connection create cognitiveservices

Create a aks connection to cognitiveservices.

Core Preview
az aks connection create confluent-cloud

Create a aks connection to confluent-cloud.

Core Preview
az aks connection create cosmos-cassandra

Create a aks connection to cosmos-cassandra.

Core Preview
az aks connection create cosmos-gremlin

Create a aks connection to cosmos-gremlin.

Core Preview
az aks connection create cosmos-mongo

Create a aks connection to cosmos-mongo.

Core Preview
az aks connection create cosmos-sql

Create a aks connection to cosmos-sql.

Core Preview
az aks connection create cosmos-table

Create a aks connection to cosmos-table.

Core Preview
az aks connection create eventhub

Create a aks connection to eventhub.

Core Preview
az aks connection create keyvault

Create a aks connection to keyvault.

Core Preview
az aks connection create mysql

Create a aks connection to mysql.

Core Preview and Deprecated
az aks connection create mysql-flexible

Create a aks connection to mysql-flexible.

Core Preview
az aks connection create mysql-flexible (serviceconnector-passwordless extension)

Create a aks connection to mysql-flexible.

Extension GA
az aks connection create postgres

Create a aks connection to postgres.

Core Preview and Deprecated
az aks connection create postgres-flexible

Create a aks connection to postgres-flexible.

Core Preview
az aks connection create postgres-flexible (serviceconnector-passwordless extension)

Create a aks connection to postgres-flexible.

Extension GA
az aks connection create redis

Create a aks connection to redis.

Core Preview
az aks connection create redis-enterprise

Create a aks connection to redis-enterprise.

Core Preview
az aks connection create servicebus

Create a aks connection to servicebus.

Core Preview
az aks connection create signalr

Create a aks connection to signalr.

Core Preview
az aks connection create sql

Create a aks connection to sql.

Core Preview
az aks connection create sql (serviceconnector-passwordless extension)

Create a aks connection to sql.

Extension GA
az aks connection create storage-blob

Create a aks connection to storage-blob.

Core Preview
az aks connection create storage-file

Create a aks connection to storage-file.

Core Preview
az aks connection create storage-queue

Create a aks connection to storage-queue.

Core Preview
az aks connection create storage-table

Create a aks connection to storage-table.

Core Preview
az aks connection create webpubsub

Create a aks connection to webpubsub.

Core Preview
az aks connection delete

Delete a aks connection.

Core Preview
az aks connection list

List connections of a aks.

Core Preview
az aks connection list-configuration

List source configurations of a aks connection.

Core Preview
az aks connection list-support-types

List client types and auth types supported by aks connections.

Core Preview
az aks connection show

Get the details of a aks connection.

Core Preview
az aks connection update

Update a aks connection.

Core Preview
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 cognitiveservices

Update a aks to cognitiveservices 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 validate

Validate a aks connection.

Core Preview
az aks connection wait

Place the CLI in a waiting state until a condition of the connection is met.

Core Preview

az aks connection delete

Preview

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

Delete a aks connection.

az aks connection delete [--connection]
                         [--id]
                         [--name]
                         [--no-wait]
                         [--resource-group]
                         [--yes]

Examples

Delete a aks connection interactively

az aks connection delete

Delete a aks connection by connection name

az aks connection delete -g ClusterRG -n MyCluster --connection MyConnection

Delete a aks connection by connection id

az aks connection delete --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker}

Optional Parameters

--connection

Name of the aks connection.

--id

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

--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
--resource-group -g

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

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az aks connection list

Preview

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

List connections of a aks.

az aks connection list [--name]
                       [--resource-group]
                       [--source-id]

Examples

List aks connections interactively

az aks connection list

List aks connections by source resource name

az aks connection list -g ClusterRG -n MyCluster

List aks connections by source resource id

az aks connection list --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.ContainerService/managedClusters/{cluster}

Optional Parameters

--name -n

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

--resource-group -g

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

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

Preview

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

List source configurations of a aks connection.

az aks connection list-configuration [--connection]
                                     [--id]
                                     [--name]
                                     [--resource-group]

Examples

List a connection's source configurations interactively

az aks connection list-configuration

List a connection's source configurations by connection name

az aks connection list-configuration -g ClusterRG -n MyCluster --connection MyConnection

List a connection's source configurations by connection id

az aks connection list-configuration --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker}

Optional Parameters

--connection

Name of the aks connection.

--id

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

--name -n

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

--resource-group -g

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az aks connection list-support-types

Preview

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

List client types and auth types supported by aks connections.

az aks connection list-support-types [--target-type {app-insights, appconfig, cognitiveservices, confluent-cloud, cosmos-cassandra, cosmos-gremlin, cosmos-mongo, cosmos-sql, cosmos-table, eventhub, keyvault, mysql, mysql-flexible, postgres, postgres-flexible, redis, redis-enterprise, servicebus, signalr, sql, storage-blob, storage-file, storage-queue, storage-table, webpubsub}]

Examples

List all aks supported target resource types and auth types

az aks connection list-support-types -o table

List aks supported auth types for a specific target resource type

az aks connection list-support-types --target-type storage-blob -o table

Optional Parameters

--target-type -t

The target resource type.

Accepted values: app-insights, appconfig, cognitiveservices, confluent-cloud, cosmos-cassandra, cosmos-gremlin, cosmos-mongo, cosmos-sql, cosmos-table, eventhub, keyvault, mysql, mysql-flexible, postgres, postgres-flexible, redis, redis-enterprise, servicebus, signalr, sql, storage-blob, storage-file, storage-queue, storage-table, webpubsub
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 show

Preview

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

Get the details of a aks connection.

az aks connection show [--connection]
                       [--id]
                       [--name]
                       [--resource-group]

Examples

Get a connection interactively

az aks connection show

Get a connection by connection name

az aks connection show -g ClusterRG -n MyCluster --connection MyConnection

Get a connection by connection id

az aks connection show --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker}

Optional Parameters

--connection

Name of the aks connection.

--id

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

--name -n

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

--resource-group -g

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az aks connection validate

Preview

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

Validate a aks connection.

az aks connection validate [--connection]
                           [--id]
                           [--name]
                           [--resource-group]

Examples

Validate a connection interactively

az aks connection validate

Validate a connection by connection name

az aks connection validate -g ClusterRG -n MyCluster --connection MyConnection

Validate a connection by connection id

az aks connection validate --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker}

Optional Parameters

--connection

Name of the aks connection.

--id

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

--name -n

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

--resource-group -g

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az aks connection wait

Preview

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

Place the CLI in a waiting state until a condition of the connection is met.

az aks connection wait [--connection]
                       [--created]
                       [--custom]
                       [--deleted]
                       [--exists]
                       [--id]
                       [--interval]
                       [--name]
                       [--resource-group]
                       [--timeout]
                       [--updated]

Examples

Wait until the connection is successfully created.

az aks connection wait --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --created

Optional Parameters

--connection

Name of the aks connection.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

Default value: False
--id

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

--interval

Polling interval in seconds.

Default value: 30
--name -n

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

--resource-group -g

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

--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.