File class
Class representing a File.
Constructors
| File(Batch |
Create a File. |
Methods
Constructor Details
File(BatchServiceClientContext)
Create a File.
new File(client: BatchServiceClientContext)Parameters
- client
- BatchServiceClientContext
Reference to the service client.
Method Details
deleteFromComputeNode(string, string, string, FileDeleteFromComputeNodeOptionalParams)
function deleteFromComputeNode(poolId: string, nodeId: string, filePath: string, options?: FileDeleteFromComputeNodeOptionalParams): Promise<FileDeleteFromComputeNodeResponse>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.
The optional parameters
Returns
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>)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.
The optional parameters
- callback
-
ServiceCallback<void>
The callback
deleteFromComputeNode(string, string, string, ServiceCallback<void>)
function deleteFromComputeNode(poolId: string, nodeId: string, filePath: string, callback: ServiceCallback<void>)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
-
ServiceCallback<void>
The callback
deleteFromTask(string, string, string, FileDeleteFromTaskOptionalParams)
function deleteFromTask(jobId: string, taskId: string, filePath: string, options?: FileDeleteFromTaskOptionalParams): Promise<FileDeleteFromTaskResponse>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
Returns
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>)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
-
ServiceCallback<void>
The callback
deleteFromTask(string, string, string, ServiceCallback<void>)
function deleteFromTask(jobId: string, taskId: string, filePath: string, callback: ServiceCallback<void>)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
-
ServiceCallback<void>
The callback
getFromComputeNode(string, string, string, FileGetFromComputeNodeOptionalParams)
Returns the content of the specified Compute Node file.
function getFromComputeNode(poolId: string, nodeId: string, filePath: string, options?: FileGetFromComputeNodeOptionalParams): Promise<FileGetFromComputeNodeResponse>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.
The optional parameters
Returns
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>)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.
The optional parameters
- callback
-
ServiceCallback<void>
The callback
getFromComputeNode(string, string, string, ServiceCallback<void>)
function getFromComputeNode(poolId: string, nodeId: string, filePath: string, callback: ServiceCallback<void>)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
-
ServiceCallback<void>
The callback
getFromTask(string, string, string, FileGetFromTaskOptionalParams)
Returns the content of the specified Task file.
function getFromTask(jobId: string, taskId: string, filePath: string, options?: FileGetFromTaskOptionalParams): Promise<FileGetFromTaskResponse>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
Returns
Promise<FileGetFromTaskResponse>
Promise<Models.FileGetFromTaskResponse>
getFromTask(string, string, string, FileGetFromTaskOptionalParams, ServiceCallback<void>)
function getFromTask(jobId: string, taskId: string, filePath: string, options: FileGetFromTaskOptionalParams, callback: ServiceCallback<void>)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
-
ServiceCallback<void>
The callback
getFromTask(string, string, string, ServiceCallback<void>)
function getFromTask(jobId: string, taskId: string, filePath: string, callback: ServiceCallback<void>)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
-
ServiceCallback<void>
The callback
getPropertiesFromComputeNode(string, string, string, FileGetPropertiesFromComputeNodeOptionalParams)
Gets the properties of the specified Compute Node file.
function getPropertiesFromComputeNode(poolId: string, nodeId: string, filePath: string, options?: FileGetPropertiesFromComputeNodeOptionalParams): Promise<FileGetPropertiesFromComputeNodeResponse>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.
The optional parameters
Returns
Promise<Models.FileGetPropertiesFromComputeNodeResponse>
getPropertiesFromComputeNode(string, string, string, FileGetPropertiesFromComputeNodeOptionalParams, ServiceCallback<void>)
function getPropertiesFromComputeNode(poolId: string, nodeId: string, filePath: string, options: FileGetPropertiesFromComputeNodeOptionalParams, callback: ServiceCallback<void>)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.
The optional parameters
- callback
-
ServiceCallback<void>
The callback
getPropertiesFromComputeNode(string, string, string, ServiceCallback<void>)
function getPropertiesFromComputeNode(poolId: string, nodeId: string, filePath: string, callback: ServiceCallback<void>)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
-
ServiceCallback<void>
The callback
getPropertiesFromTask(string, string, string, FileGetPropertiesFromTaskOptionalParams)
Gets the properties of the specified Task file.
function getPropertiesFromTask(jobId: string, taskId: string, filePath: string, options?: FileGetPropertiesFromTaskOptionalParams): Promise<FileGetPropertiesFromTaskResponse>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.
The optional parameters
Returns
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>)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.
The optional parameters
- callback
-
ServiceCallback<void>
The callback
getPropertiesFromTask(string, string, string, ServiceCallback<void>)
function getPropertiesFromTask(jobId: string, taskId: string, filePath: string, callback: ServiceCallback<void>)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
-
ServiceCallback<void>
The callback
listFromComputeNode(string, string, FileListFromComputeNodeOptionalParams)
function listFromComputeNode(poolId: string, nodeId: string, options?: FileListFromComputeNodeOptionalParams): Promise<FileListFromComputeNodeResponse>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.
The optional parameters
Returns
Promise<FileListFromComputeNodeResponse>
Promise<Models.FileListFromComputeNodeResponse>
listFromComputeNode(string, string, FileListFromComputeNodeOptionalParams, ServiceCallback<NodeFileListResult>)
function listFromComputeNode(poolId: string, nodeId: string, options: FileListFromComputeNodeOptionalParams, callback: ServiceCallback<NodeFileListResult>)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.
The optional parameters
- callback
The callback
listFromComputeNode(string, string, ServiceCallback<NodeFileListResult>)
function listFromComputeNode(poolId: string, nodeId: string, callback: ServiceCallback<NodeFileListResult>)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
The callback
listFromComputeNodeNext(string, FileListFromComputeNodeNextOptionalParams)
function listFromComputeNodeNext(nextPageLink: string, options?: FileListFromComputeNodeNextOptionalParams): Promise<FileListFromComputeNodeResponse>Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
The optional parameters
Returns
Promise<FileListFromComputeNodeResponse>
Promise<Models.FileListFromComputeNodeResponse>
listFromComputeNodeNext(string, FileListFromComputeNodeNextOptionalParams, ServiceCallback<NodeFileListResult>)
function listFromComputeNodeNext(nextPageLink: string, options: FileListFromComputeNodeNextOptionalParams, callback: ServiceCallback<NodeFileListResult>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
The optional parameters
- callback
The callback
listFromComputeNodeNext(string, ServiceCallback<NodeFileListResult>)
function listFromComputeNodeNext(nextPageLink: string, callback: ServiceCallback<NodeFileListResult>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- callback
The callback
listFromTask(string, string, FileListFromTaskOptionalParams)
function listFromTask(jobId: string, taskId: string, options?: FileListFromTaskOptionalParams): Promise<FileListFromTaskResponse>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
Returns
Promise<FileListFromTaskResponse>
Promise<Models.FileListFromTaskResponse>
listFromTask(string, string, FileListFromTaskOptionalParams, ServiceCallback<NodeFileListResult>)
function listFromTask(jobId: string, taskId: string, options: FileListFromTaskOptionalParams, callback: ServiceCallback<NodeFileListResult>)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
The callback
listFromTask(string, string, ServiceCallback<NodeFileListResult>)
function listFromTask(jobId: string, taskId: string, callback: ServiceCallback<NodeFileListResult>)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
The callback
listFromTaskNext(string, FileListFromTaskNextOptionalParams)
function listFromTaskNext(nextPageLink: string, options?: FileListFromTaskNextOptionalParams): Promise<FileListFromTaskResponse>Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
The optional parameters
Returns
Promise<FileListFromTaskResponse>
Promise<Models.FileListFromTaskResponse>
listFromTaskNext(string, FileListFromTaskNextOptionalParams, ServiceCallback<NodeFileListResult>)
function listFromTaskNext(nextPageLink: string, options: FileListFromTaskNextOptionalParams, callback: ServiceCallback<NodeFileListResult>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
The optional parameters
- callback
The callback
listFromTaskNext(string, ServiceCallback<NodeFileListResult>)
function listFromTaskNext(nextPageLink: string, callback: ServiceCallback<NodeFileListResult>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- callback
The callback