通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az k8s-extension

Note

此参考是 Azure CLI（版本 2.51.0 或更高版本）的 k8s 扩展 扩展的一部分。 该扩展将在首次运行 az k8s-extension 命令时自动安装。 了解更多关于扩展的信息。

用于管理 Kubernetes 扩展的命令。

命令

名称 说明 类型 Status
az k8s-extension create

创建 Kubernetes 群集扩展，包括从 Azure 市场购买扩展产品/服务（仅限 AKS）。 请参阅末尾的示例，了解如何创建扩展或购买扩展产品/服务。

 Extension GA
az k8s-extension delete

删除 Kubernetes 扩展。

 Extension GA
az k8s-extension extension-types

用于发现 Kubernetes 扩展类型的命令。

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

列出现有群集的可用群集扩展类型。 用于筛选的属性包括群集的类型（托管、连接等）、kubernetes 版本、群集位置。

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

列出区域中的可用群集扩展类型。

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

列出给定群集的群集扩展类型的可用版本。 用于筛选的属性包括群集的类型（托管、连接等）、kubernetes 版本、群集位置。

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

列出区域中群集扩展类型版本的可用版本。

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

显示现有群集的群集扩展类型的属性。 用于筛选的属性包括群集的类型（托管、连接等）、kubernetes 版本、群集位置。

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

显示区域中群集扩展类型的属性。

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

显示与现有群集的群集扩展类型版本关联的属性。 用于筛选的属性包括群集的类型（托管、连接等）、kubernetes 版本、群集位置。

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

显示与区域中的群集扩展类型版本关联的属性。

 Extension Preview
az k8s-extension list

列出 Kubernetes 扩展。

 Extension GA
az k8s-extension show

显示 Kubernetes 扩展。

 Extension GA
az k8s-extension troubleshoot

对 Kubernetes 扩展执行诊断检查。

 Extension Preview
az k8s-extension update

更新 Kubernetes 扩展的可变属性。

 Extension GA

az k8s-extension create

创建 Kubernetes 群集扩展，包括从 Azure 市场购买扩展产品/服务（仅限 AKS）。 请参阅末尾的示例，了解如何创建扩展或购买扩展产品/服务。

创建 Kubernetes 扩展。 输出包含必须保护的机密。 请确保在源代码管理中不包含这些机密。 此外，请验证命令或脚本的日志中是否存在任何机密。 有关详细信息，请参阅 http://aka.ms/clisecrets。

az k8s-extension create --cluster-name
                        --cluster-type {appliances, connectedClusters, managedClusters, provisionedClusters}
                        --extension-type
                        --name
                        --resource-group
                        [--auto-upgrade --auto-upgrade-minor-version {false, true}]
                        [--cluster-resource-provider --cluster-rp]
                        [--config --configuration-settings]
                        [--config-file --config-settings-file]
                        [--config-protected --config-protected-settings]
                        [--config-protected-file --config-protected-settings-file]
                        [--config-settings]
                        [--configuration-protected-settings]
                        [--configuration-protected-settings-file]
                        [--configuration-settings-file]
                        [--no-wait]
                        [--plan-name]
                        [--plan-product]
                        [--plan-publisher]
                        [--release-namespace]
                        [--release-train]
                        [--scope {cluster, namespace}]
                        [--target-namespace]
                        [--version]

示例

创建 Kubernetes 扩展

az k8s-extension create --resource-group my-resource-group --cluster-name mycluster --cluster-type connectedClusters --name myextension --extension-type microsoft.openservicemesh --scope cluster --release-train stable

创建 Kubernetes 市场扩展

az k8s-extension create --resource-group my-resource-group --cluster-name mycluster --cluster-type managedClusters --name myextension --extension-type Contoso.AzureVoteKubernetesAppTest --scope cluster --release-train stable --plan-name testplan --plan-product kubernetest_apps_demo_offer --plan-publisher test_test_mix3pptest0011614206850774

必需参数

--cluster-name -c

Kubernetes 群集的名称。

--cluster-type -t

指定 Arc 群集或 AKS 托管群集或 Arc 设备或 provisionedClusters。

属性 值
接受的值: appliances, connectedClusters, managedClusters, provisionedClusters
--extension-type

扩展类型的名称。

--name -n

扩展实例的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

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

--auto-upgrade --auto-upgrade-minor-version

自动升级扩展实例的次要版本。

属性 值
Parameter group: Version Arguments
接受的值: false, true
--cluster-resource-provider --cluster-rp

此 clusterType 的群集资源提供程序名称（provisionedClusters 必需）。

--config --configuration-settings

配置设置作为 key=value pair。 对每个设置重复参数。 不要将此值用于机密，因为此值在响应中返回。

属性 值
Parameter group: Configuration Arguments
--config-file --config-settings-file

配置设置的 JSON 文件路径。

属性 值
Parameter group: Configuration Arguments
--config-protected --config-protected-settings

将受保护的设置配置为 key=value pair。 对每个设置重复参数。 仅响应中返回键，该值不返回。

属性 值
Parameter group: Configuration Arguments
--config-protected-file --config-protected-settings-file

受配置保护的设置的 JSON 文件路径。

属性 值
Parameter group: Configuration Arguments
--config-settings
已放弃

选项“--config-settings”已弃用，将在将来的版本中删除。 请改用“--configuration-settings”。

配置设置作为 key=value pair。 对每个设置重复参数。 不要将此值用于机密，因为此值在响应中返回。

属性 值
Parameter group: Configuration Arguments
--configuration-protected-settings
已放弃

选项“--configuration-protected-settings”已弃用，将在将来的版本中删除。 请改用“--config-protected-settings”。

将受保护的设置配置为 key=value pair。 对每个设置重复参数。 仅响应中返回键，该值不返回。

属性 值
Parameter group: Configuration Arguments
--configuration-protected-settings-file
已放弃

选项“--configuration-protected-settings-file”已弃用，将在将来的版本中删除。 请改用“--config-protected-file”。

受配置保护的设置的 JSON 文件路径。

属性 值
Parameter group: Configuration Arguments
--configuration-settings-file
已放弃

选项“--configuration-settings-file”已弃用，将在将来的版本中删除。 请改用“--config-settings-file”。

配置设置的 JSON 文件路径。

属性 值
Parameter group: Configuration Arguments
--no-wait

不等待长时间运行的操作完成。

属性 值
默认值: False
--plan-name

计划名称指的是在使用情况信息 + 支持下从市场门户获取的扩展的计划 ID。

属性 值
Parameter group: Marketplace Arguments
--plan-product

计划产品指的是在“使用情况信息 + 支持”下从市场门户获取的扩展的产品 ID。 使用的 ISV 产品/服务的名称就是这方面的一个示例。

属性 值
Parameter group: Marketplace Arguments
--plan-publisher

计划发布者指的是在使用情况信息 + 支持下从市场门户获取的扩展的发布者 ID。

属性 值
Parameter group: Marketplace Arguments
--release-namespace

指定要安装扩展版本的命名空间。

--release-train

指定扩展类型的版本序列。

属性 值
Parameter group: Version Arguments
--scope

指定扩展范围。

属性 值
接受的值: cluster, namespace
--target-namespace

指定要为扩展实例安装的目标命名空间。 如果扩展范围设置为“namespace”，则需要此参数。

--version

如果未启用 --auto-upgrade-minor-version，请指定要为扩展实例安装的版本。

属性 值
Parameter group: Version Arguments
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az k8s-extension delete

删除 Kubernetes 扩展。

az k8s-extension delete --cluster-name
                        --cluster-type {appliances, connectedClusters, managedClusters, provisionedClusters}
                        --name
                        --resource-group
                        [--cluster-resource-provider --cluster-rp]
                        [--force]
                        [--no-wait]
                        [--yes]

示例

删除现有的 Kubernetes 扩展

az k8s-extension delete --resource-group my-resource-group --cluster-name mycluster --cluster-type connectedClusters --name myextension

必需参数

--cluster-name -c

Kubernetes 群集的名称。

--cluster-type -t

指定 Arc 群集或 AKS 托管群集或 Arc 设备或 provisionedClusters。

属性 值
接受的值: appliances, connectedClusters, managedClusters, provisionedClusters
--name -n

扩展实例的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

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

--cluster-resource-provider --cluster-rp

此 clusterType 的群集资源提供程序名称（provisionedClusters 必需）。

--force

指定是否强制从群集中删除扩展。

属性 值
默认值: False
--no-wait

不等待长时间运行的操作完成。

属性 值
默认值: False
--yes -y

忽略确认提示。

属性 值
默认值: False
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az k8s-extension list

列出 Kubernetes 扩展。

列出群集中的所有 Kubernetes 扩展，包括其属性。 输出包含必须保护的机密。 请确保在源代码管理中不包含这些机密。 此外，请验证命令或脚本的日志中是否存在任何机密。 有关详细信息，请参阅 http://aka.ms/clisecrets。

az k8s-extension list --cluster-name
                      --cluster-type {appliances, connectedClusters, managedClusters, provisionedClusters}
                      --resource-group
                      [--cluster-resource-provider --cluster-rp]

示例

列出群集上的所有 Kubernetes 扩展

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

必需参数

--cluster-name -c

Kubernetes 群集的名称。

--cluster-type -t

指定 Arc 群集或 AKS 托管群集或 Arc 设备或 provisionedClusters。

属性 值
接受的值: appliances, connectedClusters, managedClusters, provisionedClusters
--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

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

--cluster-resource-provider --cluster-rp

此 clusterType 的群集资源提供程序名称（provisionedClusters 必需）。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az k8s-extension show

显示 Kubernetes 扩展。

显示 Kubernetes 扩展，包括其属性。 输出包含必须保护的机密。 请确保在源代码管理中不包含这些机密。 此外，请验证命令或脚本的日志中是否存在任何机密。 有关详细信息，请参阅 http://aka.ms/clisecrets。

az k8s-extension show --cluster-name
                      --cluster-type {appliances, connectedClusters, managedClusters, provisionedClusters}
                      --name
                      --resource-group
                      [--cluster-resource-provider --cluster-rp]

示例

显示 Kubernetes 扩展的详细信息

az k8s-extension show --resource-group my-resource-group --cluster-name mycluster --cluster-type connectedClusters --name myextension

必需参数

--cluster-name -c

Kubernetes 群集的名称。

--cluster-type -t

指定 Arc 群集或 AKS 托管群集或 Arc 设备或 provisionedClusters。

属性 值
接受的值: appliances, connectedClusters, managedClusters, provisionedClusters
--name -n

扩展实例的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

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

--cluster-resource-provider --cluster-rp

此 clusterType 的群集资源提供程序名称（provisionedClusters 必需）。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az k8s-extension troubleshoot

预览

此命令处于预览阶段，正在开发中。 参考和支持级别：https://aka.ms/CLI_refstatus

对 Kubernetes 扩展执行诊断检查。

此命令用于对 Kubernetes 扩展进行故障排除。 它收集可用于诊断扩展问题的日志和其他信息。

az k8s-extension troubleshoot --name
                              --namespace-list
                              [--kube-config]
                              [--kube-context]
                              [--skip-ssl-verification]

示例

Kubernetes 扩展疑难解答

az k8s-extension troubleshoot --name extension-name --namespace-list "namespace1,namespace2"

必需参数

--name -n

Kubernetes 扩展的名称。

--namespace-list

要排除故障的命名空间的逗号分隔列表。

可选参数

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

--kube-config

kube 配置文件的路径。 如果未指定，将使用默认 kube 配置文件。

--kube-context

当前计算机的 Kubeconfig 上下文。 如果未指定，将使用 kube 配置文件中的当前上下文。

--skip-ssl-verification

跳过任何群集连接的 SSL 验证。

属性 值
默认值: False
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az k8s-extension update

更新 Kubernetes 扩展的可变属性。

有关 ConfigSettings 和 ConfigProtectedSettings 的更新，请参阅群集扩展服务的文档，以便在更新这些属性之前检查对这些属性的更新。 输出包含必须保护的机密。 请确保在源代码管理中不包含这些机密。 此外，请验证命令或脚本的日志中是否存在任何机密。 有关详细信息，请参阅 http://aka.ms/clisecrets。

az k8s-extension update --cluster-name
                        --cluster-type {appliances, connectedClusters, managedClusters, provisionedClusters}
                        --name
                        --resource-group
                        [--auto-upgrade --auto-upgrade-minor-version {false, true}]
                        [--cluster-resource-provider --cluster-rp]
                        [--config --configuration-settings]
                        [--config-file --config-settings-file]
                        [--config-protected --config-protected-settings]
                        [--config-protected-file --config-protected-settings-file]
                        [--config-settings]
                        [--configuration-protected-settings]
                        [--configuration-protected-settings-file]
                        [--configuration-settings-file]
                        [--no-wait]
                        [--release-train]
                        [--version]
                        [--yes]

示例

更新 Kubernetes 扩展

az k8s-extension update --resource-group my-resource-group --cluster-name mycluster --cluster-type connectedClusters --name myextension --auto-upgrade true/false --version extension-version --release-train stable --configuration-settings settings-key=settings-value --config-protected-settings protected-settings-key=protected-value --config-settings-file=config-settings-file --config-protected-file=protected-settings-file

必需参数

--cluster-name -c

Kubernetes 群集的名称。

--cluster-type -t

指定 Arc 群集或 AKS 托管群集或 Arc 设备或 provisionedClusters。

属性 值
接受的值: appliances, connectedClusters, managedClusters, provisionedClusters
--name -n

扩展实例的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

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

--auto-upgrade --auto-upgrade-minor-version

自动升级扩展实例的次要版本。

属性 值
Parameter group: Version Arguments
接受的值: false, true
--cluster-resource-provider --cluster-rp

此 clusterType 的群集资源提供程序名称（provisionedClusters 必需）。

--config --configuration-settings

配置设置作为 key=value pair。 对每个设置重复参数。 不要将此值用于机密，因为此值在响应中返回。

属性 值
Parameter group: Configuration Arguments
--config-file --config-settings-file

配置设置的 JSON 文件路径。

属性 值
Parameter group: Configuration Arguments
--config-protected --config-protected-settings

将受保护的设置配置为 key=value pair。 对每个设置重复参数。 仅响应中返回键，该值不返回。

属性 值
Parameter group: Configuration Arguments
--config-protected-file --config-protected-settings-file

受配置保护的设置的 JSON 文件路径。

属性 值
Parameter group: Configuration Arguments
--config-settings
已放弃

选项“--config-settings”已弃用，将在将来的版本中删除。 请改用“--configuration-settings”。

配置设置作为 key=value pair。 对每个设置重复参数。 不要将此值用于机密，因为此值在响应中返回。

属性 值
Parameter group: Configuration Arguments
--configuration-protected-settings
已放弃

选项“--configuration-protected-settings”已弃用，将在将来的版本中删除。 请改用“--config-protected-settings”。

将受保护的设置配置为 key=value pair。 对每个设置重复参数。 仅响应中返回键，该值不返回。

属性 值
Parameter group: Configuration Arguments
--configuration-protected-settings-file
已放弃

选项“--configuration-protected-settings-file”已弃用，将在将来的版本中删除。 请改用“--config-protected-file”。

受配置保护的设置的 JSON 文件路径。

属性 值
Parameter group: Configuration Arguments
--configuration-settings-file
已放弃

选项“--configuration-settings-file”已弃用，将在将来的版本中删除。 请改用“--config-settings-file”。

配置设置的 JSON 文件路径。

属性 值
Parameter group: Configuration Arguments
--no-wait

不等待长时间运行的操作完成。

属性 值
默认值: False
--release-train

指定扩展类型的版本序列。

属性 值
Parameter group: Version Arguments
--version

如果未启用 --auto-upgrade-minor-version，请指定要为扩展实例安装的版本。

属性 值
Parameter group: Version Arguments
--yes -y

忽略确认提示。

属性 值
默认值: False
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False