File class

パッケージ:

@azure/batch

ファイルを表すクラス。

コンストラクター

File(BatchServiceClientContext)

ファイルを作成します。

メソッド

deleteFromComputeNode(string, string, string, FileDeleteFromComputeNodeOptionalParams)
deleteFromComputeNode(string, string, string, FileDeleteFromComputeNodeOptionalParams, ServiceCallback<void>)
deleteFromComputeNode(string, string, string, ServiceCallback<void>)
deleteFromTask(string, string, string, FileDeleteFromTaskOptionalParams)
deleteFromTask(string, string, string, FileDeleteFromTaskOptionalParams, ServiceCallback<void>)
deleteFromTask(string, string, string, ServiceCallback<void>)
getFromComputeNode(string, string, string, FileGetFromComputeNodeOptionalParams)	指定したコンピューティング ノード ファイルの内容を返します。
getFromComputeNode(string, string, string, FileGetFromComputeNodeOptionalParams, ServiceCallback<void>)
getFromComputeNode(string, string, string, ServiceCallback<void>)
getFromTask(string, string, string, FileGetFromTaskOptionalParams)	指定したタスク ファイルの内容を返します。
getFromTask(string, string, string, FileGetFromTaskOptionalParams, ServiceCallback<void>)
getFromTask(string, string, string, ServiceCallback<void>)
getPropertiesFromComputeNode(string, string, string, FileGetPropertiesFromComputeNodeOptionalParams)	指定したコンピューティング ノード ファイルのプロパティを取得します。
getPropertiesFromComputeNode(string, string, string, FileGetPropertiesFromComputeNodeOptionalParams, ServiceCallback<void>)
getPropertiesFromComputeNode(string, string, string, ServiceCallback<void>)
getPropertiesFromTask(string, string, string, FileGetPropertiesFromTaskOptionalParams)	指定したタスク ファイルのプロパティを取得します。
getPropertiesFromTask(string, string, string, FileGetPropertiesFromTaskOptionalParams, ServiceCallback<void>)
getPropertiesFromTask(string, string, string, ServiceCallback<void>)
listFromComputeNode(string, string, FileListFromComputeNodeOptionalParams)
listFromComputeNode(string, string, FileListFromComputeNodeOptionalParams, ServiceCallback<NodeFileListResult>)
listFromComputeNode(string, string, ServiceCallback<NodeFileListResult>)
listFromComputeNodeNext(string, FileListFromComputeNodeNextOptionalParams)
listFromComputeNodeNext(string, FileListFromComputeNodeNextOptionalParams, ServiceCallback<NodeFileListResult>)
listFromComputeNodeNext(string, ServiceCallback<NodeFileListResult>)
listFromTask(string, string, FileListFromTaskOptionalParams)
listFromTask(string, string, FileListFromTaskOptionalParams, ServiceCallback<NodeFileListResult>)
listFromTask(string, string, ServiceCallback<NodeFileListResult>)
listFromTaskNext(string, FileListFromTaskNextOptionalParams)
listFromTaskNext(string, FileListFromTaskNextOptionalParams, ServiceCallback<NodeFileListResult>)
listFromTaskNext(string, ServiceCallback<NodeFileListResult>)

コンストラクターの詳細

File(BatchServiceClientContext)

ファイルを作成します。

new File(client: BatchServiceClientContext)

パラメーター

client

BatchServiceClientContext

サービス クライアントへの参照。

メソッドの詳細

deleteFromComputeNode(string, string, string, FileDeleteFromComputeNodeOptionalParams)

function deleteFromComputeNode(poolId: string, nodeId: string, filePath: string, options?: FileDeleteFromComputeNodeOptionalParams): Promise<FileDeleteFromComputeNodeResponse>

パラメーター

poolId

string

コンピューティング ノードを含むプールの ID。

nodeId

string

ファイルを削除するコンピューティング ノードの ID。

filePath

string

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

options

FileDeleteFromComputeNodeOptionalParams

省略可能なパラメーター

戻り値

Promise<FileDeleteFromComputeNodeResponse>

Promise<Models.FileDeleteFromComputeNodeResponse>

deleteFromComputeNode(string, string, string, FileDeleteFromComputeNodeOptionalParams, ServiceCallback<void>)

function deleteFromComputeNode(poolId: string, nodeId: string, filePath: string, options: FileDeleteFromComputeNodeOptionalParams, callback: ServiceCallback<void>)

パラメーター

poolId

string

コンピューティング ノードを含むプールの ID。

nodeId

string

ファイルを削除するコンピューティング ノードの ID。

filePath

string

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

options

FileDeleteFromComputeNodeOptionalParams

省略可能なパラメーター

callback

ServiceCallback<void>

コールバック

deleteFromComputeNode(string, string, string, ServiceCallback<void>)

function deleteFromComputeNode(poolId: string, nodeId: string, filePath: string, callback: ServiceCallback<void>)

パラメーター

poolId

string

コンピューティング ノードを含むプールの ID。

nodeId

string

ファイルを削除するコンピューティング ノードの ID。

filePath

string

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

callback

ServiceCallback<void>

コールバック

deleteFromTask(string, string, string, FileDeleteFromTaskOptionalParams)

function deleteFromTask(jobId: string, taskId: string, filePath: string, options?: FileDeleteFromTaskOptionalParams): Promise<FileDeleteFromTaskResponse>

パラメーター

jobId

string

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

taskId

string

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

filePath

string

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

options

FileDeleteFromTaskOptionalParams

省略可能なパラメーター

戻り値

Promise<FileDeleteFromTaskResponse>

Promise<Models.FileDeleteFromTaskResponse>

deleteFromTask(string, string, string, FileDeleteFromTaskOptionalParams, ServiceCallback<void>)

function deleteFromTask(jobId: string, taskId: string, filePath: string, options: FileDeleteFromTaskOptionalParams, callback: ServiceCallback<void>)

パラメーター

jobId

string

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

taskId

string

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

filePath

string

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

options

FileDeleteFromTaskOptionalParams

省略可能なパラメーター

callback

ServiceCallback<void>

コールバック

deleteFromTask(string, string, string, ServiceCallback<void>)

function deleteFromTask(jobId: string, taskId: string, filePath: string, callback: ServiceCallback<void>)

パラメーター

jobId

string

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

taskId

string

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

filePath

string

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

callback

ServiceCallback<void>

コールバック

getFromComputeNode(string, string, string, FileGetFromComputeNodeOptionalParams)

指定したコンピューティング ノード ファイルの内容を返します。

function getFromComputeNode(poolId: string, nodeId: string, filePath: string, options?: FileGetFromComputeNodeOptionalParams): Promise<FileGetFromComputeNodeResponse>

パラメーター

poolId

string

コンピューティング ノードを含むプールの ID。

nodeId

string

ファイルを含むコンピューティング ノードの ID。

filePath

string

コンテンツを取得するコンピューティング ノード ファイルへのパス。

options

FileGetFromComputeNodeOptionalParams

省略可能なパラメーター

戻り値

Promise<FileGetFromComputeNodeResponse>

Promise<Models.FileGetFromComputeNodeResponse応答>

getFromComputeNode(string, string, string, FileGetFromComputeNodeOptionalParams, ServiceCallback<void>)

function getFromComputeNode(poolId: string, nodeId: string, filePath: string, options: FileGetFromComputeNodeOptionalParams, callback: ServiceCallback<void>)

パラメーター

poolId

string

コンピューティング ノードを含むプールの ID。

nodeId

string

ファイルを含むコンピューティング ノードの ID。

filePath

string

コンテンツを取得するコンピューティング ノード ファイルへのパス。

options

FileGetFromComputeNodeOptionalParams

省略可能なパラメーター

callback

ServiceCallback<void>

コールバック

getFromComputeNode(string, string, string, ServiceCallback<void>)

function getFromComputeNode(poolId: string, nodeId: string, filePath: string, callback: ServiceCallback<void>)

パラメーター

poolId

string

コンピューティング ノードを含むプールの ID。

nodeId

string

ファイルを含むコンピューティング ノードの ID。

filePath

string

コンテンツを取得するコンピューティング ノード ファイルへのパス。

callback

ServiceCallback<void>

コールバック

getFromTask(string, string, string, FileGetFromTaskOptionalParams)

指定したタスク ファイルの内容を返します。

function getFromTask(jobId: string, taskId: string, filePath: string, options?: FileGetFromTaskOptionalParams): Promise<FileGetFromTaskResponse>

パラメーター

jobId

string

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

taskId

string

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

filePath

string

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

options

FileGetFromTaskOptionalParams

省略可能なパラメーター

戻り値

Promise<FileGetFromTaskResponse>

Promise<Models.FileGetFromTaskResponse(PromiseModels.FileGetFromTaskResponse)>

getFromTask(string, string, string, FileGetFromTaskOptionalParams, ServiceCallback<void>)

function getFromTask(jobId: string, taskId: string, filePath: string, options: FileGetFromTaskOptionalParams, callback: ServiceCallback<void>)

パラメーター

jobId

string

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

taskId

string

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

filePath

string

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

options

FileGetFromTaskOptionalParams

省略可能なパラメーター

callback

ServiceCallback<void>

コールバック

getFromTask(string, string, string, ServiceCallback<void>)

function getFromTask(jobId: string, taskId: string, filePath: string, callback: ServiceCallback<void>)

パラメーター

jobId

string

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

taskId

string

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

filePath

string

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

callback

ServiceCallback<void>

コールバック

getPropertiesFromComputeNode(string, string, string, FileGetPropertiesFromComputeNodeOptionalParams)

指定したコンピューティング ノード ファイルのプロパティを取得します。

function getPropertiesFromComputeNode(poolId: string, nodeId: string, filePath: string, options?: FileGetPropertiesFromComputeNodeOptionalParams): Promise<FileGetPropertiesFromComputeNodeResponse>

パラメーター

poolId

string

コンピューティング ノードを含むプールの ID。

nodeId

string

ファイルを含むコンピューティング ノードの ID。

filePath

string

プロパティを取得するコンピューティング ノード ファイルへのパス。

options

FileGetPropertiesFromComputeNodeOptionalParams

省略可能なパラメーター

戻り値

Promise<FileGetPropertiesFromComputeNodeResponse>

Promise<Models.FileGetPropertiesFromComputeNodeResponse応答>

getPropertiesFromComputeNode(string, string, string, FileGetPropertiesFromComputeNodeOptionalParams, ServiceCallback<void>)

function getPropertiesFromComputeNode(poolId: string, nodeId: string, filePath: string, options: FileGetPropertiesFromComputeNodeOptionalParams, callback: ServiceCallback<void>)

パラメーター

poolId

string

コンピューティング ノードを含むプールの ID。

nodeId

string

ファイルを含むコンピューティング ノードの ID。

filePath

string

プロパティを取得するコンピューティング ノード ファイルへのパス。

options

FileGetPropertiesFromComputeNodeOptionalParams

省略可能なパラメーター

callback

ServiceCallback<void>

コールバック

getPropertiesFromComputeNode(string, string, string, ServiceCallback<void>)

function getPropertiesFromComputeNode(poolId: string, nodeId: string, filePath: string, callback: ServiceCallback<void>)

パラメーター

poolId

string

コンピューティング ノードを含むプールの ID。

nodeId

string

ファイルを含むコンピューティング ノードの ID。

filePath

string

プロパティを取得するコンピューティング ノード ファイルへのパス。

callback

ServiceCallback<void>

コールバック

getPropertiesFromTask(string, string, string, FileGetPropertiesFromTaskOptionalParams)

指定したタスク ファイルのプロパティを取得します。

function getPropertiesFromTask(jobId: string, taskId: string, filePath: string, options?: FileGetPropertiesFromTaskOptionalParams): Promise<FileGetPropertiesFromTaskResponse>

パラメーター

jobId

string

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

taskId

string

プロパティを取得するファイルを持つタスクの ID。

filePath

string

プロパティを取得するタスク ファイルへのパス。

options

FileGetPropertiesFromTaskOptionalParams

省略可能なパラメーター

戻り値

Promise<FileGetPropertiesFromTaskResponse>

Promise<Models.FileGetPropertiesFromTaskResponse>

getPropertiesFromTask(string, string, string, FileGetPropertiesFromTaskOptionalParams, ServiceCallback<void>)

function getPropertiesFromTask(jobId: string, taskId: string, filePath: string, options: FileGetPropertiesFromTaskOptionalParams, callback: ServiceCallback<void>)

パラメーター

jobId

string

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

taskId

string

プロパティを取得するファイルを持つタスクの ID。

filePath

string

プロパティを取得するタスク ファイルへのパス。

options

FileGetPropertiesFromTaskOptionalParams

省略可能なパラメーター

callback

ServiceCallback<void>

コールバック

getPropertiesFromTask(string, string, string, ServiceCallback<void>)

function getPropertiesFromTask(jobId: string, taskId: string, filePath: string, callback: ServiceCallback<void>)

パラメーター

jobId

string

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

taskId

string

プロパティを取得するファイルを持つタスクの ID。

filePath

string

プロパティを取得するタスク ファイルへのパス。

callback

ServiceCallback<void>

コールバック

listFromComputeNode(string, string, FileListFromComputeNodeOptionalParams)

function listFromComputeNode(poolId: string, nodeId: string, options?: FileListFromComputeNodeOptionalParams): Promise<FileListFromComputeNodeResponse>

パラメーター

poolId

string

コンピューティング ノードを含むプールの ID。

nodeId

string

ファイルを一覧表示するコンピューティング ノードの ID。

options

FileListFromComputeNodeOptionalParams

省略可能なパラメーター

戻り値

Promise<FileListFromComputeNodeResponse>

Promise<Models.FileListFromComputeNodeResponse応答>

listFromComputeNode(string, string, FileListFromComputeNodeOptionalParams, ServiceCallback<NodeFileListResult>)

function listFromComputeNode(poolId: string, nodeId: string, options: FileListFromComputeNodeOptionalParams, callback: ServiceCallback<NodeFileListResult>)

パラメーター

poolId

string

コンピューティング ノードを含むプールの ID。

nodeId

string

ファイルを一覧表示するコンピューティング ノードの ID。

options

FileListFromComputeNodeOptionalParams

省略可能なパラメーター

callback

ServiceCallback<NodeFileListResult>

コールバック

listFromComputeNode(string, string, ServiceCallback<NodeFileListResult>)

function listFromComputeNode(poolId: string, nodeId: string, callback: ServiceCallback<NodeFileListResult>)

パラメーター

poolId

string

コンピューティング ノードを含むプールの ID。

nodeId

string

ファイルを一覧表示するコンピューティング ノードの ID。

callback

ServiceCallback<NodeFileListResult>

コールバック

listFromComputeNodeNext(string, FileListFromComputeNodeNextOptionalParams)

function listFromComputeNodeNext(nextPageLink: string, options?: FileListFromComputeNodeNextOptionalParams): Promise<FileListFromComputeNodeResponse>

パラメーター

nextPageLink

string

List 操作に対する前回の正常な呼び出しからの NextLink。

options

FileListFromComputeNodeNextOptionalParams

省略可能なパラメーター

戻り値

Promise<FileListFromComputeNodeResponse>

Promise<Models.FileListFromComputeNodeResponse応答>

listFromComputeNodeNext(string, FileListFromComputeNodeNextOptionalParams, ServiceCallback<NodeFileListResult>)

function listFromComputeNodeNext(nextPageLink: string, options: FileListFromComputeNodeNextOptionalParams, callback: ServiceCallback<NodeFileListResult>)

パラメーター

nextPageLink

string

List 操作に対する前回の正常な呼び出しからの NextLink。

options

FileListFromComputeNodeNextOptionalParams

省略可能なパラメーター

callback

ServiceCallback<NodeFileListResult>

コールバック

listFromComputeNodeNext(string, ServiceCallback<NodeFileListResult>)

function listFromComputeNodeNext(nextPageLink: string, callback: ServiceCallback<NodeFileListResult>)

パラメーター

nextPageLink

string

List 操作に対する前回の正常な呼び出しからの NextLink。

callback

ServiceCallback<NodeFileListResult>

コールバック

listFromTask(string, string, FileListFromTaskOptionalParams)

function listFromTask(jobId: string, taskId: string, options?: FileListFromTaskOptionalParams): Promise<FileListFromTaskResponse>

パラメーター

jobId

string

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

taskId

string

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

options

FileListFromTaskOptionalParams

省略可能なパラメーター

戻り値

Promise<FileListFromTaskResponse>

Promise<Models.FileListFromTaskResponse(Promiseモデル.FileListFromTaskResponse)>

listFromTask(string, string, FileListFromTaskOptionalParams, ServiceCallback<NodeFileListResult>)

function listFromTask(jobId: string, taskId: string, options: FileListFromTaskOptionalParams, callback: ServiceCallback<NodeFileListResult>)

パラメーター

jobId

string

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

taskId

string

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

options

FileListFromTaskOptionalParams

省略可能なパラメーター

callback

ServiceCallback<NodeFileListResult>

コールバック

listFromTask(string, string, ServiceCallback<NodeFileListResult>)

function listFromTask(jobId: string, taskId: string, callback: ServiceCallback<NodeFileListResult>)

パラメーター

jobId

string

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

taskId

string

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

callback

ServiceCallback<NodeFileListResult>

コールバック

listFromTaskNext(string, FileListFromTaskNextOptionalParams)

function listFromTaskNext(nextPageLink: string, options?: FileListFromTaskNextOptionalParams): Promise<FileListFromTaskResponse>

パラメーター

nextPageLink

string

List 操作に対する前回の正常な呼び出しからの NextLink。

options

FileListFromTaskNextOptionalParams

省略可能なパラメーター

戻り値

Promise<FileListFromTaskResponse>

Promise<Models.FileListFromTaskResponse(Promiseモデル.FileListFromTaskResponse)>

listFromTaskNext(string, FileListFromTaskNextOptionalParams, ServiceCallback<NodeFileListResult>)

function listFromTaskNext(nextPageLink: string, options: FileListFromTaskNextOptionalParams, callback: ServiceCallback<NodeFileListResult>)

パラメーター

nextPageLink

string

List 操作に対する前回の正常な呼び出しからの NextLink。

options

FileListFromTaskNextOptionalParams

省略可能なパラメーター

callback

ServiceCallback<NodeFileListResult>

コールバック

listFromTaskNext(string, ServiceCallback<NodeFileListResult>)

function listFromTaskNext(nextPageLink: string, callback: ServiceCallback<NodeFileListResult>)

パラメーター

nextPageLink

string

List 操作に対する前回の正常な呼び出しからの NextLink。

callback

ServiceCallback<NodeFileListResult>

コールバック