File | @azure/batch

Class representing a File.

Hierarchy

File

Index

Constructors

constructor

Methods

Constructors

constructor

new File(client: BatchServiceClientContext): File

- Defined in operations/file.ts:19
Create a File.

Parameters
- client: BatchServiceClientContext
  
  Reference to the service client.
Returns File

Methods

deleteFromComputeNode

deleteFromComputeNode(poolId: string, nodeId: string, filePath: string, options?: Models.FileDeleteFromComputeNodeOptionalParams): Promise<Models.FileDeleteFromComputeNodeResponse>
deleteFromComputeNode(poolId: string, nodeId: string, filePath: string, callback: msRest.ServiceCallback<void>): void
deleteFromComputeNode(poolId: string, nodeId: string, filePath: string, options: FileDeleteFromComputeNodeOptionalParams, callback: msRest.ServiceCallback<void>): void

- Defined in operations/file.ts:145
summary

Deletes the specified file from the compute node.

Parameters
- poolId: string
  
  The ID of the pool that contains the compute node.
- nodeId: string
  
  The ID of the compute node from which you want to delete the file.
- filePath: string
  
  The path to the file or directory that you want to delete.
- Optional options: Models.FileDeleteFromComputeNodeOptionalParams
Returns Promise<Models.FileDeleteFromComputeNodeResponse>

Promise<Models.FileDeleteFromComputeNodeResponse>
- Defined in operations/file.ts:152
Parameters
- poolId: string
  
  The ID of the pool that contains the compute node.
- nodeId: string
  
  The ID of the compute node from which you want to delete the file.
- filePath: string
  
  The path to the file or directory that you want to delete.
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void
- Defined in operations/file.ts:160
Parameters
- poolId: string
  
  The ID of the pool that contains the compute node.
- nodeId: string
  
  The ID of the compute node from which you want to delete the file.
- filePath: string
  
  The path to the file or directory that you want to delete.
- options: FileDeleteFromComputeNodeOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void

deleteFromTask

deleteFromTask(jobId: string, taskId: string, filePath: string, options?: Models.FileDeleteFromTaskOptionalParams): Promise<Models.FileDeleteFromTaskResponse>
deleteFromTask(jobId: string, taskId: string, filePath: string, callback: msRest.ServiceCallback<void>): void
deleteFromTask(jobId: string, taskId: string, filePath: string, options: FileDeleteFromTaskOptionalParams, callback: msRest.ServiceCallback<void>): void

- Defined in operations/file.ts:37
summary

Deletes the specified task file from the compute node where the task ran.

Parameters
- jobId: string
  
  The ID of the job that contains the task.
- taskId: string
  
  The ID of the task whose file you want to delete.
- filePath: string
  
  The path to the task file or directory that you want to delete.
- Optional options: Models.FileDeleteFromTaskOptionalParams
Returns Promise<Models.FileDeleteFromTaskResponse>

Promise<Models.FileDeleteFromTaskResponse>
- Defined in operations/file.ts:44
Parameters
- jobId: string
  
  The ID of the job that contains the task.
- taskId: string
  
  The ID of the task whose file you want to delete.
- filePath: string
  
  The path to the task file or directory that you want to delete.
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void
- Defined in operations/file.ts:52
Parameters
- jobId: string
  
  The ID of the job that contains the task.
- taskId: string
  
  The ID of the task whose file you want to delete.
- filePath: string
  
  The path to the task file or directory that you want to delete.
- options: FileDeleteFromTaskOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void

getFromComputeNode

getFromComputeNode(poolId: string, nodeId: string, filePath: string, options?: Models.FileGetFromComputeNodeOptionalParams): Promise<Models.FileGetFromComputeNodeResponse>
getFromComputeNode(poolId: string, nodeId: string, filePath: string, callback: msRest.ServiceCallback<void>): void
getFromComputeNode(poolId: string, nodeId: string, filePath: string, options: FileGetFromComputeNodeOptionalParams, callback: msRest.ServiceCallback<void>): void

- Defined in operations/file.ts:181
Returns the content of the specified compute node file.

Parameters
- poolId: string
  
  The ID of the pool that contains the compute node.
- nodeId: string
  
  The ID of the compute node that contains the file.
- filePath: string
  
  The path to the compute node file that you want to get the content of.
- Optional options: Models.FileGetFromComputeNodeOptionalParams
Returns Promise<Models.FileGetFromComputeNodeResponse>

Promise<Models.FileGetFromComputeNodeResponse>
- Defined in operations/file.ts:188
Parameters
- poolId: string
  
  The ID of the pool that contains the compute node.
- nodeId: string
  
  The ID of the compute node that contains the file.
- filePath: string
  
  The path to the compute node file that you want to get the content of.
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void
- Defined in operations/file.ts:196
Parameters
- poolId: string
  
  The ID of the pool that contains the compute node.
- nodeId: string
  
  The ID of the compute node that contains the file.
- filePath: string
  
  The path to the compute node file that you want to get the content of.
- options: FileGetFromComputeNodeOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void

getFromTask

getFromTask(jobId: string, taskId: string, filePath: string, options?: Models.FileGetFromTaskOptionalParams): Promise<Models.FileGetFromTaskResponse>
getFromTask(jobId: string, taskId: string, filePath: string, callback: msRest.ServiceCallback<void>): void
getFromTask(jobId: string, taskId: string, filePath: string, options: FileGetFromTaskOptionalParams, callback: msRest.ServiceCallback<void>): void

- Defined in operations/file.ts:73
Returns the content of the specified task file.

Parameters
- jobId: string
  
  The ID of the job that contains the task.
- taskId: string
  
  The ID of the task whose file you want to retrieve.
- filePath: string
  
  The path to the task file that you want to get the content of.
- Optional options: Models.FileGetFromTaskOptionalParams
Returns Promise<Models.FileGetFromTaskResponse>

Promise<Models.FileGetFromTaskResponse>
- Defined in operations/file.ts:80
Parameters
- jobId: string
  
  The ID of the job that contains the task.
- taskId: string
  
  The ID of the task whose file you want to retrieve.
- filePath: string
  
  The path to the task file that you want to get the content of.
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void
- Defined in operations/file.ts:88
Parameters
- jobId: string
  
  The ID of the job that contains the task.
- taskId: string
  
  The ID of the task whose file you want to retrieve.
- filePath: string
  
  The path to the task file that you want to get the content of.
- options: FileGetFromTaskOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void

getPropertiesFromComputeNode

getPropertiesFromComputeNode(poolId: string, nodeId: string, filePath: string, options?: Models.FileGetPropertiesFromComputeNodeOptionalParams): Promise<Models.FileGetPropertiesFromComputeNodeResponse>
getPropertiesFromComputeNode(poolId: string, nodeId: string, filePath: string, callback: msRest.ServiceCallback<void>): void
getPropertiesFromComputeNode(poolId: string, nodeId: string, filePath: string, options: FileGetPropertiesFromComputeNodeOptionalParams, callback: msRest.ServiceCallback<void>): void

- Defined in operations/file.ts:217
Gets the properties of the specified compute node file.

Parameters
- poolId: string
  
  The ID of the pool that contains the compute node.
- nodeId: string
  
  The ID of the compute node that contains the file.
- filePath: string
  
  The path to the compute node file that you want to get the properties of.
- Optional options: Models.FileGetPropertiesFromComputeNodeOptionalParams
Returns Promise<Models.FileGetPropertiesFromComputeNodeResponse>

Promise<Models.FileGetPropertiesFromComputeNodeResponse>
- Defined in operations/file.ts:224
Parameters
- poolId: string
  
  The ID of the pool that contains the compute node.
- nodeId: string
  
  The ID of the compute node that contains the file.
- filePath: string
  
  The path to the compute node file that you want to get the properties of.
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void
- Defined in operations/file.ts:232
Parameters
- poolId: string
  
  The ID of the pool that contains the compute node.
- nodeId: string
  
  The ID of the compute node that contains the file.
- filePath: string
  
  The path to the compute node file that you want to get the properties of.
- options: FileGetPropertiesFromComputeNodeOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void

getPropertiesFromTask

getPropertiesFromTask(jobId: string, taskId: string, filePath: string, options?: Models.FileGetPropertiesFromTaskOptionalParams): Promise<Models.FileGetPropertiesFromTaskResponse>
getPropertiesFromTask(jobId: string, taskId: string, filePath: string, callback: msRest.ServiceCallback<void>): void
getPropertiesFromTask(jobId: string, taskId: string, filePath: string, options: FileGetPropertiesFromTaskOptionalParams, callback: msRest.ServiceCallback<void>): void

- Defined in operations/file.ts:109
Gets the properties of the specified task file.

Parameters
- jobId: string
  
  The ID of the job that contains the task.
- taskId: string
  
  The ID of the task whose file you want to get the properties of.
- filePath: string
  
  The path to the task file that you want to get the properties of.
- Optional options: Models.FileGetPropertiesFromTaskOptionalParams
Returns Promise<Models.FileGetPropertiesFromTaskResponse>

Promise<Models.FileGetPropertiesFromTaskResponse>
- Defined in operations/file.ts:116
Parameters
- jobId: string
  
  The ID of the job that contains the task.
- taskId: string
  
  The ID of the task whose file you want to get the properties of.
- filePath: string
  
  The path to the task file that you want to get the properties of.
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void
- Defined in operations/file.ts:124
Parameters
- jobId: string
  
  The ID of the job that contains the task.
- taskId: string
  
  The ID of the task whose file you want to get the properties of.
- filePath: string
  
  The path to the task file that you want to get the properties of.
- options: FileGetPropertiesFromTaskOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void

listFromComputeNode

listFromComputeNode(poolId: string, nodeId: string, options?: Models.FileListFromComputeNodeOptionalParams): Promise<Models.FileListFromComputeNodeResponse>
listFromComputeNode(poolId: string, nodeId: string, callback: msRest.ServiceCallback<NodeFileListResult>): void
listFromComputeNode(poolId: string, nodeId: string, options: FileListFromComputeNodeOptionalParams, callback: msRest.ServiceCallback<NodeFileListResult>): void

- Defined in operations/file.ts:284
summary

Lists all of the files in task directories on the specified compute node.

Parameters
- poolId: string
  
  The ID of the pool that contains the compute node.
- nodeId: string
  
  The ID of the compute node whose files you want to list.
- Optional options: Models.FileListFromComputeNodeOptionalParams
Returns Promise<Models.FileListFromComputeNodeResponse>

Promise<Models.FileListFromComputeNodeResponse>
- Defined in operations/file.ts:290
Parameters
- poolId: string
  
  The ID of the pool that contains the compute node.
- nodeId: string
  
  The ID of the compute node whose files you want to list.
- callback: msRest.ServiceCallback<NodeFileListResult>
  
  The callback
Returns void
- Defined in operations/file.ts:297
Parameters
- poolId: string
  
  The ID of the pool that contains the compute node.
- nodeId: string
  
  The ID of the compute node whose files you want to list.
- options: FileListFromComputeNodeOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<NodeFileListResult>
  
  The callback
Returns void

listFromComputeNodeNext

listFromComputeNodeNext(nextPageLink: string, options?: Models.FileListFromComputeNodeNextOptionalParams): Promise<Models.FileListFromComputeNodeResponse>
listFromComputeNodeNext(nextPageLink: string, callback: msRest.ServiceCallback<NodeFileListResult>): void
listFromComputeNodeNext(nextPageLink: string, options: FileListFromComputeNodeNextOptionalParams, callback: msRest.ServiceCallback<NodeFileListResult>): void

- Defined in operations/file.ts:343
summary

Lists all of the files in task directories on the specified compute node.

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: Models.FileListFromComputeNodeNextOptionalParams
Returns Promise<Models.FileListFromComputeNodeResponse>

Promise<Models.FileListFromComputeNodeResponse>
- Defined in operations/file.ts:348
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<NodeFileListResult>
  
  The callback
Returns void
- Defined in operations/file.ts:354
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: FileListFromComputeNodeNextOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<NodeFileListResult>
  
  The callback
Returns void

listFromTask

listFromTask(jobId: string, taskId: string, options?: Models.FileListFromTaskOptionalParams): Promise<Models.FileListFromTaskResponse>
listFromTask(jobId: string, taskId: string, callback: msRest.ServiceCallback<NodeFileListResult>): void
listFromTask(jobId: string, taskId: string, options: FileListFromTaskOptionalParams, callback: msRest.ServiceCallback<NodeFileListResult>): void

- Defined in operations/file.ts:252
summary

Lists the files in a task's directory on its compute node.

Parameters
- jobId: string
  
  The ID of the job that contains the task.
- taskId: string
  
  The ID of the task whose files you want to list.
- Optional options: Models.FileListFromTaskOptionalParams
Returns Promise<Models.FileListFromTaskResponse>

Promise<Models.FileListFromTaskResponse>
- Defined in operations/file.ts:258
Parameters
- jobId: string
  
  The ID of the job that contains the task.
- taskId: string
  
  The ID of the task whose files you want to list.
- callback: msRest.ServiceCallback<NodeFileListResult>
  
  The callback
Returns void
- Defined in operations/file.ts:265
Parameters
- jobId: string
  
  The ID of the job that contains the task.
- taskId: string
  
  The ID of the task whose files you want to list.
- options: FileListFromTaskOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<NodeFileListResult>
  
  The callback
Returns void

listFromTaskNext

listFromTaskNext(nextPageLink: string, options?: Models.FileListFromTaskNextOptionalParams): Promise<Models.FileListFromTaskResponse>
listFromTaskNext(nextPageLink: string, callback: msRest.ServiceCallback<NodeFileListResult>): void
listFromTaskNext(nextPageLink: string, options: FileListFromTaskNextOptionalParams, callback: msRest.ServiceCallback<NodeFileListResult>): void

- Defined in operations/file.ts:315
summary

Lists the files in a task's directory on its compute node.

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: Models.FileListFromTaskNextOptionalParams
Returns Promise<Models.FileListFromTaskResponse>

Promise<Models.FileListFromTaskResponse>
- Defined in operations/file.ts:320
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<NodeFileListResult>
  
  The callback
Returns void
- Defined in operations/file.ts:326
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: FileListFromTaskNextOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<NodeFileListResult>
  
  The callback
Returns void

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: BatchServiceClientContext

Returns File

Methods

deleteFromComputeNode

Parameters

poolId: string

nodeId: string

filePath: string

Optional options: Models.FileDeleteFromComputeNodeOptionalParams

Returns Promise<Models.FileDeleteFromComputeNodeResponse>

Parameters

poolId: string

nodeId: string

filePath: string

callback: msRest.ServiceCallback<void>

Returns void

Parameters

poolId: string

nodeId: string

filePath: string

options: FileDeleteFromComputeNodeOptionalParams

callback: msRest.ServiceCallback<void>

Returns void

deleteFromTask

Parameters

jobId: string

taskId: string

filePath: string

Optional options: Models.FileDeleteFromTaskOptionalParams

Returns Promise<Models.FileDeleteFromTaskResponse>

Parameters

jobId: string

taskId: string

filePath: string

callback: msRest.ServiceCallback<void>

Returns void

Parameters

jobId: string

taskId: string

filePath: string

options: FileDeleteFromTaskOptionalParams

callback: msRest.ServiceCallback<void>

Returns void

getFromComputeNode

Parameters

poolId: string

nodeId: string

filePath: string

Optional options: Models.FileGetFromComputeNodeOptionalParams

Returns Promise<Models.FileGetFromComputeNodeResponse>

Parameters

poolId: string

nodeId: string

filePath: string

callback: msRest.ServiceCallback<void>

Returns void

Parameters

poolId: string

nodeId: string

filePath: string

options: FileGetFromComputeNodeOptionalParams

callback: msRest.ServiceCallback<void>

Returns void

getFromTask

Parameters

jobId: string

taskId: string

filePath: string

Optional options: Models.FileGetFromTaskOptionalParams

Returns Promise<Models.FileGetFromTaskResponse>

Parameters

jobId: string

taskId: string