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

VirtualMachineRunCommand interface

包:

@azure/arm-compute

描述虚拟机运行命令。

扩展

Resource

属性

asyncExecution	可选。 如果设置为 true，则脚本启动后，预配将立即完成，并且不会等待脚本完成。
errorBlobManagedIdentity	有权访问 errorBlobUri 存储 Blob 的用户分配的托管标识。 对于系统分配的标识，请使用空对象。 确保已向托管标识授予对 Blob 容器的访问权限，并分配了“存储 Blob 数据参与者”角色。 对于用户分配的标识，请确保将其添加到 VM 的标识下。 有关托管标识和运行命令的详细信息，请参阅 https://aka.ms/ManagedIdentity 和 https://aka.ms/RunCommandManaged
errorBlobUri	指定要在其中上传脚本错误流的 Azure 存储 Blob。 使用具有读取、追加、创建、写入访问权限的 SAS URI，或使用托管标识为 VM 提供对 Blob 的访问权限。 请参阅 errorBlobManagedIdentity 参数。
instanceView	虚拟机运行命令实例视图。 注意：此属性不会被序列化。 它只能由服务器填充。
outputBlobManagedIdentity	有权访问 outputBlobUri 存储 Blob 的用户分配的托管标识。 对于系统分配的标识，请使用空对象。 确保已向托管标识授予对 Blob 容器的访问权限，并分配了“存储 Blob 数据参与者”角色。 对于用户分配的标识，请确保将其添加到 VM 的标识下。 有关托管标识和运行命令的详细信息，请参阅 https://aka.ms/ManagedIdentity 和 https://aka.ms/RunCommandManaged
outputBlobUri	指定要在其中上传脚本输出流的 Azure 存储 Blob。 使用具有读取、追加、创建、写入访问权限的 SAS URI，或使用托管标识为 VM 提供对 Blob 的访问权限。 请参阅 outputBlobManagedIdentity 参数。
parameters	脚本使用的参数。
protectedParameters	脚本使用的参数。
provisioningState	预配状态，仅显示在响应中。 如果 treatFailureAsDeploymentFailure 设置为 true，则脚本中的任何失败都将使部署失败，ProvisioningState 将标记为“失败”。 如果 treatFailureAsDeploymentFailure 设置为 false，ProvisioningState 将仅反映 run 命令是否由扩展平台运行，它不会指示脚本在脚本失败时是否失败。 在脚本失败时，请参阅 run 命令的实例视图，以查看 executionMessage、输出、错误： https://aka.ms/runcommandmanaged#get-execution-status-and-results 注意：此属性不会被序列化。 它只能由服务器填充。
runAsPassword	指定执行 run 命令时 VM 上的用户帐户密码。
runAsUser	指定执行 run 命令时 VM 上的用户帐户。
source	运行命令脚本的源。
timeoutInSeconds	执行 run 命令的超时（秒）。
treatFailureAsDeploymentFailure	可选。 如果设置为 true，则脚本中的任何失败都将使部署失败，ProvisioningState 将标记为“失败”。 如果设置为 false，ProvisioningState 将仅反映 run 命令是否由扩展平台运行，它不会指示脚本在脚本失败时是否失败。 在脚本失败的情况下，请参阅 run 命令的实例视图，以查看 executionMessage、output、error： https://aka.ms/runcommandmanaged#get-execution-status-and-results

继承属性

id	资源 ID 注意：此属性不会被序列化。 它只能由服务器填充。
location	资源位置
name	资源名称 注意：此属性不会被序列化。 它只能由服务器填充。
tags	资源标记
type	资源类型 注意：此属性不会被序列化。 它只能由服务器填充。

属性详细信息

asyncExecution

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

asyncExecution?: boolean

属性值

boolean

errorBlobManagedIdentity

有权访问 errorBlobUri 存储 Blob 的用户分配的托管标识。 对于系统分配的标识，请使用空对象。 确保已向托管标识授予对 Blob 容器的访问权限，并分配了“存储 Blob 数据参与者”角色。 对于用户分配的标识，请确保将其添加到 VM 的标识下。 有关托管标识和运行命令的详细信息，请参阅 https://aka.ms/ManagedIdentity 和 https://aka.ms/RunCommandManaged

errorBlobManagedIdentity?: RunCommandManagedIdentity

属性值

RunCommandManagedIdentity

errorBlobUri

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

errorBlobUri?: string

属性值

string

instanceView

虚拟机运行命令实例视图。 注意：此属性不会被序列化。 它只能由服务器填充。

instanceView?: VirtualMachineRunCommandInstanceView

属性值

VirtualMachineRunCommandInstanceView

outputBlobManagedIdentity

有权访问 outputBlobUri 存储 Blob 的用户分配的托管标识。 对于系统分配的标识，请使用空对象。 确保已向托管标识授予对 Blob 容器的访问权限，并分配了“存储 Blob 数据参与者”角色。 对于用户分配的标识，请确保将其添加到 VM 的标识下。 有关托管标识和运行命令的详细信息，请参阅 https://aka.ms/ManagedIdentity 和 https://aka.ms/RunCommandManaged

outputBlobManagedIdentity?: RunCommandManagedIdentity

属性值

RunCommandManagedIdentity

outputBlobUri

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

outputBlobUri?: string

属性值

string

parameters

脚本使用的参数。

parameters?: RunCommandInputParameter[]

属性值

RunCommandInputParameter[]

protectedParameters

脚本使用的参数。

protectedParameters?: RunCommandInputParameter[]

属性值

RunCommandInputParameter[]

provisioningState

预配状态，仅显示在响应中。 如果 treatFailureAsDeploymentFailure 设置为 true，则脚本中的任何失败都将使部署失败，ProvisioningState 将标记为“失败”。 如果 treatFailureAsDeploymentFailure 设置为 false，ProvisioningState 将仅反映 run 命令是否由扩展平台运行，它不会指示脚本在脚本失败时是否失败。 在脚本失败时，请参阅 run 命令的实例视图，以查看 executionMessage、输出、错误： https://aka.ms/runcommandmanaged#get-execution-status-and-results 注意：此属性不会被序列化。 它只能由服务器填充。

provisioningState?: string

属性值

string

runAsPassword

指定执行 run 命令时 VM 上的用户帐户密码。

runAsPassword?: string

属性值

string

runAsUser

指定执行 run 命令时 VM 上的用户帐户。

runAsUser?: string

属性值

string

source

运行命令脚本的源。

source?: VirtualMachineRunCommandScriptSource

属性值

VirtualMachineRunCommandScriptSource

timeoutInSeconds

执行 run 命令的超时（秒）。

timeoutInSeconds?: number

属性值

number

treatFailureAsDeploymentFailure

可选。 如果设置为 true，则脚本中的任何失败都将使部署失败，ProvisioningState 将标记为“失败”。 如果设置为 false，ProvisioningState 将仅反映 run 命令是否由扩展平台运行，它不会指示脚本在脚本失败时是否失败。 在脚本失败的情况下，请参阅 run 命令的实例视图，以查看 executionMessage、output、error： https://aka.ms/runcommandmanaged#get-execution-status-and-results

treatFailureAsDeploymentFailure?: boolean

属性值

boolean

继承属性详细信息

id

资源 ID 注意：此属性不会被序列化。 它只能由服务器填充。

id?: string

属性值

string

继承自Resource.id

location

资源位置

location: string

属性值

string

继承自Resource.location

name

资源名称 注意：此属性不会被序列化。 它只能由服务器填充。

name?: string

属性值

string

继承自Resource.name

tags

资源标记

tags?: {[propertyName: string]: string}

属性值

{[propertyName: string]: string}

继承自Resource.tags

type

资源类型 注意：此属性不会被序列化。 它只能由服务器填充。

type?: string

属性值

string

继承自Resource.type