Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Jobs

Package version

Class representing a Jobs.

Hierarchy

  • Jobs

Index

Constructors

Methods

Constructors

constructor

Methods

beginCreate

  • beginCreate(resourceGroupName: string, workspaceName: string, experimentName: string, jobName: string, parameters: JobCreateParameters, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Creates a Job in the given Experiment.

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginDeleteMethod

  • beginDeleteMethod(resourceGroupName: string, workspaceName: string, experimentName: string, jobName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Deletes a 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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginTerminate

  • beginTerminate(resourceGroupName: string, workspaceName: string, experimentName: string, jobName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Terminates a 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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

create

  • create(resourceGroupName: string, workspaceName: string, experimentName: string, jobName: string, parameters: JobCreateParameters, options?: msRest.RequestOptionsBase): Promise<Models.JobsCreateResponse>

  • Creates a Job in the given Experiment.

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.JobsCreateResponse>

    Promise<Models.JobsCreateResponse>

deleteMethod

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

  • Deletes a 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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

get

  • get(resourceGroupName: string, workspaceName: string, experimentName: string, jobName: string, options?: msRest.RequestOptionsBase): Promise<Models.JobsGetResponse>
  • get(resourceGroupName: string, workspaceName: string, experimentName: string, jobName: string, callback: msRest.ServiceCallback<Job>): void
  • get(resourceGroupName: string, workspaceName: string, experimentName: string, jobName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Job>): void

  • Gets information about a 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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.JobsGetResponse>

    Promise<Models.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.

    • callback: msRest.ServiceCallback<Job>

      The callback

    Returns void

  • 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<Job>

      The callback

    Returns void

listByExperiment

  • listByExperiment(resourceGroupName: string, workspaceName: string, experimentName: string, options?: Models.JobsListByExperimentOptionalParams): Promise<Models.JobsListByExperimentResponse>
  • listByExperiment(resourceGroupName: string, workspaceName: string, experimentName: string, callback: msRest.ServiceCallback<JobListResult>): void
  • listByExperiment(resourceGroupName: string, workspaceName: string, experimentName: string, options: JobsListByExperimentOptionalParams, callback: msRest.ServiceCallback<JobListResult>): void

  • Gets a list of Jobs within the specified Experiment.

    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.

    • Optional options: Models.JobsListByExperimentOptionalParams

    Returns Promise<Models.JobsListByExperimentResponse>

    Promise<Models.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.

    • callback: msRest.ServiceCallback<JobListResult>

      The callback

    Returns void

  • 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: msRest.ServiceCallback<JobListResult>

      The callback

    Returns void

listByExperimentNext

  • listByExperimentNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.JobsListByExperimentNextResponse>
  • listByExperimentNext(nextPageLink: string, callback: msRest.ServiceCallback<JobListResult>): void
  • listByExperimentNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<JobListResult>): void

  • Gets a list of Jobs within the specified Experiment.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.JobsListByExperimentNextResponse>

    Promise<Models.JobsListByExperimentNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<JobListResult>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<JobListResult>

      The callback

    Returns void

listOutputFiles

  • listOutputFiles(resourceGroupName: string, workspaceName: string, experimentName: string, jobName: string, jobsListOutputFilesOptions: JobsListOutputFilesOptions, options?: msRest.RequestOptionsBase): Promise<Models.JobsListOutputFilesResponse>
  • listOutputFiles(resourceGroupName: string, workspaceName: string, experimentName: string, jobName: string, jobsListOutputFilesOptions: JobsListOutputFilesOptions, callback: msRest.ServiceCallback<FileListResult>): void
  • listOutputFiles(resourceGroupName: string, workspaceName: string, experimentName: string, jobName: string, jobsListOutputFilesOptions: JobsListOutputFilesOptions, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<FileListResult>): void

  • 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).

    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

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.JobsListOutputFilesResponse>

    Promise<Models.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

    • callback: msRest.ServiceCallback<FileListResult>

      The callback

    Returns void

  • 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<FileListResult>

      The callback

    Returns void

listOutputFilesNext

  • listOutputFilesNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.JobsListOutputFilesNextResponse>
  • listOutputFilesNext(nextPageLink: string, callback: msRest.ServiceCallback<FileListResult>): void
  • listOutputFilesNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<FileListResult>): void

  • 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).

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.JobsListOutputFilesNextResponse>

    Promise<Models.JobsListOutputFilesNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<FileListResult>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<FileListResult>

      The callback

    Returns void

listRemoteLoginInformation

  • listRemoteLoginInformation(resourceGroupName: string, workspaceName: string, experimentName: string, jobName: string, options?: msRest.RequestOptionsBase): Promise<Models.JobsListRemoteLoginInformationResponse>
  • listRemoteLoginInformation(resourceGroupName: string, workspaceName: string, experimentName: string, jobName: string, callback: msRest.ServiceCallback<RemoteLoginInformationListResult>): void
  • listRemoteLoginInformation(resourceGroupName: string, workspaceName: string, experimentName: string, jobName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<RemoteLoginInformationListResult>): void

  • 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.

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.JobsListRemoteLoginInformationResponse>

    Promise<Models.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.

    • callback: msRest.ServiceCallback<RemoteLoginInformationListResult>

      The callback

    Returns void

  • 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<RemoteLoginInformationListResult>

      The callback

    Returns void

listRemoteLoginInformationNext

  • listRemoteLoginInformationNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.JobsListRemoteLoginInformationNextResponse>
  • listRemoteLoginInformationNext(nextPageLink: string, callback: msRest.ServiceCallback<RemoteLoginInformationListResult>): void
  • listRemoteLoginInformationNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<RemoteLoginInformationListResult>): void

  • 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.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.JobsListRemoteLoginInformationNextResponse>

    Promise<Models.JobsListRemoteLoginInformationNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<RemoteLoginInformationListResult>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<RemoteLoginInformationListResult>

      The callback

    Returns void

terminate

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

  • Terminates a 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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

Generated using TypeDoc