Share via

az k8sconfiguration

  • Preview
  • Reference

Note

This reference is part of the k8sconfiguration extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az k8sconfiguration command. 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 Kubernetes configuration.

Commands

Name Description Type Status
az k8sconfiguration create

Create a Kubernetes configuration.

 Extension Preview
az k8sconfiguration delete

Delete a Kubernetes configuration.

 Extension Preview
az k8sconfiguration list

List Kubernetes configurations.

 Extension Preview
az k8sconfiguration show

Show details of a Kubernetes configuration.

 Extension Preview
az k8sconfiguration update

Update a Kubernetes configuration.

 Extension Preview

az k8sconfiguration create

Preview

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

Create a Kubernetes configuration.

az k8sconfiguration create --cluster-name
                           --cluster-type {connectedClusters, managedClusters}
                           --name
                           --repository-url
                           --resource-group
                           --scope {cluster, namespace}
                           [--enable-helm-operator {false, true}]
                           [--helm-operator-params]
                           [--helm-operator-version]
                           [--operator-instance-name]
                           [--operator-namespace]
                           [--operator-params]
                           [--operator-type]

Examples

Create a Kubernetes configuration

az k8sconfiguration create --resource-group MyResourceGroup --cluster-name MyClusterName \
--cluster-type connectedClusters --name MyConfigurationName --operator-instance-name OperatorInst01 \
--operator-namespace OperatorNamespace01 --repository-url git://github.com/fluxHowTo/flux-get-started \
--operator-params "'--git-readonly'" --enable-helm-operator --helm-operator-version 0.6.0 \
--scope namespace --helm-operator-params '--set helm.versions=v3'

Required Parameters

--cluster-name -c

Name of the Kubernetes cluster.

--cluster-type

Specify Arc clusters or AKS managed clusters.

Accepted values: connectedClusters, managedClusters
--name -n

Name of the Kubernetes Configuration.

--repository-url -u

Url of the source control repository.

--resource-group -g

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

--scope

Specify scope of the operator to be 'namespace' or 'cluster'.

Accepted values: cluster, namespace

Optional Parameters

--enable-helm-operator

Enable support for Helm chart deployments.

Accepted values: false, true
--helm-operator-params

Chart values for the Helm Operator (if enabled).

--helm-operator-version

Chart version of the Helm Operator (if enabled).

Default value: 0.3.0
--operator-instance-name

Instance name of the Operator.

--operator-namespace

Namespace in which to install the Operator.

Default value: default
--operator-params

Parameters for the Operator.

--operator-type

Type of the operator. Valid value is 'flux'.

Default value: flux
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 k8sconfiguration delete

Preview

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

Delete a Kubernetes configuration.

az k8sconfiguration delete --cluster-name
                           --cluster-type {connectedClusters, managedClusters}
                           --name
                           --resource-group
                           [--yes]

Examples

Delete a Kubernetes configuration

az k8sconfiguration delete --resource-group MyResourceGroup --cluster-name MyClusterName \
--cluster-type connectedClusters --name MyConfigurationName

Required Parameters

--cluster-name -c

Name of the Kubernetes cluster.

--cluster-type

Specify Arc clusters or AKS managed clusters.

Accepted values: connectedClusters, managedClusters
--name -n

Name of the Kubernetes Configuration.

--resource-group -g

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

Optional Parameters

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

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

--subscription

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

--verbose

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

az k8sconfiguration list

Preview

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

List Kubernetes configurations.

az k8sconfiguration list --cluster-name
                         --cluster-type {connectedClusters, managedClusters}
                         --resource-group

Examples

List all Kubernetes configurations of a cluster

az k8sconfiguration list --resource-group MyResourceGroup --cluster-name MyClusterName \
--cluster-type connectedClusters

Required Parameters

--cluster-name -c

Name of the Kubernetes cluster.

--cluster-type

Specify Arc clusters or AKS managed clusters.

Accepted values: connectedClusters, managedClusters
--resource-group -g

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

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

--subscription

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

--verbose

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

az k8sconfiguration show

Preview

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

Show details of a Kubernetes configuration.

az k8sconfiguration show --cluster-name
                         --cluster-type {connectedClusters, managedClusters}
                         --name
                         --resource-group

Examples

Show a Kubernetes configuration

az k8sconfiguration show --resource-group MyResourceGroup --cluster-name MyClusterName \
--cluster-type connectedClusters --name MyConfigurationName

Required Parameters

--cluster-name -c

Name of the Kubernetes cluster.

--cluster-type

Specify Arc clusters or AKS managed clusters.

Accepted values: connectedClusters, managedClusters
--name -n

Name of the Kubernetes Configuration.

--resource-group -g

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

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

--subscription

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

--verbose

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

az k8sconfiguration update

Preview

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

Update a Kubernetes configuration.

az k8sconfiguration update --cluster-name
                           --cluster-type {connectedClusters, managedClusters}
                           --name
                           --resource-group
                           [--enable-helm-operator {false, true}]
                           [--helm-operator-params]
                           [--helm-operator-version]
                           [--operator-params]
                           [--repository-url]

Examples

Update an existing Kubernetes configuration

az k8sconfiguration update --resource-group MyResourceGroup --cluster-name MyClusterName \
--cluster-type connectedClusters --name MyConfigurationName --enable-helm-operator \
--repository-url git://github.com/fluxHowTo/flux-get-started --operator-params "'--git-readonly'" \
--helm-operator-version 0.6.0 --helm-operator-params '--set helm.versions=v3'

Required Parameters

--cluster-name -c

Name of the Kubernetes cluster.

--cluster-type

Specify Arc clusters or AKS managed clusters.

Accepted values: connectedClusters, managedClusters
--name -n

Name of the Kubernetes Configuration.

--resource-group -g

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

Optional Parameters

--enable-helm-operator

Enable support for Helm chart deployments.

Accepted values: false, true
--helm-operator-params

Chart values for the Helm Operator (if enabled).

--helm-operator-version

Chart version of the Helm Operator (if enabled).

--operator-params

Parameters for the Operator.

--repository-url -u

Url of the source control repository.

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.