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

Machine Run Commands - List

服务:: Hybrid Compute

API 版本:: 2025-01-13

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/runCommands?api-version=2025-01-13

具有可选参数:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/runCommands?$expand={$expand}&api-version=2025-01-13

URI 参数

名称	在	必需	类型	说明
machineName	path	True	string pattern: [a-zA-Z0-9-_\.]+	混合计算机的名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。名称不区分大小写。
subscriptionId	path	True	string minLength: 1	目标订阅的 ID。
api-version	query	True	string minLength: 1	用于此作的 API 版本。
$expand	query		string	要应用于作的展开表达式。

响应

名称	类型	说明
200 OK	MachineRunCommandsListResult	还行
Other Status Codes	ErrorResponse	描述作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

GET all Machine Run Commands

示例请求

HTTP

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine/runCommands?api-version=2025-01-13

示例响应

状态代码:: 200

{
  "value": [
    {
      "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/runcommands/myRunCommand_1",
      "name": "myRunCommand_1",
      "location": "eastus2",
      "type": "Microsoft.HybridCompute/machines/runcommands",
      "properties": {
        "source": {
          "script": "Write-Host Hello World!"
        },
        "parameters": [
          {
            "name": "param1",
            "value": "value1"
          },
          {
            "name": "param2",
            "value": "value2"
          }
        ],
        "protectedParameters": [],
        "asyncExecution": false,
        "runAsUser": "user1",
        "timeoutInSeconds": 3600,
        "provisioningState": "Succeeded",
        "instanceView": {
          "executionState": "Succeeded",
          "executionMessage": "",
          "exitCode": 0,
          "output": "Hello World",
          "error": "",
          "startTime": "2023-06-15T20:48:41.4641785+00:00",
          "endTime": "2023-06-15T20:48:41.4641785+00:00"
        }
      }
    },
    {
      "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/runcommands/myRunCommand_2",
      "name": "myRunCommand_2",
      "location": "eastus2",
      "type": "Microsoft.HybridCompute/machines/runcommands",
      "properties": {
        "source": {
          "script": "Get-Process | Where-Object { $_.CPU -gt 10000 }"
        },
        "parameters": [],
        "protectedParameters": [],
        "asyncExecution": false,
        "runAsUser": "userA",
        "timeoutInSeconds": 100,
        "provisioningState": "Succeeded",
        "instanceView": {
          "executionState": "Succeeded",
          "executionMessage": "",
          "exitCode": 0,
          "output": "<some output>",
          "error": "",
          "startTime": "2023-06-15T20:48:41.4641785+00:00",
          "endTime": "2023-06-15T20:48:41.4641785+00:00"
        }
      }
    }
  ]
}

定义

名称	说明
createdByType	创建资源的标识的类型。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
ExecutionState	脚本执行状态。
ExtensionsResourceStatus	实例视图状态。
ExtensionsStatusLevelTypes	级别代码。
MachineRunCommand	描述运行命令
MachineRunCommandInstanceView	计算机运行命令的实例视图。
MachineRunCommandScriptSource	描述用于运行命令的脚本源。仅使用脚本之一 scriptUri、commandId。
MachineRunCommandsListResult	描述运行命令列表结果。
RunCommandInputParameter	描述 run 命令参数的属性。
RunCommandManagedIdentity	包含用户分配的托管标识的 clientId 或 objectId（只使用一个，而不是两者），该标识有权访问 Run Command 中使用的存储 Blob。对于系统分配的标识，请使用空的 RunCommandManagedIdentity 对象。确保在 scriptUri 的情况下存在 Azure 存储 Blob，并且已向托管标识授予对具有 scriptUri blob 的“存储 Blob 数据读取者”角色分配的 Blob 容器的访问权限，并为追加 blob 分配“存储 Blob 数据参与者”（outputBlobUri，errorBlobUri）。对于用户分配的标识，请确保将其添加到 VM 的标识下。有关托管标识和运行命令的详细信息，请参阅 https://aka.ms/ManagedIdentity 和 https://aka.ms/RunCommandManaged。
systemData	与创建和上次修改资源相关的元数据。

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

ExecutionState

枚举

脚本执行状态。

值	说明
Unknown
Pending
Running
Failed
Succeeded
TimedOut
Canceled

ExtensionsResourceStatus

Object

实例视图状态。

名称	类型	说明
code	string	状态代码。
displayStatus	string	状态的简短可本地化标签。
level	ExtensionsStatusLevelTypes	级别代码。
message	string	详细状态消息，包括警报和错误消息。
time	string (date-time)	状态的时间。

ExtensionsStatusLevelTypes

枚举

级别代码。

值	说明
Info
Warning
Error

MachineRunCommand

Object

描述运行命令

名称	类型	默认值	说明
id	string		资源的完全限定资源 ID。示例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string		资源所在的地理位置
name	string		资源的名称
properties.asyncExecution	boolean	False	自选。如果设置为 true，则脚本启动后预配将立即完成，并且不会等待脚本完成。
properties.errorBlobManagedIdentity	RunCommandManagedIdentity		用户分配的托管标识有权访问 errorBlobUri 存储 Blob。在系统分配的标识的情况下使用空对象。确保已向托管标识授予对具有“存储 Blob 数据参与者”角色分配的 Blob 容器的访问权限。对于用户分配的标识，请确保将其添加到 VM 的标识下。有关托管标识和运行命令的详细信息，请参阅 https://aka.ms/ManagedIdentity 和 https://aka.ms/RunCommandManaged
properties.errorBlobUri	string		指定将上传脚本错误流的 Azure 存储 Blob。使用具有读取、追加、创建、写入访问权限的 SAS URI 或使用托管标识提供对 Blob 的 VM 访问权限。引用 errorBlobManagedIdentity 参数。
properties.instanceView	MachineRunCommandInstanceView		计算机运行命令实例视图。
properties.outputBlobManagedIdentity	RunCommandManagedIdentity		用户分配的托管标识有权访问 outputBlobUri 存储 Blob。在系统分配的标识的情况下使用空对象。确保已向托管标识授予对具有“存储 Blob 数据参与者”角色分配的 Blob 容器的访问权限。对于用户分配的标识，请确保将其添加到 VM 的标识下。有关托管标识和运行命令的详细信息，请参阅 https://aka.ms/ManagedIdentity 和 https://aka.ms/RunCommandManaged
properties.outputBlobUri	string		指定将上传脚本输出流的 Azure 存储 Blob。使用具有读取、追加、创建、写入访问权限的 SAS URI 或使用托管标识提供对 Blob 的 VM 访问权限。引用 outputBlobManagedIdentity 参数。
properties.parameters	RunCommandInputParameter[]		脚本使用的参数。
properties.protectedParameters	RunCommandInputParameter[]		脚本使用的参数。
properties.provisioningState	string		预配状态，仅出现在响应中。
properties.runAsPassword	string		在执行 run 命令时，指定计算机上的用户帐户密码。
properties.runAsUser	string		在执行 run 命令时，指定计算机上的用户帐户。
properties.source	MachineRunCommandScriptSource		运行命令脚本的源。
properties.timeoutInSeconds	integer (int32)		执行 run 命令的超时（以秒为单位）。
systemData	systemData		包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object		资源标记。
type	string		资源的类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

MachineRunCommandInstanceView

Object

计算机运行命令的实例视图。

名称	类型	说明
endTime	string (date-time)	脚本结束时间。
error	string	脚本错误流。
executionMessage	string	传达脚本配置错误或执行消息。
executionState	ExecutionState	脚本执行状态。
exitCode	integer (int32)	退出从脚本执行返回的代码。
output	string	脚本输出流。
startTime	string (date-time)	脚本开始时间。
statuses	ExtensionsResourceStatus[]	状态信息。

MachineRunCommandScriptSource

Object

描述用于运行命令的脚本源。仅使用脚本之一 scriptUri、commandId。

名称	类型	说明
commandId	string	指定预定义内置脚本的 commandId。
script	string	指定要在计算机上执行的脚本内容。
scriptUri	string	指定脚本下载位置。它可以是具有读取访问权限或公共 URI 的 Azure 存储 Blob 的 SAS URI。
scriptUriManagedIdentity	RunCommandManagedIdentity	对于 Azure 存储 Blob，用户分配的托管标识有权访问 scriptUri。在系统分配的标识的情况下使用空对象。确保 Azure 存储 Blob 存在，并且已向托管标识授予对具有“存储 Blob 数据读取者”角色分配的 Blob 容器的访问权限。对于用户分配的标识，请确保将其添加到 VM 的标识下。有关托管标识和运行命令的详细信息，请参阅 https://aka.ms/ManagedIdentity 和 https://aka.ms/RunCommandManaged。

MachineRunCommandsListResult

Object

描述运行命令列表结果。

名称	类型	说明
nextLink	string	用于提取下一页的运行命令的 URI。调用 ListNext（）以提取下一页的运行命令。
value	MachineRunCommand[]	运行命令的列表

RunCommandInputParameter

Object

描述 run 命令参数的属性。

名称	类型	说明
name	string	run 命令参数名称。
value	string	run 命令参数值。

RunCommandManagedIdentity

Object

包含用户分配的托管标识的 clientId 或 objectId（只使用一个，而不是两者），该标识有权访问 Run Command 中使用的存储 Blob。对于系统分配的标识，请使用空的 RunCommandManagedIdentity 对象。确保在 scriptUri 的情况下存在 Azure 存储 Blob，并且已向托管标识授予对具有 scriptUri blob 的“存储 Blob 数据读取者”角色分配的 Blob 容器的访问权限，并为追加 blob 分配“存储 Blob 数据参与者”（outputBlobUri，errorBlobUri）。对于用户分配的标识，请确保将其添加到 VM 的标识下。有关托管标识和运行命令的详细信息，请参阅 https://aka.ms/ManagedIdentity 和 https://aka.ms/RunCommandManaged。

名称	类型	说明
clientId	string	用户分配的托管标识的客户端 ID （GUID 值）。如果未提供，则不应使用 ObjectId。
objectId	string	用户分配的托管标识的对象 ID （GUID 值）。如果未提供，则不应使用 ClientId。

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

通过

Machine Run Commands - List

URI 参数

响应

安全性

azure_auth

作用域

示例

GET all Machine Run Commands

示例请求

示例响应

定义

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExecutionState

ExtensionsResourceStatus

ExtensionsStatusLevelTypes

MachineRunCommand

MachineRunCommandInstanceView

MachineRunCommandScriptSource

MachineRunCommandsListResult

RunCommandInputParameter

RunCommandManagedIdentity

systemData