通过

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

az connectedmachine run-command

  • 预览

Note

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

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

管理 Azure Arc-Enabled 服务器上的运行命令。

命令

名称 说明 类型 Status
az connectedmachine run-command create

创建运行命令。

 Extension Preview
az connectedmachine run-command delete

删除运行命令。

 Extension Preview
az connectedmachine run-command list

获取非 Azure 计算机的所有运行命令。

 Extension Preview
az connectedmachine run-command show

获取运行命令。

 Extension Preview
az connectedmachine run-command update

用于创建或更新运行命令的更新作。

 Extension Preview
az connectedmachine run-command wait

将 CLI 置于等待状态，直到满足条件。

 Extension Preview

az connectedmachine run-command create

预览

命令组“az connectedmachine run-command”处于预览状态，正在开发中。 参考和支持级别：https://aka.ms/CLI_refstatus

创建运行命令。

az connectedmachine run-command create --machine-name
                                       --name --run-command-name
                                       --resource-group
                                       [--async-execution {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--command-id]
                                       [--error-blob-id --error-blob-managed-identity]
                                       [--error-blob-uri]
                                       [--location]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--output-blob-id --output-blob-managed-identity]
                                       [--output-blob-uri]
                                       [--parameters]
                                       [--protected-parameters]
                                       [--run-as-password]
                                       [--run-as-user]
                                       [--script]
                                       [--script-uri]
                                       [--script-uri-id --script-uri-managed-identity]
                                       [--tags]
                                       [--timeout-in-seconds]

示例

用于运行命令创建的示例命令

az connectedmachine run-command create --resource-group myResourceGroup --location "WestUS" --async false --parameters "[{"name":"param1","value":"value1"}]" --password "<runAsPassword>" --user "user1" --script "Write-Host Hello World!" --timeout 3600 --name myRunCommand --machine-name myMachine --subscription mySubscription
az connectedmachine run-command create --resource-group myResourceGroup --location "WestUS" --script "Write-Host Hello World!" --name myRunCommand --machine-name myMachine --output-uri "outputuri" --subscription mySubscription

必需参数

--machine-name

混合计算机的名称。

--name --run-command-name -n

run 命令的名称。

--resource-group -g

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

可选参数

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

--async-execution

Optional. 如果设置为 true，则脚本启动后预配将立即完成，并且不会等待脚本完成。

属性 值
参数组: Properties Arguments
默认值: False
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--command-id

指定预定义内置脚本的 commandId。

属性 值
参数组: Source Arguments
--error-blob-id --error-blob-managed-identity

用户分配的托管标识有权访问 errorBlobUri 存储 Blob。 在系统分配的标识的情况下使用空对象。 确保已向托管标识授予对具有“存储 Blob 数据参与者”角色分配的 Blob 容器的访问权限。 对于用户分配的标识，请确保将其添加到 VM 的标识下。 有关托管标识和运行命令的详细信息，请参阅 https://aka.ms/ManagedIdentity 和 https://aka.ms/RunCommandManaged 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
参数组: Properties Arguments
--error-blob-uri

指定将上传脚本错误流的 Azure 存储 Blob。 使用具有读取、追加、创建、写入访问权限的 SAS URI 或使用托管标识提供对 Blob 的 VM 访问权限。 引用 errorBlobManagedIdentity 参数。

属性 值
参数组: Properties Arguments
--location -l

未指定资源所在的地理位置，将使用资源组的位置。

属性 值
参数组: RunCommandProperties Arguments
--no-wait

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

属性 值
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--output-blob-id --output-blob-managed-identity

用户分配的托管标识有权访问 outputBlobUri 存储 Blob。 在系统分配的标识的情况下使用空对象。 确保已向托管标识授予对具有“存储 Blob 数据参与者”角色分配的 Blob 容器的访问权限。 对于用户分配的标识，请确保将其添加到 VM 的标识下。 有关托管标识和运行命令的详细信息，请参阅 https://aka.ms/ManagedIdentity 和 https://aka.ms/RunCommandManaged 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
参数组: Properties Arguments
--output-blob-uri

指定将上传脚本输出流的 Azure 存储 Blob。 使用具有读取、追加、创建、写入访问权限的 SAS URI 或使用托管标识提供对 Blob 的 VM 访问权限。 引用 outputBlobManagedIdentity 参数。

属性 值
参数组: Properties Arguments
--parameters

脚本使用的参数。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
参数组: Properties Arguments
--protected-parameters

脚本使用的参数。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
参数组: Properties Arguments
--run-as-password

在执行 run 命令时，指定计算机上的用户帐户密码。

属性 值
参数组: Properties Arguments
--run-as-user

在执行 run 命令时，指定计算机上的用户帐户。

属性 值
参数组: Properties Arguments
--script

指定要在计算机上执行的脚本内容。

属性 值
参数组: Source Arguments
--script-uri

指定脚本下载位置。 它可以是具有读取访问权限或公共 URI 的 Azure 存储 Blob 的 SAS URI。

属性 值
参数组: Source Arguments
--script-uri-id --script-uri-managed-identity

对于 Azure 存储 Blob，用户分配的托管标识有权访问 scriptUri。 在系统分配的标识的情况下使用空对象。 确保 Azure 存储 Blob 存在，并且已向托管标识授予对具有“存储 Blob 数据读取者”角色分配的 Blob 容器的访问权限。 对于用户分配的标识，请确保将其添加到 VM 的标识下。 有关托管标识和运行命令的详细信息，请参阅 https://aka.ms/ManagedIdentity 和 https://aka.ms/RunCommandManaged。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
参数组: Source Arguments
--tags

资源标记。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
参数组: RunCommandProperties Arguments
--timeout-in-seconds

执行 run 命令的超时（以秒为单位）。

属性 值
参数组: Properties 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 connectedmachine run-command delete

预览

命令组“az connectedmachine run-command”处于预览状态，正在开发中。 参考和支持级别：https://aka.ms/CLI_refstatus

删除运行命令。

az connectedmachine run-command delete [--ids]
                                       [--machine-name]
                                       [--name --run-command-name]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--resource-group]
                                       [--subscription]
                                       [--yes]

示例

用于运行命令删除的示例命令

az connectedmachine run-command delete --resource-group myResourceGroup --machine-name myMachine --name myRunCommand

可选参数

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

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性 值
参数组: Resource Id Arguments
--machine-name

混合计算机的名称。

属性 值
参数组: Resource Id Arguments
--name --run-command-name -n

run 命令的名称。

属性 值
参数组: Resource Id Arguments
--no-wait

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

属性 值
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

属性 值
参数组: Resource Id Arguments
--subscription

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

属性 值
参数组: Resource Id 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/。

--verbose

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

属性 值
默认值: False

az connectedmachine run-command list

预览

命令组“az connectedmachine run-command”处于预览状态，正在开发中。 参考和支持级别：https://aka.ms/CLI_refstatus

获取非 Azure 计算机的所有运行命令。

az connectedmachine run-command list --machine-name
                                     --resource-group
                                     [--expand]
                                     [--max-items]
                                     [--next-token]

示例

Run-command 列表的示例命令

az connectedmachine run-command list --resource-group myResourceGroup --machine-name myMachine --subscription mySubscription

必需参数

--machine-name

混合计算机的名称。

--resource-group -g

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

可选参数

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

--expand

要应用于作的展开表达式。

--max-items

命令输出中要返回的项总数。 如果可用的项总数大于指定的值，则会在命令的输出中提供令牌。 若要恢复分页，请在后续命令的 --next-token 参数中提供令牌值。

属性 值
参数组: Pagination Arguments
--next-token

用于指定开始分页的位置的令牌。 这是先前截断的响应中的令牌值。

属性 值
参数组: Pagination 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 connectedmachine run-command show

预览

命令组“az connectedmachine run-command”处于预览状态，正在开发中。 参考和支持级别：https://aka.ms/CLI_refstatus

获取运行命令。

az connectedmachine run-command show [--ids]
                                     [--machine-name]
                                     [--name --run-command-name]
                                     [--resource-group]
                                     [--subscription]

示例

run-command show 的示例命令

az connectedmachine run-command show --resource-group myResourceGroup --machine-name myMachine --name myRunCommand

可选参数

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

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性 值
参数组: Resource Id Arguments
--machine-name

混合计算机的名称。

属性 值
参数组: Resource Id Arguments
--name --run-command-name -n

run 命令的名称。

属性 值
参数组: Resource Id Arguments
--resource-group -g

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

属性 值
参数组: Resource Id Arguments
--subscription

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

属性 值
参数组: Resource Id Arguments
全局参数
--debug

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

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

显示此帮助消息并退出。

--only-show-errors

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

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

输出格式。

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

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

--verbose

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

属性 值
默认值: False

az connectedmachine run-command update

预览

命令组“az connectedmachine run-command”处于预览状态，正在开发中。 参考和支持级别：https://aka.ms/CLI_refstatus

用于创建或更新运行命令的更新作。

az connectedmachine run-command update [--add]
                                       [--async-execution {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--error-blob-id --error-blob-managed-identity]
                                       [--error-blob-uri]
                                       [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--ids]
                                       [--machine-name]
                                       [--name --run-command-name]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--output-blob-id --output-blob-managed-identity]
                                       [--output-blob-uri]
                                       [--parameters]
                                       [--protected-parameters]
                                       [--remove]
                                       [--resource-group]
                                       [--run-as-password]
                                       [--run-as-user]
                                       [--set]
                                       [--source]
                                       [--subscription]
                                       [--tags]
                                       [--timeout-in-seconds]

示例

run-command update 的示例命令

az connetcedmachine run-command update --resource-group myResourceGroup --name myRunCommand --machine-name myMachine --subscription mySubscription --tags Tag1=Value1

可选参数

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

--add

通过指定路径和键值对将对象添加到对象列表。 示例：--add property.listProperty <key=value, string or JSON string>。

属性 值
参数组: Generic Update Arguments
--async-execution

Optional. 如果设置为 true，则脚本启动后预配将立即完成，并且不会等待脚本完成。

属性 值
参数组: Properties Arguments
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--error-blob-id --error-blob-managed-identity

用户分配的托管标识有权访问 errorBlobUri 存储 Blob。 在系统分配的标识的情况下使用空对象。 确保已向托管标识授予对具有“存储 Blob 数据参与者”角色分配的 Blob 容器的访问权限。 对于用户分配的标识，请确保将其添加到 VM 的标识下。 有关托管标识和运行命令的详细信息，请参阅 https://aka.ms/ManagedIdentity 和 https://aka.ms/RunCommandManaged 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
参数组: Properties Arguments
--error-blob-uri

指定将上传脚本错误流的 Azure 存储 Blob。 使用具有读取、追加、创建、写入访问权限的 SAS URI 或使用托管标识提供对 Blob 的 VM 访问权限。 引用 errorBlobManagedIdentity 参数。

属性 值
参数组: Properties Arguments
--force-string

使用“set”或“add”时，保留字符串文本，而不是尝试转换为 JSON。

属性 值
参数组: Generic Update Arguments
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性 值
参数组: Resource Id Arguments
--machine-name

混合计算机的名称。

属性 值
参数组: Resource Id Arguments
--name --run-command-name -n

run 命令的名称。

属性 值
参数组: Resource Id Arguments
--no-wait

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

属性 值
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--output-blob-id --output-blob-managed-identity

用户分配的托管标识有权访问 outputBlobUri 存储 Blob。 在系统分配的标识的情况下使用空对象。 确保已向托管标识授予对具有“存储 Blob 数据参与者”角色分配的 Blob 容器的访问权限。 对于用户分配的标识，请确保将其添加到 VM 的标识下。 有关托管标识和运行命令的详细信息，请参阅 https://aka.ms/ManagedIdentity 和 https://aka.ms/RunCommandManaged 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
参数组: Properties Arguments
--output-blob-uri

指定将上传脚本输出流的 Azure 存储 Blob。 使用具有读取、追加、创建、写入访问权限的 SAS URI 或使用托管标识提供对 Blob 的 VM 访问权限。 引用 outputBlobManagedIdentity 参数。

属性 值
参数组: Properties Arguments
--parameters

脚本使用的参数。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
参数组: Properties Arguments
--protected-parameters

脚本使用的参数。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
参数组: Properties Arguments
--remove

从列表中删除属性或元素。 示例： --remove property.list <indexToRemove> OR --remove propertyToRemove.

属性 值
参数组: Generic Update Arguments
--resource-group -g

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

属性 值
参数组: Resource Id Arguments
--run-as-password

在执行 run 命令时，指定计算机上的用户帐户密码。

属性 值
参数组: Properties Arguments
--run-as-user

在执行 run 命令时，指定计算机上的用户帐户。

属性 值
参数组: Properties Arguments
--set

通过指定要设置的属性路径和值来更新对象。 示例：--set property1.property2=<value>。

属性 值
参数组: Generic Update Arguments
--source

运行命令脚本的源。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
参数组: Properties Arguments
--subscription

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

属性 值
参数组: Resource Id Arguments
--tags

资源标记。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
参数组: RunCommandProperties Arguments
--timeout-in-seconds

执行 run 命令的超时（以秒为单位）。

属性 值
参数组: Properties Arguments
全局参数
--debug

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

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

显示此帮助消息并退出。

--only-show-errors

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

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

输出格式。

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

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

--verbose

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

属性 值
默认值: False

az connectedmachine run-command wait

预览

命令组“az connectedmachine run-command”处于预览状态，正在开发中。 参考和支持级别：https://aka.ms/CLI_refstatus

将 CLI 置于等待状态，直到满足条件。

az connectedmachine run-command wait [--created]
                                     [--custom]
                                     [--deleted]
                                     [--exists]
                                     [--ids]
                                     [--interval]
                                     [--machine-name]
                                     [--name --run-command-name]
                                     [--resource-group]
                                     [--subscription]
                                     [--timeout]
                                     [--updated]

可选参数

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

--created

等待在“Succeeded”中使用“provisioningState”创建。

属性 值
参数组: Wait Condition Arguments
默认值: False
--custom

等待条件满足自定义 JMESPath 查询。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

属性 值
参数组: Wait Condition Arguments
--deleted

等到删除为止。

属性 值
参数组: Wait Condition Arguments
默认值: False
--exists

等待资源存在。

属性 值
参数组: Wait Condition Arguments
默认值: False
--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性 值
参数组: Resource Id Arguments
--interval

轮询间隔（以秒为单位）。

属性 值
参数组: Wait Condition Arguments
默认值: 30
--machine-name

混合计算机的名称。

属性 值
参数组: Resource Id Arguments
--name --run-command-name -n

run 命令的名称。

属性 值
参数组: Resource Id Arguments
--resource-group -g

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

属性 值
参数组: Resource Id Arguments
--subscription

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

属性 值
参数组: Resource Id Arguments
--timeout

最大等待（以秒为单位）。

属性 值
参数组: Wait Condition Arguments
默认值: 3600
--updated

等到 provisioningState 更新为“Succeeded”。

属性 值
参数组: Wait Condition Arguments
默认值: False
全局参数
--debug

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

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

显示此帮助消息并退出。

--only-show-errors

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

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

输出格式。

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

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

--verbose

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

属性 值
默认值: False