Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

az k8s-configuration

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 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 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
 [--acquire-policy-token]
 [--change-reference]
 [--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.

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False

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.

Property Value
Accepted values: connectedClusters, managedClusters, provisionedClusters
--resource-group -g

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

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.

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

Feedback

Was this page helpful?