Jobs interface

Package:

@azure/arm-machinelearning

Interface representing a Jobs.

Methods

beginCancel(string, string, string, JobsCancelOptionalParams)	Cancels a Job (asynchronous).
beginCancelAndWait(string, string, string, JobsCancelOptionalParams)	Cancels a Job (asynchronous).
beginDelete(string, string, string, JobsDeleteOptionalParams)	Deletes a Job (asynchronous).
beginDeleteAndWait(string, string, string, JobsDeleteOptionalParams)	Deletes a Job (asynchronous).
createOrUpdate(string, string, string, JobBase, JobsCreateOrUpdateOptionalParams)	Creates and executes a Job. For update case, the Tags in the definition passed in will replace Tags in the existing job.
get(string, string, string, JobsGetOptionalParams)	Gets a Job by name/id.
list(string, string, JobsListOptionalParams)	Lists Jobs in the workspace.

Method Details

beginCancel(string, string, string, JobsCancelOptionalParams)

Cancels a Job (asynchronous).

function beginCancel(resourceGroupName: string, workspaceName: string, id: string, options?: JobsCancelOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

Name of Azure Machine Learning workspace.

id

string

The name and identifier for the Job. This is case-sensitive.

options

JobsCancelOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginCancelAndWait(string, string, string, JobsCancelOptionalParams)

Cancels a Job (asynchronous).

function beginCancelAndWait(resourceGroupName: string, workspaceName: string, id: string, options?: JobsCancelOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

Name of Azure Machine Learning workspace.

id

string

The name and identifier for the Job. This is case-sensitive.

options

JobsCancelOptionalParams

The options parameters.

Returns

Promise<void>

beginDelete(string, string, string, JobsDeleteOptionalParams)

Deletes a Job (asynchronous).

function beginDelete(resourceGroupName: string, workspaceName: string, id: string, options?: JobsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

Name of Azure Machine Learning workspace.

id

string

The name and identifier for the Job. This is case-sensitive.

options

JobsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, JobsDeleteOptionalParams)

Deletes a Job (asynchronous).

function beginDeleteAndWait(resourceGroupName: string, workspaceName: string, id: string, options?: JobsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

Name of Azure Machine Learning workspace.

id

string

The name and identifier for the Job. This is case-sensitive.

options

JobsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

createOrUpdate(string, string, string, JobBase, JobsCreateOrUpdateOptionalParams)

Creates and executes a Job. For update case, the Tags in the definition passed in will replace Tags in the existing job.

function createOrUpdate(resourceGroupName: string, workspaceName: string, id: string, body: JobBase, options?: JobsCreateOrUpdateOptionalParams): Promise<JobBase>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

Name of Azure Machine Learning workspace.

id

string

The name and identifier for the Job. This is case-sensitive.

body

JobBase

Job definition object.

options

JobsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<JobBase>

get(string, string, string, JobsGetOptionalParams)

Gets a Job by name/id.

function get(resourceGroupName: string, workspaceName: string, id: string, options?: JobsGetOptionalParams): Promise<JobBase>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

Name of Azure Machine Learning workspace.

id

string

The name and identifier for the Job. This is case-sensitive.

options

JobsGetOptionalParams

The options parameters.

Returns

Promise<JobBase>

list(string, string, JobsListOptionalParams)

Lists Jobs in the workspace.

function list(resourceGroupName: string, workspaceName: string, options?: JobsListOptionalParams): PagedAsyncIterableIterator<JobBase, JobBase[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

Name of Azure Machine Learning workspace.

options

JobsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<JobBase, JobBase[], PageSettings>