共用方式為

azcmagent CLI 参考

Azure Connected Machine 代理命令行工具 azcmagent可帮助你配置、管理和排查服务器与 Azure Arc 的连接问题。 azcmagent CLI 随 Azure Connected Machine 代理一起安装,并控制特定于运行它的服务器的作。 将服务器连接到 Azure Arc 后,可以使用 Azure CLIAzure PowerShell 模块来启用扩展、管理标记,并在服务器资源上执行其他作。

除非另行指定,否则命令语法和标志表示最新版本的 Azure Connected Machine 代理中的可用选项。 有关详细信息,请参阅 Azure Connected Machine 代理的新增功能

若要获取有关 CLI 中 azcmagent 可用的单个命令的详细信息,请运行 azcmagent COMMANDNAME --help 或查看以下参考页:

命令

命令 目的
azcmagent check 运行 Azure Arc 终结点的网络连接检查
azcmagent config 管理代理设置。
azcmagent connect 将服务器连接到 Azure Arc。
azcmagent disconnect 断开服务器与 Azure Arc 的连接。
azcmagent genkey 生成用于异步载入的公钥-私钥对。
azcmagent help 获取有关命令的帮助。
azcmagent license 显示最终用户许可协议。
azcmagent logs 收集日志以排查代理问题。
azcmagent show 显示代理状态。
azcmagent version 显示代理版本。
azcmagent partnerconfig 仅供内部使用。

常见标志

所有 azcmagent 命令都支持以下标志。 若要查看某个命令是否支持其他标志,请检查其引用页。

--config

接受包含命令输入的 JSON 或 YAML 文件的路径。 配置文件应包含一系列键值对,其中键与可用的命令行选项匹配。 例如,若要传入 --verbose 标志,配置文件将如下所示:

{
    "verbose": true
}

如果在命令调用和配置文件中找到命令行选项,则命令行中指定的值优先。

-h--help

获取有关当前命令的帮助,包括其语法和命令行选项。

-j--json

以 JSON 格式输出命令结果。

--log-stderr

将错误和详细消息重定向到标准错误 (stderr) 流。 默认情况下,所有输出都发送到标准输出 (stdout) 流。

--no-color

禁用不支持 ANSI 颜色的终端的颜色输出。

-v--verbose

在执行命令时显示更详细的日志记录信息。 用于排查运行命令时出现的问题。

常见问题解答

如何安装 azcmagent CLI?

azcmagent CLI 与 Azure Connected Machine 代理捆绑在一起。 若要了解安装和配置代理的方法,请参阅 Azure Connected Machine 代理部署选项

CLI 安装在何处?

在 Windows作系统上,CLI 安装在 %PROGRAMFILES%\AzureConnectedMachineAgent\azcmagent.exe。 在安装过程中,此路径会自动添加到系统 PATH 变量。 可能需要关闭并重新打开主机以刷新 PATH 变量,并且能够在不指定完整路径的情况下运行 azcmagent

在 Linux作系统上安装 CLI /opt/azcmagent/bin/azcmagent

适用于已启用 Azure Arc 的服务器的 azcmagent CLI 与 Azure CLI 之间的区别是什么?

azcmagent CLI 用于配置本地代理。 它负责将代理连接到 Azure、断开代理连接以及配置本地设置(如代理 URL 和安全功能)。

连接代理后,Azure CLI 和其他管理体验用于与 Azure 中的 Azure Arc 资源交互。 这些工具可帮助你管理扩展、将资源移动到另一个订阅或资源组,并远程更改 Arc 服务器的某些设置。