你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
VirtualMachineRunCommand 类
描述虚拟机运行命令。
变量仅由服务器填充,在发送请求时将被忽略。
必须填充所有必需的参数才能发送到 Azure。
- 继承
-
azure.mgmt.compute.v2023_07_01.models._models_py3.ResourceVirtualMachineRunCommand
构造函数
VirtualMachineRunCommand(*, location: str, tags: Dict[str, str] | None = None, source: _models.VirtualMachineRunCommandScriptSource | None = None, parameters: List[_models.RunCommandInputParameter] | None = None, protected_parameters: List[_models.RunCommandInputParameter] | None = None, async_execution: bool = False, run_as_user: str | None = None, run_as_password: str | None = None, timeout_in_seconds: int | None = None, output_blob_uri: str | None = None, error_blob_uri: str | None = None, output_blob_managed_identity: _models.RunCommandManagedIdentity | None = None, error_blob_managed_identity: _models.RunCommandManagedIdentity | None = None, treat_failure_as_deployment_failure: bool = False, **kwargs: Any)
Keyword-Only Parameters
- location
- str
资源位置。 必需。
运行命令脚本的源。
- parameters
- list[RunCommandInputParameter]
脚本使用的参数。
- protected_parameters
- list[RunCommandInputParameter]
脚本使用的参数。
- async_execution
- bool
可选。 如果设置为 true,则脚本启动后,预配将立即完成,并且不会等待脚本完成。
- run_as_user
- str
指定执行 run 命令时 VM 上的用户帐户。
- run_as_password
- str
指定执行 run 命令时 VM 上的用户帐户密码。
- timeout_in_seconds
- int
执行 run 命令的超时(秒)。
- output_blob_uri
- str
指定要在其中上传脚本输出流的 Azure 存储 Blob。 使用具有读取、追加、创建、写入访问权限的 SAS URI,或使用托管标识为 VM 提供对 Blob 的访问权限。 请参阅 outputBlobManagedIdentity 参数。
- error_blob_uri
- str
指定要在其中上传脚本错误流的 Azure 存储 Blob。 使用具有读取、追加、创建、写入访问权限的 SAS URI,或使用托管标识为 VM 提供对 Blob 的访问权限。 请参阅 errorBlobManagedIdentity 参数。
- output_blob_managed_identity
- RunCommandManagedIdentity
有权访问 outputBlobUri 存储 Blob 的用户分配的托管标识。 对于系统分配的标识,请使用空对象。 确保已向托管标识授予对 Blob 容器的访问权限,并分配了“存储 Blob 数据参与者”角色。 对于用户分配的标识,请确保将其添加到 VM 的标识下。 有关托管标识和运行命令的详细信息,请参阅 https://aka.ms/ManagedIdentity 和 https://aka.ms/RunCommandManaged。
- error_blob_managed_identity
- RunCommandManagedIdentity
有权访问 errorBlobUri 存储 Blob 的用户分配的托管标识。 对于系统分配的标识,请使用空对象。 确保已向托管标识授予对 Blob 容器的访问权限,并分配了“存储 Blob 数据参与者”角色。 对于用户分配的标识,请确保将其添加到 VM 的标识下。 有关托管标识和运行命令的详细信息,请参阅 https://aka.ms/ManagedIdentity 和 https://aka.ms/RunCommandManaged。
- treat_failure_as_deployment_failure
- bool
可选。 如果设置为 true,则脚本中的任何失败都将使部署失败,ProvisioningState 将标记为“失败”。 如果设置为 false,ProvisioningState 将仅反映 run 命令是否由扩展平台运行,它不会指示脚本在脚本失败时是否失败。 在脚本失败的情况下,请参阅 run 命令的实例视图,以查看 executionMessage、output、error: https://aka.ms/runcommandmanaged#get-execution-status-and-results。
变量
- id
- str
资源 ID。
- name
- str
资源名称。
- type
- str
资源类型。
- location
- str
资源位置。 必需。
运行命令脚本的源。
- parameters
- list[RunCommandInputParameter]
脚本使用的参数。
- protected_parameters
- list[RunCommandInputParameter]
脚本使用的参数。
- async_execution
- bool
可选。 如果设置为 true,则脚本启动后,预配将立即完成,并且不会等待脚本完成。
- run_as_user
- str
指定执行 run 命令时 VM 上的用户帐户。
- run_as_password
- str
指定执行 run 命令时 VM 上的用户帐户密码。
- timeout_in_seconds
- int
执行 run 命令的超时(秒)。
- output_blob_uri
- str
指定要在其中上传脚本输出流的 Azure 存储 Blob。 使用具有读取、追加、创建、写入访问权限的 SAS URI,或使用托管标识为 VM 提供对 Blob 的访问权限。 请参阅 outputBlobManagedIdentity 参数。
- error_blob_uri
- str
指定要在其中上传脚本错误流的 Azure 存储 Blob。 使用具有读取、追加、创建、写入访问权限的 SAS URI,或使用托管标识为 VM 提供对 Blob 的访问权限。 请参阅 errorBlobManagedIdentity 参数。
- output_blob_managed_identity
- RunCommandManagedIdentity
有权访问 outputBlobUri 存储 Blob 的用户分配的托管标识。 对于系统分配的标识,请使用空对象。 确保已向托管标识授予对 Blob 容器的访问权限,并分配了“存储 Blob 数据参与者”角色。 对于用户分配的标识,请确保将其添加到 VM 的标识下。 有关托管标识和运行命令的详细信息,请参阅 https://aka.ms/ManagedIdentity 和 https://aka.ms/RunCommandManaged。
- error_blob_managed_identity
- RunCommandManagedIdentity
有权访问 errorBlobUri 存储 Blob 的用户分配的托管标识。 对于系统分配的标识,请使用空对象。 确保已向托管标识授予对 Blob 容器的访问权限,并分配了“存储 Blob 数据参与者”角色。 对于用户分配的标识,请确保将其添加到 VM 的标识下。 有关托管标识和运行命令的详细信息,请参阅 https://aka.ms/ManagedIdentity 和 https://aka.ms/RunCommandManaged。
- provisioning_state
- str
预配状态,仅显示在响应中。 如果 treatFailureAsDeploymentFailure 设置为 true,则脚本中的任何失败都将使部署失败,ProvisioningState 将标记为“失败”。 如果 treatFailureAsDeploymentFailure 设置为 false,ProvisioningState 将仅反映 run 命令是否由扩展平台运行,它不会指示脚本在脚本失败时是否失败。 在脚本失败的情况下,请参阅 run 命令的实例视图,以查看 executionMessage、output、error: https://aka.ms/runcommandmanaged#get-execution-status-and-results。
- instance_view
- VirtualMachineRunCommandInstanceView
虚拟机运行命令实例视图。
- treat_failure_as_deployment_failure
- bool
可选。 如果设置为 true,则脚本中的任何失败都将使部署失败,ProvisioningState 将标记为“失败”。 如果设置为 false,ProvisioningState 将仅反映 run 命令是否由扩展平台运行,它不会指示脚本在脚本失败时是否失败。 在脚本失败的情况下,请参阅 run 命令的实例视图,以查看 executionMessage、output、error: https://aka.ms/runcommandmanaged#get-execution-status-and-results。