az vme

Note

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

用于管理连接的 kubernetes 群集上的版本托管扩展的命令。

命令

名称	说明	类型	Status
az vme install	安装版本托管扩展。	Extension	GA
az vme list	列出版本托管扩展。	Extension	GA
az vme uninstall	卸载版本托管扩展。	Extension	GA
az vme upgrade	检查版本托管扩展的升级状态。	Extension	GA

az vme install

安装版本托管扩展。

az vme install --cluster-name
               --include {all, microsoft.arc.containerstorage, microsoft.azure.secretstore}
               --resource-group
               [--kube-config]
               [--kube-context]

示例

安装所有版本托管扩展

az vme install --resource-group my-resource-group --cluster-name my-cluster --include all

安装特定版本托管扩展

az vme install --resource-group my-resource-group --cluster-name my-cluster --include microsoft.azure.secretstore

启用功能标志，然后安装特定的版本托管扩展

az vme install --resource-group my-resource-group --cluster-name my-cluster --include microsoft.arc.containerstorage --kube-config /path/to/kubeconfig.yaml --kube-context my-context

必需参数

--cluster-name -c

Kubernetes 群集的名称。

--include -i

要安装的扩展类型。

属性	值
接受的值:	all, microsoft.arc.containerstorage, microsoft.azure.secretstore

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

--kube-config

kube 配置文件的路径。 如果群集已启用功能标志或当前 Kubernetes 配置/上下文设置为此群集，则为可选。

--kube-context

当前计算机的 Kube 上下文。 如果群集已启用功能标志或当前 Kubernetes 配置/上下文设置为此群集，则为可选。

全局参数

--debug

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

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

属性	值
默认值:	False

--output -o

Output format.

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

列出版本托管扩展。

az vme list --cluster-name
            --resource-group

示例

列出版本托管扩展

az vme list --resource-group my-resource-group --cluster-name my-cluster

列出表格式的版本托管扩展

az vme list --resource-group my-resource-group --cluster-name my-cluster --output table

必需参数

--cluster-name -c

Kubernetes 群集的名称。

--resource-group -g

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

全局参数

--debug

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

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

属性	值
默认值:	False

--output -o

Output format.

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

卸载版本托管扩展。

az vme uninstall --cluster-name
                 --include {all, microsoft.arc.containerstorage, microsoft.azure.secretstore}
                 --resource-group
                 [--force]

示例

卸载所有版本托管扩展

az vme uninstall --resource-group my-resource-group --cluster-name my-cluster --include all

卸载特定版本托管扩展

az vme uninstall --resource-group my-resource-group --cluster-name my-cluster --include microsoft.azure.secretstore

必需参数

--cluster-name -c

Kubernetes 群集的名称。

--include -i

要卸载的扩展类型。

属性	值
接受的值:	all, microsoft.arc.containerstorage, microsoft.azure.secretstore

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

--force

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

属性	值
默认值:	False

全局参数

--debug

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

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

属性	值
默认值:	False

--output -o

Output format.

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

检查版本托管扩展的升级状态。

az vme upgrade --cluster-name
               --resource-group
               [--kube-config]
               [--kube-context]
               [--timeout]
               [--wait]

示例

检查版本托管扩展的升级状态

az vme upgrade --resource-group my-resource-group --cluster-name my-cluster --wait

必需参数

--cluster-name -c

Kubernetes 群集的名称。

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

--kube-config

kube 配置文件的路径。 如果群集已启用功能标志或当前 Kubernetes 配置/上下文设置为此群集，则为可选。

--kube-context

当前计算机的 Kube 上下文。 如果群集已启用功能标志或当前 Kubernetes 配置/上下文设置为此群集，则为可选。

--timeout

捆绑升级完成所需的时间（以秒为单位）。

属性	值
默认值:	3600

--wait

等待捆绑包升级完成。

属性	值
默认值:	False

全局参数

--debug

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

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

属性	值
默认值:	False

--output -o

Output format.

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