Share via

Jobs class

  • Reference
Package:
@azure/arm-batchai

Class representing a Jobs.

Constructors

Jobs(BatchAIManagementClientContext)

Create a Jobs.

Methods

beginCreate(string, string, string, string, JobCreateParameters, RequestOptionsBase)

Creates a Job in the given Experiment.
beginDeleteMethod(string, string, string, string, RequestOptionsBase)

Deletes a Job.
beginTerminate(string, string, string, string, RequestOptionsBase)

Terminates a job.
create(string, string, string, string, JobCreateParameters, RequestOptionsBase)

Creates a Job in the given Experiment.
deleteMethod(string, string, string, string, RequestOptionsBase)

Deletes a Job.
get(string, string, string, string, RequestOptionsBase)

Gets information about a Job.
get(string, string, string, string, RequestOptionsBase, ServiceCallback<Job>)
get(string, string, string, string, ServiceCallback<Job>)
listByExperiment(string, string, string, JobsListByExperimentOptionalParams)

Gets a list of Jobs within the specified Experiment.
listByExperiment(string, string, string, JobsListByExperimentOptionalParams, ServiceCallback<JobListResult>)
listByExperiment(string, string, string, ServiceCallback<JobListResult>)
listByExperimentNext(string, RequestOptionsBase)

Gets a list of Jobs within the specified Experiment.
listByExperimentNext(string, RequestOptionsBase, ServiceCallback<JobListResult>)
listByExperimentNext(string, ServiceCallback<JobListResult>)
listOutputFiles(string, string, string, string, JobsListOutputFilesOptions, RequestOptionsBase)

List all directories and files inside the given directory of the Job's output directory (if the output directory is on Azure File Share or Azure Storage Container).
listOutputFiles(string, string, string, string, JobsListOutputFilesOptions, RequestOptionsBase, ServiceCallback<FileListResult>)
listOutputFiles(string, string, string, string, JobsListOutputFilesOptions, ServiceCallback<FileListResult>)
listOutputFilesNext(string, RequestOptionsBase)

List all directories and files inside the given directory of the Job's output directory (if the output directory is on Azure File Share or Azure Storage Container).
listOutputFilesNext(string, RequestOptionsBase, ServiceCallback<FileListResult>)
listOutputFilesNext(string, ServiceCallback<FileListResult>)
listRemoteLoginInformation(string, string, string, string, RequestOptionsBase)

Gets a list of currently existing nodes which were used for the Job execution. The returned information contains the node ID, its public IP and SSH port.
listRemoteLoginInformation(string, string, string, string, RequestOptionsBase, ServiceCallback<RemoteLoginInformationListResult>)
listRemoteLoginInformation(string, string, string, string, ServiceCallback<RemoteLoginInformationListResult>)
listRemoteLoginInformationNext(string, RequestOptionsBase)

Gets a list of currently existing nodes which were used for the Job execution. The returned information contains the node ID, its public IP and SSH port.
listRemoteLoginInformationNext(string, RequestOptionsBase, ServiceCallback<RemoteLoginInformationListResult>)
listRemoteLoginInformationNext(string, ServiceCallback<RemoteLoginInformationListResult>)
terminate(string, string, string, string, RequestOptionsBase)

Terminates a job.

Constructor Details

Jobs(BatchAIManagementClientContext)

Create a Jobs.

new Jobs(client: BatchAIManagementClientContext)

Parameters

client
BatchAIManagementClientContext

Reference to the service client.

Method Details

beginCreate(string, string, string, string, JobCreateParameters, RequestOptionsBase)

Creates a Job in the given Experiment.

function beginCreate(resourceGroupName: string, workspaceName: string, experimentName: string, jobName: string, parameters: JobCreateParameters, options?: RequestOptionsBase): Promise<LROPoller>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

workspaceName

string

The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

experimentName

string

The name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

jobName

string

The name of the job within the specified resource group. Job names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

parameters
JobCreateParameters

The parameters to provide for job creation.

options
RequestOptionsBase

The optional parameters

Returns

Promise<@azure/ms-rest-azure-js.LROPoller>

Promise<msRestAzure.LROPoller>

beginDeleteMethod(string, string, string, string, RequestOptionsBase)

Deletes a Job.

function beginDeleteMethod(resourceGroupName: string, workspaceName: string, experimentName: string, jobName: string, options?: RequestOptionsBase): Promise<LROPoller>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

workspaceName

string

The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

experimentName

string

The name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

jobName

string

The name of the job within the specified resource group. Job names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

options
RequestOptionsBase

The optional parameters

Returns

Promise<@azure/ms-rest-azure-js.LROPoller>

Promise<msRestAzure.LROPoller>

beginTerminate(string, string, string, string, RequestOptionsBase)

Terminates a job.

function beginTerminate(resourceGroupName: string, workspaceName: string, experimentName: string, jobName: string, options?: RequestOptionsBase): Promise<LROPoller>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

workspaceName

string

The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

experimentName

string

The name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

jobName

string

The name of the job within the specified resource group. Job names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

options
RequestOptionsBase

The optional parameters

Returns

Promise<@azure/ms-rest-azure-js.LROPoller>

Promise<msRestAzure.LROPoller>

create(string, string, string, string, JobCreateParameters, RequestOptionsBase)

Creates a Job in the given Experiment.

function create(resourceGroupName: string, workspaceName: string, experimentName: string, jobName: string, parameters: JobCreateParameters, options?: RequestOptionsBase): Promise<JobsCreateResponse>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

workspaceName

string

The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

experimentName

string

The name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

jobName

string

The name of the job within the specified resource group. Job names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

parameters
JobCreateParameters

The parameters to provide for job creation.

options
RequestOptionsBase

The optional parameters

Returns

Promise<JobsCreateResponse>

Promise<Models.JobsCreateResponse>

deleteMethod(string, string, string, string, RequestOptionsBase)

Deletes a Job.

function deleteMethod(resourceGroupName: string, workspaceName: string, experimentName: string, jobName: string, options?: RequestOptionsBase): Promise<RestResponse>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

workspaceName

string

The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

experimentName

string

The name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

jobName

string

The name of the job within the specified resource group. Job names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

options
RequestOptionsBase

The optional parameters

Returns

Promise<RestResponse>

Promise<msRest.RestResponse>

get(string, string, string, string, RequestOptionsBase)

Gets information about a Job.

function get(resourceGroupName: string, workspaceName: string, experimentName: string, jobName: string, options?: RequestOptionsBase): Promise<JobsGetResponse>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

workspaceName

string

The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

experimentName

string

The name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

jobName

string

The name of the job within the specified resource group. Job names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

options
RequestOptionsBase

The optional parameters

Returns

Promise<JobsGetResponse>

Promise<Models.JobsGetResponse>

get(string, string, string, string, RequestOptionsBase, ServiceCallback<Job>) 

function get(resourceGroupName: string, workspaceName: string, experimentName: string, jobName: string, options: RequestOptionsBase, callback: ServiceCallback<Job>)

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

workspaceName

string

The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

experimentName

string

The name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

jobName

string

The name of the job within the specified resource group. Job names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<Job>

The callback

get(string, string, string, string, ServiceCallback<Job>) 

function get(resourceGroupName: string, workspaceName: string, experimentName: string, jobName: string, callback: ServiceCallback<Job>)

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

workspaceName

string

The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

experimentName

string

The name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

jobName

string

The name of the job within the specified resource group. Job names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

callback

ServiceCallback<Job>

The callback

listByExperiment(string, string, string, JobsListByExperimentOptionalParams)

Gets a list of Jobs within the specified Experiment.

function listByExperiment(resourceGroupName: string, workspaceName: string, experimentName: string, options?: JobsListByExperimentOptionalParams): Promise<JobsListByExperimentResponse>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

workspaceName

string

The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

experimentName

string

The name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

options
JobsListByExperimentOptionalParams

The optional parameters

Returns

Promise<JobsListByExperimentResponse>

Promise<Models.JobsListByExperimentResponse>

listByExperiment(string, string, string, JobsListByExperimentOptionalParams, ServiceCallback<JobListResult>) 

function listByExperiment(resourceGroupName: string, workspaceName: string, experimentName: string, options: JobsListByExperimentOptionalParams, callback: ServiceCallback<JobListResult>)

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

workspaceName

string

The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

experimentName

string

The name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

options
JobsListByExperimentOptionalParams

The optional parameters

callback

ServiceCallback<JobListResult>

The callback

listByExperiment(string, string, string, ServiceCallback<JobListResult>) 

function listByExperiment(resourceGroupName: string, workspaceName: string, experimentName: string, callback: ServiceCallback<JobListResult>)

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

workspaceName

string

The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

experimentName

string

The name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

callback

ServiceCallback<JobListResult>

The callback

listByExperimentNext(string, RequestOptionsBase)

Gets a list of Jobs within the specified Experiment.

function listByExperimentNext(nextPageLink: string, options?: RequestOptionsBase): Promise<JobsListByExperimentNextResponse>

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

options
RequestOptionsBase

The optional parameters

Returns

Promise<JobsListByExperimentNextResponse>

Promise<Models.JobsListByExperimentNextResponse>

listByExperimentNext(string, RequestOptionsBase, ServiceCallback<JobListResult>) 

function listByExperimentNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<JobListResult>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<JobListResult>

The callback

listByExperimentNext(string, ServiceCallback<JobListResult>) 

function listByExperimentNext(nextPageLink: string, callback: ServiceCallback<JobListResult>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

callback

ServiceCallback<JobListResult>

The callback

listOutputFiles(string, string, string, string, JobsListOutputFilesOptions, RequestOptionsBase)

List all directories and files inside the given directory of the Job's output directory (if the output directory is on Azure File Share or Azure Storage Container).

function listOutputFiles(resourceGroupName: string, workspaceName: string, experimentName: string, jobName: string, jobsListOutputFilesOptions: JobsListOutputFilesOptions, options?: RequestOptionsBase): Promise<JobsListOutputFilesResponse>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

workspaceName

string

The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

experimentName

string

The name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

jobName

string

The name of the job within the specified resource group. Job names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

jobsListOutputFilesOptions
JobsListOutputFilesOptions

Additional parameters for the operation

options
RequestOptionsBase

The optional parameters

Returns

Promise<JobsListOutputFilesResponse>

Promise<Models.JobsListOutputFilesResponse>

listOutputFiles(string, string, string, string, JobsListOutputFilesOptions, RequestOptionsBase, ServiceCallback<FileListResult>) 

function listOutputFiles(resourceGroupName: string, workspaceName: string, experimentName: string, jobName: string, jobsListOutputFilesOptions: JobsListOutputFilesOptions, options: RequestOptionsBase, callback: ServiceCallback<FileListResult>)

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

workspaceName

string

The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

experimentName

string

The name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

jobName

string

The name of the job within the specified resource group. Job names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

jobsListOutputFilesOptions
JobsListOutputFilesOptions

Additional parameters for the operation

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<FileListResult>

The callback

listOutputFiles(string, string, string, string, JobsListOutputFilesOptions, ServiceCallback<FileListResult>) 

function listOutputFiles(resourceGroupName: string, workspaceName: string, experimentName: string, jobName: string, jobsListOutputFilesOptions: JobsListOutputFilesOptions, callback: ServiceCallback<FileListResult>)

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

workspaceName

string

The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

experimentName

string

The name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

jobName

string

The name of the job within the specified resource group. Job names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

jobsListOutputFilesOptions
JobsListOutputFilesOptions

Additional parameters for the operation

callback

ServiceCallback<FileListResult>

The callback

listOutputFilesNext(string, RequestOptionsBase)

List all directories and files inside the given directory of the Job's output directory (if the output directory is on Azure File Share or Azure Storage Container).

function listOutputFilesNext(nextPageLink: string, options?: RequestOptionsBase): Promise<JobsListOutputFilesNextResponse>

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

options
RequestOptionsBase

The optional parameters

Returns

Promise<JobsListOutputFilesNextResponse>

Promise<Models.JobsListOutputFilesNextResponse>

listOutputFilesNext(string, RequestOptionsBase, ServiceCallback<FileListResult>) 

function listOutputFilesNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<FileListResult>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<FileListResult>

The callback

listOutputFilesNext(string, ServiceCallback<FileListResult>) 

function listOutputFilesNext(nextPageLink: string, callback: ServiceCallback<FileListResult>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

callback

ServiceCallback<FileListResult>

The callback

listRemoteLoginInformation(string, string, string, string, RequestOptionsBase)

Gets a list of currently existing nodes which were used for the Job execution. The returned information contains the node ID, its public IP and SSH port.

function listRemoteLoginInformation(resourceGroupName: string, workspaceName: string, experimentName: string, jobName: string, options?: RequestOptionsBase): Promise<JobsListRemoteLoginInformationResponse>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

workspaceName

string

The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

experimentName

string

The name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

jobName

string

The name of the job within the specified resource group. Job names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

options
RequestOptionsBase

The optional parameters

Returns

Promise<JobsListRemoteLoginInformationResponse>

Promise<Models.JobsListRemoteLoginInformationResponse>

listRemoteLoginInformation(string, string, string, string, RequestOptionsBase, ServiceCallback<RemoteLoginInformationListResult>) 

function listRemoteLoginInformation(resourceGroupName: string, workspaceName: string, experimentName: string, jobName: string, options: RequestOptionsBase, callback: ServiceCallback<RemoteLoginInformationListResult>)

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

workspaceName

string

The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

experimentName

string

The name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

jobName

string

The name of the job within the specified resource group. Job names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<RemoteLoginInformationListResult>

The callback

listRemoteLoginInformation(string, string, string, string, ServiceCallback<RemoteLoginInformationListResult>) 

function listRemoteLoginInformation(resourceGroupName: string, workspaceName: string, experimentName: string, jobName: string, callback: ServiceCallback<RemoteLoginInformationListResult>)

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

workspaceName

string

The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

experimentName

string

The name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

jobName

string

The name of the job within the specified resource group. Job names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

callback

ServiceCallback<RemoteLoginInformationListResult>

The callback

listRemoteLoginInformationNext(string, RequestOptionsBase)

Gets a list of currently existing nodes which were used for the Job execution. The returned information contains the node ID, its public IP and SSH port.

function listRemoteLoginInformationNext(nextPageLink: string, options?: RequestOptionsBase): Promise<JobsListRemoteLoginInformationNextResponse>

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

options
RequestOptionsBase

The optional parameters

Returns

Promise<JobsListRemoteLoginInformationNextResponse>

Promise<Models.JobsListRemoteLoginInformationNextResponse>

listRemoteLoginInformationNext(string, RequestOptionsBase, ServiceCallback<RemoteLoginInformationListResult>) 

function listRemoteLoginInformationNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<RemoteLoginInformationListResult>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<RemoteLoginInformationListResult>

The callback

listRemoteLoginInformationNext(string, ServiceCallback<RemoteLoginInformationListResult>) 

function listRemoteLoginInformationNext(nextPageLink: string, callback: ServiceCallback<RemoteLoginInformationListResult>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

callback

ServiceCallback<RemoteLoginInformationListResult>

The callback

terminate(string, string, string, string, RequestOptionsBase)

Terminates a job.

function terminate(resourceGroupName: string, workspaceName: string, experimentName: string, jobName: string, options?: RequestOptionsBase): Promise<RestResponse>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

workspaceName

string

The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

experimentName

string

The name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

jobName

string

The name of the job within the specified resource group. Job names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

options
RequestOptionsBase

The optional parameters

Returns

Promise<RestResponse>

Promise<msRest.RestResponse>