Share via

az k8s-extension extension-types

  • Preview

Note

This reference is part of the k8s-extension extension for the Azure CLI (version 2.51.0 or higher). The extension will automatically install the first time you run an az k8s-extension extension-types 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 discover Kubernetes Extension Types.

Commands

Name Description Type Status
az k8s-extension extension-types list-by-cluster

List available Cluster Extension Types for an existing cluster. The properties used for filtering include type of cluster (managed, connected, etc), kubernetes version, ___location of the cluster.

 Extension Preview
az k8s-extension extension-types list-by-___location

List available Cluster Extension Types in a region.

 Extension Preview
az k8s-extension extension-types list-versions-by-cluster

List available versions for a Cluster Extension Type for a given cluster. The properties used for filtering include type of cluster (managed, connected, etc), kubernetes version, ___location of the cluster.

 Extension Preview
az k8s-extension extension-types list-versions-by-___location

List available versions for a Cluster Extension Type versions in a region.

 Extension Preview
az k8s-extension extension-types show-by-cluster

Show properties for a Cluster Extension Type for an existing cluster. The properties used for filtering include type of cluster (managed, connected, etc), kubernetes version, ___location of the cluster.

 Extension Preview
az k8s-extension extension-types show-by-___location

Show properties for a Cluster Extension Type in a region.

 Extension Preview
az k8s-extension extension-types show-version-by-cluster

Show properties associated with a Cluster Extension Type version for an existing cluster. The properties used for filtering include type of cluster (managed, connected, etc), kubernetes version, ___location of the cluster.

 Extension Preview
az k8s-extension extension-types show-version-by-___location

Show properties associated with a Cluster Extension Type version in a region.

 Extension Preview

az k8s-extension extension-types list-by-cluster

Preview

Command group 'k8s-extension extension-types' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List available Cluster Extension Types for an existing cluster. The properties used for filtering include type of cluster (managed, connected, etc), kubernetes version, ___location of the cluster.

az k8s-extension extension-types list-by-cluster --cluster-name
                                                 --cluster-type {appliances, connectedClusters, managedClusters}
                                                 --resource-group
                                                 [--plan-name]
                                                 [--plan-product]
                                                 [--plan-publisher]
                                                 [--release-train]

Examples

List available Cluster Extension Types for an existing cluster

az k8s-extension extension-types list-by-cluster --resource-group my-resource-group --cluster-name mycluster --cluster-type connectedClusters

Required Parameters

--cluster-name -c

Name of the Kubernetes cluster.

--cluster-type -t

Specify Arc clusters or AKS managed clusters or Arc appliances.

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

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

Optional Parameters

--plan-name

The plan name is referring to the Marketplace Plan ID of the extension.

--plan-product

The plan product is referring to the Marketplace Product ID of the extension.

--plan-publisher

The plan publisher is referring to the Marketplace Publisher ID of the extension.

--release-train

Specify the release train for the extension type.

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-extension extension-types list-by-___location

Preview

Command group 'k8s-extension extension-types' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List available Cluster Extension Types in a region.

az k8s-extension extension-types list-by-___location --___location
                                                  [--cluster-type {appliances, connectedClusters, managedClusters}]
                                                  [--plan-name]
                                                  [--plan-product]
                                                  [--plan-publisher]
                                                  [--release-train]

Examples

List available Cluster Extension Types in a region

az k8s-extension extension-types list-by-___location --___location eastus

Required Parameters

--___location -l

Name of the ___location. Values from: az account list-locations.

Optional Parameters

--cluster-type -t

Specify Arc clusters or AKS managed clusters or Arc appliances.

Accepted values: appliances, connectedClusters, managedClusters
--plan-name

The plan name is referring to the Marketplace Plan ID of the extension.

--plan-product

The plan product is referring to the Marketplace Product ID of the extension.

--plan-publisher

The plan publisher is referring to the Marketplace Publisher ID of the extension.

--release-train

Specify the release train for the extension type.

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-extension extension-types list-versions-by-cluster

Preview

Command group 'k8s-extension extension-types' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List available versions for a Cluster Extension Type for a given cluster. The properties used for filtering include type of cluster (managed, connected, etc), kubernetes version, ___location of the cluster.

az k8s-extension extension-types list-versions-by-cluster --cluster-name
                                                          --cluster-type {appliances, connectedClusters, managedClusters}
                                                          --extension-type
                                                          --resource-group
                                                          [--major-version]
                                                          [--release-train]
                                                          [--show-latest {false, true}]

Examples

List available versions for a Cluster Extension Type for a given cluster

az k8s-extension extension-types list-versions-by-cluster --resource-group my-resource-group --cluster-name mycluster --cluster-type connectedClusters --extension-type microsoft.flux

Required Parameters

--cluster-name -c

Name of the Kubernetes cluster.

--cluster-type -t

Specify Arc clusters or AKS managed clusters or Arc appliances.

Accepted values: appliances, connectedClusters, managedClusters
--extension-type

Name of the extension type.

--resource-group -g

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

Optional Parameters

--major-version

Filter results by only the major version of an extension type. For example if 1 is specified, all versions with major version 1 (1.1, 1.1.2) will be shown. The default value is None.

--release-train

Specify the release train for the extension type.

--show-latest

Filter results by only the latest version. For example, if this flag is used the latest version of the extensionType will be shown.

Accepted values: false, true
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-extension extension-types list-versions-by-___location

Preview

Command group 'k8s-extension extension-types' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List available versions for a Cluster Extension Type versions in a region.

az k8s-extension extension-types list-versions-by-___location --extension-type
                                                           --___location
                                                           [--cluster-type {appliances, connectedClusters, managedClusters}]
                                                           [--major-version]
                                                           [--release-train]
                                                           [--show-latest {false, true}]

Examples

List available versions for a Cluster Extension Type versions in a region

az k8s-extension extension-types list-versions-by-___location --___location eastus --extension-type microsoft.flux

Required Parameters

--extension-type

Name of the extension type.

--___location -l

Name of the ___location. Values from: az account list-locations.

Optional Parameters

--cluster-type -t

Specify Arc clusters or AKS managed clusters or Arc appliances.

Accepted values: appliances, connectedClusters, managedClusters
--major-version

Filter results by only the major version of an extension type. For example if 1 is specified, all versions with major version 1 (1.1, 1.1.2) will be shown. The default value is None.

--release-train

Specify the release train for the extension type.

--show-latest

Filter results by only the latest version. For example, if this flag is used the latest version of the extensionType will be shown.

Accepted values: false, true
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-extension extension-types show-by-cluster

Preview

Command group 'k8s-extension extension-types' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show properties for a Cluster Extension Type for an existing cluster. The properties used for filtering include type of cluster (managed, connected, etc), kubernetes version, ___location of the cluster.

az k8s-extension extension-types show-by-cluster --cluster-name
                                                 --cluster-type {appliances, connectedClusters, managedClusters}
                                                 --extension-type
                                                 --resource-group

Examples

Show properties for a Cluster Extension Type for an existing cluster

az k8s-extension extension-types show-by-cluster --resource-group my-resource-group --cluster-name mycluster --cluster-type connectedClusters --extension-type microsoft.openservicemesh

Required Parameters

--cluster-name -c

Name of the Kubernetes cluster.

--cluster-type -t

Specify Arc clusters or AKS managed clusters or Arc appliances.

Accepted values: appliances, connectedClusters, managedClusters
--extension-type

Name of the extension type.

--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-extension extension-types show-by-___location

Preview

Command group 'k8s-extension extension-types' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show properties for a Cluster Extension Type in a region.

az k8s-extension extension-types show-by-___location --extension-type
                                                  --___location

Examples

Show properties for a Cluster Extension Type in a region

az k8s-extension extension-types show-by-___location --___location eastus --extension-type microsoft.openservicemesh

Required Parameters

--extension-type

Name of the extension type.

--___location -l

Name of the ___location. Values from: az account list-locations.

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-extension extension-types show-version-by-cluster

Preview

Command group 'k8s-extension extension-types' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show properties associated with a Cluster Extension Type version for an existing cluster. The properties used for filtering include type of cluster (managed, connected, etc), kubernetes version, ___location of the cluster.

az k8s-extension extension-types show-version-by-cluster --cluster-name
                                                         --cluster-type {appliances, connectedClusters, managedClusters}
                                                         --extension-type
                                                         --resource-group
                                                         --version

Examples

Show properties associated with a Cluster Extension Type version for an existing cluster

az k8s-extension extension-types show-version-by-cluster --resource-group my-resource-group --cluster-name mycluster --cluster-type connectedClusters --extension-type microsoft.openservicemesh --version 1.0.0

Required Parameters

--cluster-name -c

Name of the Kubernetes cluster.

--cluster-type -t

Specify Arc clusters or AKS managed clusters or Arc appliances.

Accepted values: appliances, connectedClusters, managedClusters
--extension-type

Name of the extension type.

--resource-group -g

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

--version

Version for the extension type.

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-extension extension-types show-version-by-___location

Preview

Command group 'k8s-extension extension-types' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show properties associated with a Cluster Extension Type version in a region.

az k8s-extension extension-types show-version-by-___location --extension-type
                                                          --___location
                                                          --version

Examples

Show properties associated with a Cluster Extension Type version in a region.

az k8s-extension extension-types show-version-by-___location --___location eastus --extension-type microsoft.openservicemesh --version 1.0.0

Required Parameters

--extension-type

Name of the extension type.

--___location -l

Name of the ___location. Values from: az account list-locations.

--version

Version for the extension type.

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.