az aks extension

Note

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

用于管理 Kubernetes 群集中的扩展的命令。

命令

名称	说明	类型	Status
az aks extension create	在托管群集上创建群集扩展实例。 请参阅末尾的示例，了解如何创建群集扩展。	Extension	GA
az aks extension delete	删除群集扩展。	Extension	GA
az aks extension list	列出群集扩展。	Extension	GA
az aks extension show	显示群集扩展。	Extension	GA
az aks extension type	管理Azure Kubernetes 服务中的扩展类型。	Extension	GA
az aks extension type list	列出可用的群集扩展类型。 用于筛选的属性包括 kubernetes 版本、群集的位置。	Extension	GA
az aks extension type show	显示群集扩展类型的属性。 用于筛选的属性包括 kubernetes 版本、群集的位置。	Extension	GA
az aks extension type version	在 Azure Kubernetes 服务 中管理扩展类型版本。	Extension	GA
az aks extension type version list	列出可用的群集扩展类型版本。 用于筛选的属性包括 kubernetes 版本、群集的位置。	Extension	GA
az aks extension type version show	显示与群集扩展类型版本关联的属性。 用于筛选的属性包括 kubernetes 版本、群集的位置。	Extension	GA
az aks extension update	更新群集扩展的可变属性。	Extension	GA

az aks extension create

在托管群集上创建群集扩展实例。 请参阅末尾的示例，了解如何创建群集扩展。

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

az aks extension create --cluster-name
                        --extension-type
                        --name
                        --resource-group
                        [--acquire-policy-token]
                        [--change-reference]
                        [--config --configuration-settings]
                        [--config-file --config-settings-file]
                        [--config-protected --config-protected-settings]
                        [--config-protected-file --config-protected-settings-file]
                        [--no-wait]
                        [--release-namespace]
                        [--scope {cluster, namespace}]
                        [--target-namespace]

示例

在具有所需参数的 AKS 群集上安装群集扩展

az aks extension create --resource-group my-resource-group --cluster-name mycluster --name myextension --extension-type microsoft.flux

使用可选参数配置设置安装群集扩展

az aks extension create --resource-group abc --cluster-name test --name flux --extension-type microsoft.flux --config useKubeletIdentity=true

必需参数

--cluster-name -c

AKS 群集的名称。

--extension-type -t

扩展类型的名称。

--name -n

扩展实例的名称。

--resource-group -g

资源组的名称。

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--acquire-policy-token

为此资源操作自动获取Azure Policy令牌。

属性	值
参数组:	Global Policy Arguments

--change-reference

此资源操作的相关更改引用 ID。

属性	值
参数组:	Global Policy Arguments

--config --configuration-settings

配置设置作为 key=value pair。

配置设置作为 key=value pair。 对每个设置重复参数。 不要将此值用于机密，因为此值在响应中返回。 如果未指定，则默认值为 None。

属性	值
参数组:	Configuration Arguments

--config-file --config-settings-file

配置设置的 JSON 文件路径。

配置设置的 JSON 文件路径。 如果未指定，则默认值为 None。

属性	值
参数组:	Configuration Arguments

--config-protected --config-protected-settings

将受保护的设置配置为 key=value pair。

配置设置作为 key=value pair。 对每个设置重复参数。 仅响应中返回键，该值不返回。 如果未指定，则默认值为 None。

属性	值
参数组:	Configuration Arguments

--config-protected-file --config-protected-settings-file

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

受配置保护的设置的 JSON 文件路径。 如果未指定，则默认值为 None。

属性	值
参数组:	Configuration Arguments

--no-wait

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

属性	值
默认值:	False

--release-namespace

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

--scope

指定扩展类型的作用域，采用命名空间或群集作为范围。

指定扩展类型的作用域，采用命名空间或群集作为范围（如果未指定），将使用扩展类型注册中设置的默认范围。

属性	值
接受的值:	cluster, namespace

--target-namespace

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

全局参数

--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 aks extension delete

删除群集扩展。

az aks extension delete --cluster-name
                        --name
                        --resource-group
                        [--acquire-policy-token]
                        [--change-reference]
                        [--force]
                        [--no-wait]
                        [--yes]

示例

删除 AKS 群集上的现有群集扩展

az aks extension delete --resource-group resource-group --cluster-name cluster --name ext

使用可选参数删除 AKS 群集上的现有群集扩展

az aks extension delete --resource-group resource-group --cluster-name cluster --name ext --yes --force

必需参数

--cluster-name -c

AKS 群集的名称。

--name -n

扩展实例的名称。

--resource-group -g

资源组的名称。

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--acquire-policy-token

为此资源操作自动获取Azure Policy令牌。

属性	值
参数组:	Global Policy Arguments

--change-reference

此资源操作的相关更改引用 ID。

属性	值
参数组:	Global Policy Arguments

--force

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

指定是否强制从群集中删除扩展（如果未指定）默认值为 false。

属性	值
默认值:	False

--no-wait

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

属性	值
默认值:	False

--yes -y

忽略确认提示。

忽略确认提示。 如果未指定，则默认值为 false。

属性	值
默认值:	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 aks extension list

列出群集扩展。

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

az aks extension list --cluster-name
                      --resource-group

示例

列出群集上的所有群集扩展

az aks extension list --resource-group <group> --cluster-name <name>

必需参数

--cluster-name -c

AKS 群集的名称。

--resource-group -g

资源组的名称。

全局参数

--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 aks extension show

显示群集扩展。

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

az aks extension show --cluster-name
                      --name
                      --resource-group

示例

显示群集扩展的详细信息

az aks extension show --resource-group my-resource-group --cluster-name mycluster --name myextension

必需参数

--cluster-name -c

AKS 群集的名称。

--name -n

扩展实例的名称。

--resource-group -g

资源组的名称。

全局参数

--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 aks extension update

更新群集扩展的可变属性。

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

az aks extension update --cluster-name
                        --name
                        --resource-group
                        [--acquire-policy-token]
                        [--change-reference]
                        [--config --configuration-settings]
                        [--config-file --config-settings-file]
                        [--config-protected --config-protected-settings]
                        [--config-protected-file --config-protected-settings-file]
                        [--no-wait]
                        [--yes]

示例

更新 AKS 群集上的群集扩展

az aks extension update --resource-group my-resource-group --cluster-name mycluster --name myextension

使用包含可选参数更新 AKS 群集上的群集扩展

az aks extension update --resource-group my-resource-group --cluster-name mycluster --name myextension --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

AKS 群集的名称。

--name -n

扩展实例的名称。

--resource-group -g

资源组的名称。

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--acquire-policy-token

为此资源操作自动获取Azure Policy令牌。

属性	值
参数组:	Global Policy Arguments

--change-reference

此资源操作的相关更改引用 ID。

属性	值
参数组:	Global Policy Arguments

--config --configuration-settings

配置设置作为 key=value pair。

配置设置作为 key=value pair。 对每个设置重复参数。 不要将此值用于机密，因为此值在响应中返回。 如果未指定，则默认值为 None。

属性	值
参数组:	Configuration Arguments

--config-file --config-settings-file

配置设置的 JSON 文件路径。

配置设置的 JSON 文件路径。 如果未指定，则默认值为 None。

属性	值
参数组:	Configuration Arguments

--config-protected --config-protected-settings

将受保护的设置配置为 key=value pair。

配置设置作为 key=value pair。 对每个设置重复参数。 仅响应中返回键，该值不返回。 如果未指定，则默认值为 Non。

属性	值
参数组:	Configuration Arguments

--config-protected-file --config-protected-settings-file

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

受配置保护的设置的 JSON 文件路径。 如果未指定，则默认值为 None。

属性	值
参数组:	Configuration Arguments

--no-wait

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

属性	值
默认值:	False

--yes -y

忽略确认提示。

忽略确认提示。 如果未指定，则默认值为 false。

属性	值
默认值:	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