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

ComputeNodeOperations 类

ComputeNodeOperations 操作。

不应直接实例化此类，而应创建一个客户端实例，该实例将为你创建该类并将其附加为属性。

继承

builtins.object

ComputeNodeOperations

构造函数

ComputeNodeOperations(client, config, serializer, deserializer)

参数

client

必需

服务请求的客户端。

config

必需

服务客户端的配置。

serializer

必需

对象模型序列化程序。

deserializer

必需

对象模型反序列化程序。

变量

api_version

要用于请求的 API 版本。 常量值：“2023-05-01.17.0”。

方法

add_user	将用户帐户添加到指定的计算节点。 仅当计算节点处于空闲或正在运行状态时，才能将用户帐户添加到计算节点。
delete_user	从指定的计算节点中删除用户帐户。 仅当计算节点处于空闲或运行状态时，才能将其删除。
disable_scheduling	禁用指定计算节点上的任务计划。 仅当计算节点上的任务计划状态已启用时，才能禁用其当前计划状态。
enable_scheduling	在指定的计算节点上启用任务计划。 仅当计算节点上的当前计划状态处于禁用状态时，才能在其上启用任务计划。
get	获取有关指定计算节点的信息。
get_remote_desktop	获取指定计算节点的远程桌面协议文件。 必须先在计算节点上创建用户帐户，然后才能使用 RDP 文件访问计算节点。 只能在使用云服务配置创建的池上调用此 API。 有关使用虚拟机配置创建的池，请参阅 GetRemoteLoginSettings API。
get_remote_login_settings	获取远程登录到计算节点所需的设置。 在使用远程登录设置远程登录到计算节点之前，必须在计算节点上创建用户帐户。 只能在使用虚拟机配置属性创建的池上调用此 API。 有关使用云服务配置创建的池，请参阅 GetRemoteDesktop API。
list	列出指定池中的计算节点。
reboot	重启指定的计算节点。 仅当计算节点处于空闲或正在运行状态时，才能重新启动它。
reimage	在指定的计算节点上重新安装操作系统。 仅当计算节点上处于空闲或正在运行状态时，才能在计算节点上重新安装操作系统。 只能在使用云服务配置属性创建的池上调用此 API。
update_user	汇报指定计算节点上用户帐户的密码和过期时间。 此操作将替换帐户的所有可更新属性。 例如，如果未指定 expiryTime 元素，则将当前值替换为默认值，而不是保留未修改的值。 仅当计算节点上的用户帐户处于空闲或运行状态时，才能更新该节点上的用户帐户。
upload_batch_service_logs	将Azure Batch服务日志文件从指定的计算节点上传到Azure Blob 存储。 如果遇到错误并希望升级到Azure 支持，这是为了自动从计算节点收集Azure Batch服务日志文件。 应与 Azure 支持 共享Azure Batch服务日志文件，以帮助调试 Batch 服务的问题。

add_user

将用户帐户添加到指定的计算节点。

仅当计算节点处于空闲或正在运行状态时，才能将用户帐户添加到计算节点。

add_user(pool_id, node_id, user, compute_node_add_user_options=None, custom_headers=None, raw=False, **operation_config)

参数

pool_id

str

必需

包含计算节点的池的 ID。

node_id

str

必需

要在其中创建用户帐户的计算机的 ID。

user

ComputeNodeUser

必需

要创建的用户帐户。

compute_node_add_user_options

ComputeNodeAddUserOptions

默认值: None

操作的其他参数

custom_headers

dict

默认值: None

将添加到请求的标头

raw

bool

默认值: False

返回直接响应以及反序列化的响应

operation_config

必需

操作配置替代。

返回

如果 raw=true，则为 None 或 ClientRawResponse

返回类型

None,

ClientRawResponse

例外

BatchErrorException

delete_user

从指定的计算节点中删除用户帐户。

仅当计算节点处于空闲或运行状态时，才能将其删除。

delete_user(pool_id, node_id, user_name, compute_node_delete_user_options=None, custom_headers=None, raw=False, **operation_config)

参数

pool_id

str

必需

包含计算节点的池的 ID。

node_id

str

必需

要删除用户帐户的计算机的 ID。

user_name

str

必需

要删除的用户帐户的名称。

compute_node_delete_user_options

ComputeNodeDeleteUserOptions

默认值: None

操作的其他参数

custom_headers

dict

默认值: None

将添加到请求的标头

raw

bool

默认值: False

返回直接响应以及反序列化的响应

operation_config

必需

操作配置替代。

返回

如果 raw=true，则为 None 或 ClientRawResponse

返回类型

None,

ClientRawResponse

例外

BatchErrorException

disable_scheduling

禁用指定计算节点上的任务计划。

仅当计算节点上的任务计划状态已启用时，才能禁用其当前计划状态。

disable_scheduling(pool_id, node_id, node_disable_scheduling_option=None, compute_node_disable_scheduling_options=None, custom_headers=None, raw=False, **operation_config)

参数

pool_id

str

必需

包含计算节点的池的 ID。

node_id

str

必需

要禁用任务计划的计算节点的 ID。

node_disable_scheduling_option

str 或 DisableComputeNodeSchedulingOption

默认值: None

默认值为 requeue。 可能的值包括：“requeue”、“terminate”、“taskCompletion”

compute_node_disable_scheduling_options

ComputeNodeDisableSchedulingOptions

默认值: None

操作的其他参数

custom_headers

dict

默认值: None

将添加到请求的标头

raw

bool

默认值: False

返回直接响应以及反序列化的响应

operation_config

必需

操作配置替代。

返回

如果 raw=true，则为 None 或 ClientRawResponse

返回类型

None,

ClientRawResponse

例外

BatchErrorException

enable_scheduling

在指定的计算节点上启用任务计划。

仅当计算节点上的当前计划状态处于禁用状态时，才能在其上启用任务计划。

enable_scheduling(pool_id, node_id, compute_node_enable_scheduling_options=None, custom_headers=None, raw=False, **operation_config)

参数

pool_id

str

必需

包含计算节点的池的 ID。

node_id

str

必需

要启用任务计划的计算节点的 ID。

compute_node_enable_scheduling_options

ComputeNodeEnableSchedulingOptions

默认值: None

操作的其他参数

custom_headers

dict

默认值: None

将添加到请求的标头

raw

bool

默认值: False

返回直接响应以及反序列化的响应

operation_config

必需

操作配置替代。

返回

如果 raw=true，则为 None 或 ClientRawResponse

返回类型

None,

ClientRawResponse

例外

BatchErrorException

get

获取有关指定计算节点的信息。

get(pool_id, node_id, compute_node_get_options=None, custom_headers=None, raw=False, **operation_config)

参数

pool_id

str

必需

包含计算节点的池的 ID。

node_id

str

必需

要获取相关信息的计算节点的 ID。

compute_node_get_options

ComputeNodeGetOptions

默认值: None

操作的其他参数

custom_headers

dict

默认值: None

将添加到请求的标头

raw

bool

默认值: False

返回直接响应以及反序列化的响应

operation_config

必需

操作配置替代。

返回

如果 raw=true，则 ComputeNode 或 ClientRawResponse

返回类型

ComputeNode,

ClientRawResponse

例外

BatchErrorException

get_remote_desktop

获取指定计算节点的远程桌面协议文件。

必须先在计算节点上创建用户帐户，然后才能使用 RDP 文件访问计算节点。 只能在使用云服务配置创建的池上调用此 API。 有关使用虚拟机配置创建的池，请参阅 GetRemoteLoginSettings API。

get_remote_desktop(pool_id, node_id, compute_node_get_remote_desktop_options=None, custom_headers=None, raw=False, callback=None, **operation_config)

参数

pool_id

str

必需

包含计算节点的池的 ID。

node_id

str

必需

要获取其远程桌面协议文件的计算节点的 ID。

compute_node_get_remote_desktop_options

ComputeNodeGetRemoteDesktopOptions

默认值: None

操作的其他参数

custom_headers

dict

默认值: None

将添加到请求的标头

raw

bool

默认值: False

返回直接响应以及反序列化的响应

callback

Callable[<xref:Bytes>, <xref:response=None>]

默认值: None

指定后，将使用流式传输的每个数据块调用 。 回调应采用两个参数：当前数据区块的字节和响应对象。 如果数据正在上传，响应将为“无”。

operation_config

必需

操作配置替代。

返回

object 或 ClientRawResponse（如果 raw=true）

返回类型

Generator,

ClientRawResponse

例外

BatchErrorException

get_remote_login_settings

获取远程登录到计算节点所需的设置。

在使用远程登录设置远程登录到计算节点之前，必须在计算节点上创建用户帐户。 只能在使用虚拟机配置属性创建的池上调用此 API。 有关使用云服务配置创建的池，请参阅 GetRemoteDesktop API。

get_remote_login_settings(pool_id, node_id, compute_node_get_remote_login_settings_options=None, custom_headers=None, raw=False, **operation_config)

参数

pool_id

str

必需

包含计算节点的池的 ID。

node_id

str

必需

要获取其远程登录设置的计算节点的 ID。

compute_node_get_remote_login_settings_options

ComputeNodeGetRemoteLoginSettingsOptions

默认值: None

操作的其他参数

custom_headers

dict

默认值: None

将添加到请求的标头

raw

bool

默认值: False

返回直接响应以及反序列化的响应

operation_config

必需

操作配置替代。

返回

ComputeNodeGetRemoteLoginSettingsResult 或 ClientRawResponse（如果 raw=true）

返回类型

ComputeNodeGetRemoteLoginSettingsResult,

ClientRawResponse

例外

BatchErrorException

list

列出指定池中的计算节点。

list(pool_id, compute_node_list_options=None, custom_headers=None, raw=False, **operation_config)

参数

pool_id

str

必需

要从中列出计算节点的池的 ID。

compute_node_list_options

ComputeNodeListOptions

默认值: None

操作的其他参数

custom_headers

dict

默认值: None

将添加到请求的标头

raw

bool

默认值: False

返回直接响应以及反序列化的响应

operation_config

必需

操作配置替代。

返回

一个迭代器，例如 ComputeNode 的实例

返回类型

ComputeNodePaged[ComputeNode]

例外

BatchErrorException

reboot

重启指定的计算节点。

仅当计算节点处于空闲或正在运行状态时，才能重新启动它。

reboot(pool_id, node_id, node_reboot_option=None, compute_node_reboot_options=None, custom_headers=None, raw=False, **operation_config)

参数

pool_id

str

必需

包含计算节点的池的 ID。

node_id

str

必需

要重启的计算节点的 ID。

node_reboot_option

str 或 ComputeNodeRebootOption

默认值: None

默认值为 requeue。 可能的值包括：“requeue”、“terminate”、“taskCompletion”、“retainedData”

compute_node_reboot_options

ComputeNodeRebootOptions

默认值: None

操作的其他参数

custom_headers

dict

默认值: None

将添加到请求的标头

raw

bool

默认值: False

返回直接响应以及反序列化的响应

operation_config

必需

操作配置替代。

返回

如果 raw=true，则为 None 或 ClientRawResponse

返回类型

None,

ClientRawResponse

例外

BatchErrorException

reimage

在指定的计算节点上重新安装操作系统。

仅当计算节点上处于空闲或正在运行状态时，才能在计算节点上重新安装操作系统。 只能在使用云服务配置属性创建的池上调用此 API。

reimage(pool_id, node_id, node_reimage_option=None, compute_node_reimage_options=None, custom_headers=None, raw=False, **operation_config)

参数

pool_id

str

必需

包含计算节点的池的 ID。

node_id

str

必需

要重启的计算节点的 ID。

node_reimage_option

str 或 ComputeNodeReimageOption

默认值: None

默认值为 requeue。 可能的值包括：“requeue”、“terminate”、“taskCompletion”、“retainedData”

compute_node_reimage_options

ComputeNodeReimageOptions

默认值: None

操作的其他参数

custom_headers

dict

默认值: None

将添加到请求的标头

raw

bool

默认值: False

返回直接响应以及反序列化的响应

operation_config

必需

操作配置替代。

返回

None 或 ClientRawResponse（如果 raw=true）

返回类型

None,

ClientRawResponse

例外

BatchErrorException

update_user

汇报指定计算节点上用户帐户的密码和过期时间。

此操作将替换帐户的所有可更新属性。 例如，如果未指定 expiryTime 元素，则将当前值替换为默认值，而不是保留未修改的值。 仅当计算节点上的用户帐户处于空闲或运行状态时，才能更新该节点上的用户帐户。

update_user(pool_id, node_id, user_name, node_update_user_parameter, compute_node_update_user_options=None, custom_headers=None, raw=False, **operation_config)

参数

pool_id

str

必需

包含计算节点的池的 ID。

node_id

str

必需

要更新用户帐户的计算机的 ID。

user_name

str

必需

要更新的用户帐户的名称。

node_update_user_parameter

NodeUpdateUserParameter

必需

请求的参数。

compute_node_update_user_options

ComputeNodeUpdateUserOptions

默认值: None

操作的其他参数

custom_headers

dict

默认值: None

将添加到请求的标头

raw

bool

默认值: False

返回直接响应以及反序列化的响应

operation_config

必需

操作配置替代。

返回

None 或 ClientRawResponse（如果 raw=true）

返回类型

None,

ClientRawResponse

例外

BatchErrorException

upload_batch_service_logs

将Azure Batch服务日志文件从指定的计算节点上传到Azure Blob 存储。

如果遇到错误并希望升级到Azure 支持，这是为了自动从计算节点收集Azure Batch服务日志文件。 应与 Azure 支持 共享Azure Batch服务日志文件，以帮助调试 Batch 服务的问题。

upload_batch_service_logs(pool_id, node_id, upload_batch_service_logs_configuration, compute_node_upload_batch_service_logs_options=None, custom_headers=None, raw=False, **operation_config)

参数

pool_id

str

必需

包含计算节点的池的 ID。

node_id

str

必需

要从中上传Azure Batch服务日志文件的计算节点的 ID。

upload_batch_service_logs_configuration

UploadBatchServiceLogsConfiguration

必需

Azure Batch服务日志文件上传配置。

compute_node_upload_batch_service_logs_options

ComputeNodeUploadBatchServiceLogsOptions

默认值: None

操作的其他参数

custom_headers

dict

默认值: None

将添加到请求的标头

raw

bool

默认值: False

返回直接响应以及反序列化的响应

operation_config

必需

操作配置替代。

返回

UploadBatchServiceLogsResult 或 ClientRawResponse（如果 raw=true）

返回类型

UploadBatchServiceLogsResult,

ClientRawResponse

例外

BatchErrorException

属性

models

models = <module 'azure.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\batch\\models\\__init__.py'>