az k8s-configuration

Reference

Note

This reference is part of the k8s-configuration extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az k8s-configuration command. Learn more about extensions.

Commands to manage resources from Microsoft.KubernetesConfiguration.

Commands

Name	Description	Type	Status
az k8s-configuration create	Create a Flux v1 Kubernetes configuration (This command is for Flux v1, to use the newer Flux v2, run "az k8s-configuration flux create").	Extension	Deprecated
az k8s-configuration delete	Delete a Flux v1 Kubernetes configuration (This command is for Flux v1, to use the newer Flux v2, run "az k8s-configuration flux delete").	Extension	Deprecated
az k8s-configuration flux	Commands to manage Flux v2 Kubernetes configurations.	Extension	GA
az k8s-configuration flux create	Create a Flux v2 Kubernetes configuration.	Extension	GA
az k8s-configuration flux delete	Delete a Flux v2 Kubernetes configuration.	Extension	GA
az k8s-configuration flux deployed-object	Commands to see deployed objects associated with Flux v2 Kubernetes configurations.	Extension	GA
az k8s-configuration flux deployed-object list	List deployed objects associated with a Flux v2 Kubernetes configuration.	Extension	GA
az k8s-configuration flux deployed-object show	Show a deployed object associated with a Flux v2 Kubernetes configuration.	Extension	GA
az k8s-configuration flux kustomization	Commands to manage Kustomizations associated with Flux v2 Kubernetes configurations.	Extension	GA
az k8s-configuration flux kustomization create	Create a Kustomization associated with a Flux v2 Kubernetes configuration.	Extension	GA
az k8s-configuration flux kustomization delete	Delete a Kustomization associated with a Flux v2 Kubernetes configuration.	Extension	GA
az k8s-configuration flux kustomization list	List Kustomizations associated with a Flux v2 Kubernetes configuration.	Extension	GA
az k8s-configuration flux kustomization show	Show a Kustomization associated with a Flux v2 Kubernetes configuration.	Extension	GA
az k8s-configuration flux kustomization update	Update a Kustomization associated with a Flux v2 Kubernetes configuration.	Extension	GA
az k8s-configuration flux list	List all Flux v2 Kubernetes configurations.	Extension	GA
az k8s-configuration flux show	Show a Flux v2 Kubernetes configuration.	Extension	GA
az k8s-configuration flux update	Update a Flux v2 Kubernetes configuration.	Extension	GA
az k8s-configuration list	List Flux v1 Kubernetes configurations (This command is for Flux v1, to use the newer Flux v2, run "az k8s-configuration flux list").	Extension	Deprecated
az k8s-configuration show	Show details of a Flux v1 Kubernetes configuration (This command is for Flux v1, to use the newer Flux v2, run "az k8s-configuration flux show").	Extension	Deprecated

az k8s-configuration create

Deprecated

This command has been deprecated and will be removed in a future release. Use 'k8s-configuration flux create' instead.

Create a Flux v1 Kubernetes configuration (This command is for Flux v1, to use the newer Flux v2, run "az k8s-configuration flux create").

az k8s-configuration create --cluster-name
                            --cluster-type {connectedClusters, managedClusters, provisionedClusters}
                            --name
                            --repository-url
                            --resource-group
                            --scope {cluster, namespace}
                            [--enable-helm-operator {false, true}]
                            [--helm-operator-chart-version]
                            [--helm-operator-params]
                            [--https-key]
                            [--https-user]
                            [--operator-instance-name]
                            [--operator-namespace]
                            [--operator-params]
                            [--operator-type]
                            [--ssh-known-hosts]
                            [--ssh-known-hosts-file]
                            [--ssh-private-key]
                            [--ssh-private-key-file]

Examples

Create a Flux v1 Kubernetes configuration

az k8s-configuration create --resource-group MyResourceGroup --cluster-name MyClusterName \
--cluster-type connectedClusters --name MyGitConfig --operator-instance-name OperatorInst01 \
--operator-namespace OperatorNamespace01 --operator-type flux --operator-params "'--git-readonly'" \
--repository-url git://github.com/fluxHowTo/flux-get-started --enable-helm-operator  \
--helm-operator-chart-version 1.4.0 --scope namespace --helm-operator-params '--set helm.versions=v3' \
--ssh-private-key '' --ssh-private-key-file '' --https-user '' --https-key '' \
--ssh-known-hosts '' --ssh-known-hosts-file ''

Required Parameters

--cluster-name -c

Name of the Kubernetes cluster.

--cluster-type -t

Specify Arc connected clusters or AKS managed clusters or provisioned clusters.

accepted values: connectedClusters, managedClusters, provisionedClusters

--name -n

Name of the 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-hop

Enable support for Helm chart deployments.

accepted values: false, true

--helm-operator-chart-version --hop-chart-version

Chart version of the Helm Operator (if enabled).

default value: 1.4.0

--helm-operator-params --hop-params

Chart values for the Helm Operator (if enabled).

--https-key

Specify HTTPS token/password for private repository sync.

--https-user

Specify HTTPS username for private repository sync.

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

--ssh-known-hosts

Specify Base64-encoded known_hosts contents containing public SSH keys required to access private Git instances.

--ssh-known-hosts-file

Specify file path to known_hosts contents containing public SSH keys required to access private Git instances.

--ssh-private-key

Specify Base64-encoded private ssh key for private repository sync.

--ssh-private-key-file

Specify file path to private ssh key for private repository sync.

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 k8s-configuration delete

Deprecated

This command has been deprecated and will be removed in a future release. Use 'k8s-configuration flux delete' instead.

Delete a Flux v1 Kubernetes configuration (This command is for Flux v1, to use the newer Flux v2, run "az k8s-configuration flux delete").

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

Examples

Delete a Flux v1 Kubernetes configuration

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

Required Parameters

--cluster-name -c

Name of the Kubernetes cluster.

--cluster-type -t

Specify Arc connected clusters or AKS managed clusters or provisioned clusters.

accepted values: connectedClusters, managedClusters, provisionedClusters

--name -n

Name of the 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 k8s-configuration list

Deprecated

This command has been deprecated and will be removed in a future release. Use 'k8s-configuration flux list' instead.

List Flux v1 Kubernetes configurations (This command is for Flux v1, to use the newer Flux v2, run "az k8s-configuration flux list").

az k8s-configuration list --cluster-name
                          --cluster-type {connectedClusters, managedClusters, provisionedClusters}
                          --resource-group

Examples

List Flux v1 Kubernetes configuration

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

Required Parameters

--cluster-name -c

Name of the Kubernetes cluster.

--cluster-type -t

Specify Arc connected clusters or AKS managed clusters or provisioned clusters.

accepted values: connectedClusters, managedClusters, provisionedClusters

--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 k8s-configuration show

Deprecated

This command has been deprecated and will be removed in a future release. Use 'k8s-configuration flux show' instead.

Show details of a Flux v1 Kubernetes configuration (This command is for Flux v1, to use the newer Flux v2, run "az k8s-configuration flux show").

az k8s-configuration show --cluster-name
                          --cluster-type {connectedClusters, managedClusters, provisionedClusters}
                          --name
                          --resource-group

Examples

Show details of a Flux v1 Kubernetes configuration

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

Required Parameters

--cluster-name -c

Name of the Kubernetes cluster.

--cluster-type -t

Specify Arc connected clusters or AKS managed clusters or provisioned clusters.

accepted values: connectedClusters, managedClusters, provisionedClusters

--name -n

Name of the 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 k8s-configuration

Commands

az k8s-configuration create

Examples

Required Parameters

Optional Parameters

az k8s-configuration delete

Examples

Required Parameters

Optional Parameters

az k8s-configuration list

Examples

Required Parameters

az k8s-configuration show

Examples

Required Parameters

الملاحظات

الموارد الإضافية