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	タスクが実行されたコンピューティング ノードから、指定したタスク ファイルを削除します。
get_from_compute_node	指定したコンピューティング ノード ファイルの内容を返します。
get_from_task	指定したタスク ファイルの内容を返します。
get_properties_from_compute_node	指定したコンピューティング ノード ファイルのプロパティを取得します。
get_properties_from_task	指定したタスク ファイルのプロパティを取得します。
list_from_compute_node	指定したコンピューティング ノード上の Task ディレクトリ内のすべてのファイルを一覧表示します。
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 パラメーターがファイルではなくディレクトリを表す場合は、recursive を true に設定して、ディレクトリとその中のすべてのファイルとサブディレクトリを削除できます。 recursive が false の場合、ディレクトリは空である必要があります。削除は失敗します。

file_delete_from_compute_node_options

FileDeleteFromComputeNodeOptions

既定値: None

操作の追加パラメーター

custom_headers

dict

既定値: None

要求に追加されるヘッダー

raw

bool

既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config

必須

操作構成のオーバーライド。

戻り値

none または ClientRawResponse (raw=true の場合)

の戻り値の型 :

None,

ClientRawResponse

例外

BatchErrorException

delete_from_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

必須

タスクを含むジョブの ID。

task_id

str

必須

ファイルを削除するタスクの ID。

file_path

str

必須

削除するタスク ファイルまたはディレクトリへのパス。

recursive

bool

既定値: None

ディレクトリの子を削除するかどうか。 filePath パラメーターがファイルではなくディレクトリを表す場合は、recursive を true に設定して、ディレクトリとその中のすべてのファイルとサブディレクトリを削除できます。 recursive が false の場合、ディレクトリは空である必要があります。削除は失敗します。

file_delete_from_task_options

FileDeleteFromTaskOptions

既定値: None

操作の追加パラメーター

custom_headers

dict

既定値: None

要求に追加されるヘッダー

raw

bool

既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config

必須

操作構成のオーバーライド。

戻り値

none または ClientRawResponse (raw=true の場合)

の戻り値の型 :

None,

ClientRawResponse

例外

BatchErrorException

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

を指定すると、ストリーミングされるデータの各チャンクで が呼び出されます。 コールバックは、データの現在のチャンクのバイトと応答オブジェクトの 2 つの引数を受け取る必要があります。 データがアップロードされている場合、応答は None になります。

operation_config

必須

操作構成のオーバーライド。

戻り値

object または ClientRawResponse (raw=true の場合)

の戻り値の型 :

Generator,

ClientRawResponse

例外

BatchErrorException

get_from_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

必須

タスクを含むジョブの ID。

task_id

str

必須

取得するファイルを持つタスクの ID。

file_path

str

必須

コンテンツを取得するタスク ファイルへのパス。

file_get_from_task_options

FileGetFromTaskOptions

既定値: None

操作の追加パラメーター

custom_headers

dict

既定値: None

要求に追加されるヘッダー

raw

bool

既定値: False

は、逆シリアル化された応答と共に直接応答を返します

callback

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

既定値: None

を指定すると、ストリーミングされるデータの各チャンクで が呼び出されます。 コールバックは、データの現在のチャンクのバイトと応答オブジェクトの 2 つの引数を受け取る必要があります。 データがアップロードされている場合、応答は None になります。

operation_config

必須

操作構成のオーバーライド。

戻り値

object または ClientRawResponse (raw=true の場合)

の戻り値の型 :

Generator,

ClientRawResponse

例外

BatchErrorException

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,

ClientRawResponse

例外

BatchErrorException

get_properties_from_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

必須

タスクを含むジョブの ID。

task_id

str

必須

プロパティを取得するファイルを持つ Task の 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,

ClientRawResponse

例外

BatchErrorException

list_from_compute_node

指定したコンピューティング ノード上の Task ディレクトリ内のすべてのファイルを一覧表示します。

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 のインスタンスのような反復子

の戻り値の型 :

NodeFilePaged[NodeFile]

例外

BatchErrorException

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

必須

タスクを含むジョブの ID。

task_id

str

必須

ファイルを一覧表示するタスクの ID。

recursive

bool

既定値: None

Task ディレクトリの子を一覧表示するかどうか。 このパラメーターは、フィルター パラメーターと組み合わせて使用して、特定の種類のファイルを一覧表示できます。

file_list_from_task_options

FileListFromTaskOptions

既定値: None

操作の追加パラメーター

custom_headers

dict

既定値: None

要求に追加されるヘッダー

raw

bool

既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config

必須

操作構成のオーバーライド。

戻り値

NodeFile のインスタンスのような反復子

の戻り値の型 :

NodeFilePaged[NodeFile]

例外

BatchErrorException

属性

models

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