JobsOperations Class

JobsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

JobsOperations

Constructor

JobsOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

begin_create	Creates a Job in the given Experiment.
begin_delete	Deletes a Job.
begin_terminate	Terminates a job.
get	Gets information about a Job.
list_by_experiment	Gets a list of Jobs within the specified Experiment.
list_output_files	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).
list_remote_login_information	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.

begin_create

Creates a Job in the given Experiment.

begin_create(resource_group_name: str, workspace_name: str, experiment_name: str, job_name: str, parameters: _models.JobCreateParameters, **kwargs: Any) -> LROPoller[_models.Job]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

workspace_name

str

Required

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.

experiment_name

str

Required

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.

job_name

str

Required

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

<xref:batch_ai.models.JobCreateParameters>

Required

The parameters to provide for job creation.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either Job or the result of cls(response)

Return type

LROPoller[<xref:batch_ai.models.Job>]

Exceptions

HttpResponseError

begin_delete

Deletes a Job.

begin_delete(resource_group_name: str, workspace_name: str, experiment_name: str, job_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

workspace_name

str

Required

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.

experiment_name

str

Required

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.

job_name

str

Required

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.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Exceptions

HttpResponseError

begin_terminate

Terminates a job.

begin_terminate(resource_group_name: str, workspace_name: str, experiment_name: str, job_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

workspace_name

str

Required

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.

experiment_name

str

Required

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.

job_name

str

Required

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.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Exceptions

HttpResponseError

get

Gets information about a Job.

get(resource_group_name: str, workspace_name: str, experiment_name: str, job_name: str, **kwargs: Any) -> _models.Job

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

workspace_name

str

Required

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.

experiment_name

str

Required

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.

job_name

str

Required

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.

cls

callable

A custom type or function that will be passed the direct response

Returns

Job, or the result of cls(response)

Return type

<xref:batch_ai.models.Job>

Exceptions

HttpResponseError

list_by_experiment

Gets a list of Jobs within the specified Experiment.

list_by_experiment(resource_group_name: str, workspace_name: str, experiment_name: str, jobs_list_by_experiment_options: Optional[_models.JobsListByExperimentOptions] = None, **kwargs: Any) -> Iterable[_models.JobListResult]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

workspace_name

str

Required

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.

experiment_name

str

Required

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.

jobs_list_by_experiment_options

<xref:batch_ai.models.JobsListByExperimentOptions>

default value: None

Parameter group.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either JobListResult or the result of cls(response)

Return type

ItemPaged[<xref:batch_ai.models.JobListResult>]

Exceptions

HttpResponseError

list_output_files

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

list_output_files(resource_group_name: str, workspace_name: str, experiment_name: str, job_name: str, jobs_list_output_files_options: _models.JobsListOutputFilesOptions, **kwargs: Any) -> Iterable[_models.FileListResult]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

workspace_name

str

Required

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.

experiment_name

str

Required

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.

job_name

str

Required

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.

jobs_list_output_files_options

<xref:batch_ai.models.JobsListOutputFilesOptions>

Required

Parameter group.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either FileListResult or the result of cls(response)

Return type

ItemPaged[<xref:batch_ai.models.FileListResult>]

Exceptions

HttpResponseError

list_remote_login_information

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.

list_remote_login_information(resource_group_name: str, workspace_name: str, experiment_name: str, job_name: str, **kwargs: Any) -> Iterable[_models.RemoteLoginInformationListResult]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

workspace_name

str

Required

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.

experiment_name

str

Required

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.

job_name

str

Required

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.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either RemoteLoginInformationListResult or the result of cls(response)

Return type

ItemPaged[<xref:batch_ai.models.RemoteLoginInformationListResult>]

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.batchai.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\batchai\\models\\__init__.py'>