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

FileOperations 类

FileOperations 操作。

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

继承
builtins.object
FileOperations

构造函数

FileOperations(client, config, serializer, deserializer)

参数

client
必需

用于服务请求的客户端。

config
必需

服务客户端的配置。

serializer
必需

对象模型序列化程序。

deserializer
必需

对象模型反序列化程序。

变量

api_version

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

方法

delete_from_compute_node

从计算节点中删除指定的文件。

delete_from_task

从运行 Task 的计算节点中删除指定的 Task 文件。

get_from_compute_node

返回指定计算节点文件的内容。

get_from_task

返回指定 Task 文件的内容。

get_properties_from_compute_node

获取指定计算节点文件的属性。

get_properties_from_task

获取指定 Task 文件的属性。

list_from_compute_node

列出指定计算节点上的任务目录中的所有文件。

list_from_task

列出任务在其计算节点上的目录中的文件。

delete_from_compute_node

从计算节点中删除指定的文件。

delete_from_compute_node(pool_id, node_id, file_path, recursive=None, file_delete_from_compute_node_options=None, custom_headers=None, raw=False, **operation_config)

参数

pool_id
str
必需

包含计算节点的池的 ID。

node_id
str
必需

要从中删除文件的计算节点的 ID。

file_path
str
必需

要删除的文件或目录的路径。

recursive
bool
默认值: None

是否删除目录的子级。 如果 filePath 参数表示目录而不是文件,则可以将递归设置为 true 以删除目录及其中的所有文件和子目录。 如果递归为 false,则目录必须为空,否则删除将失败。

file_delete_from_compute_node_options
FileDeleteFromComputeNodeOptions
默认值: None

操作的其他参数

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

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

operation_config
必需

操作配置替代

返回

None 或 ClientRawResponse(如果 raw=true)

返回类型

None,

例外

delete_from_task

从运行 Task 的计算节点中删除指定的 Task 文件。

delete_from_task(job_id, task_id, file_path, recursive=None, file_delete_from_task_options=None, custom_headers=None, raw=False, **operation_config)

参数

job_id
str
必需

包含 Task 的作业的 ID。

task_id
str
必需

要删除其文件的 Task 的 ID。

file_path
str
必需

要删除的任务文件或目录的路径。

recursive
bool
默认值: None

是否删除目录的子级。 如果 filePath 参数表示目录而不是文件,则可以将递归设置为 true 以删除目录及其中的所有文件和子目录。 如果递归为 false,则目录必须为空,否则删除将失败。

file_delete_from_task_options
FileDeleteFromTaskOptions
默认值: None

操作的其他参数

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

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

operation_config
必需

操作配置替代

返回

None 或 ClientRawResponse(如果 raw=true)

返回类型

None,

例外

get_from_compute_node

返回指定计算节点文件的内容。

get_from_compute_node(pool_id, node_id, file_path, file_get_from_compute_node_options=None, custom_headers=None, raw=False, callback=None, **operation_config)

参数

pool_id
str
必需

包含计算节点的池的 ID。

node_id
str
必需

包含文件的计算节点的 ID。

file_path
str
必需

要获取其内容的计算节点文件的路径。

file_get_from_compute_node_options
FileGetFromComputeNodeOptions
默认值: None

操作的其他参数

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

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

callback
Callable[<xref:Bytes>, <xref:response=None>]
默认值: None

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

operation_config
必需

操作配置替代

返回

object 或 ClientRawResponse(如果 raw=true)

返回类型

例外

get_from_task

返回指定 Task 文件的内容。

get_from_task(job_id, task_id, file_path, file_get_from_task_options=None, custom_headers=None, raw=False, callback=None, **operation_config)

参数

job_id
str
必需

包含 Task 的作业的 ID。

task_id
str
必需

要检索其文件的 Task 的 ID。

file_path
str
必需

要获取其内容的 Task 文件的路径。

file_get_from_task_options
FileGetFromTaskOptions
默认值: None

操作的其他参数

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

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

callback
Callable[<xref:Bytes>, <xref:response=None>]
默认值: None

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

operation_config
必需

操作配置替代

返回

object 或 ClientRawResponse(如果 raw=true)

返回类型

例外

get_properties_from_compute_node

获取指定计算节点文件的属性。

get_properties_from_compute_node(pool_id, node_id, file_path, file_get_properties_from_compute_node_options=None, custom_headers=None, raw=False, **operation_config)

参数

pool_id
str
必需

包含计算节点的池的 ID。

node_id
str
必需

包含文件的计算节点的 ID。

file_path
str
必需

要获取其属性的计算节点文件的路径。

file_get_properties_from_compute_node_options
FileGetPropertiesFromComputeNodeOptions
默认值: None

操作的其他参数

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

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

operation_config
必需

操作配置替代

返回

None 或 ClientRawResponse(如果 raw=true)

返回类型

None,

例外

get_properties_from_task

获取指定 Task 文件的属性。

get_properties_from_task(job_id, task_id, file_path, file_get_properties_from_task_options=None, custom_headers=None, raw=False, **operation_config)

参数

job_id
str
必需

包含 Task 的作业的 ID。

task_id
str
必需

要获取其属性的文件的任务的 ID。

file_path
str
必需

要获取其属性的任务文件的路径。

file_get_properties_from_task_options
FileGetPropertiesFromTaskOptions
默认值: None

操作的其他参数

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

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

operation_config
必需

操作配置替代

返回

None 或 ClientRawResponse(如果 raw=true)

返回类型

None,

例外

list_from_compute_node

列出指定计算节点上的任务目录中的所有文件。

list_from_compute_node(pool_id, node_id, recursive=None, file_list_from_compute_node_options=None, custom_headers=None, raw=False, **operation_config)

参数

pool_id
str
必需

包含计算节点的池的 ID。

node_id
str
必需

要列出其文件的计算节点的 ID。

recursive
bool
默认值: None

是否列出目录的子级。

file_list_from_compute_node_options
FileListFromComputeNodeOptions
默认值: None

操作的其他参数

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

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

operation_config
必需

操作配置替代

返回

迭代器,例如 NodeFile 的实例

返回类型

例外

list_from_task

列出任务在其计算节点上的目录中的文件。

list_from_task(job_id, task_id, recursive=None, file_list_from_task_options=None, custom_headers=None, raw=False, **operation_config)

参数

job_id
str
必需

包含 Task 的作业的 ID。

task_id
str
必需

要列出其文件的 Task 的 ID。

recursive
bool
默认值: None

是否列出 Task 目录的子目录。 此参数可与 filter 参数结合使用,以列出特定类型的文件。

file_list_from_task_options
FileListFromTaskOptions
默认值: None

操作的其他参数

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

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

operation_config
必需

操作配置替代

返回

迭代器,例如 NodeFile 的实例

返回类型

例外

属性

models

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