azure.mgmt.batchai.operations module

class azure.mgmt.batchai.operations.Operations(client, config, serializer, deserializer)

Bases: object

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

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

list(**kwargs: Any) → Iterable[‘_models.OperationListResult’]

Lists available operations for the Microsoft.BatchAI provider.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[OperationListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.batchai.models' from '/mnt/vss/_work/1/s/sdk/batchai/azure-mgmt-batchai/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/batchai/models/__init__.py'>

class azure.mgmt.batchai.operations.UsagesOperations(client, config, serializer, deserializer)

Bases: object

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

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

list(location: str, **kwargs: Any) → Iterable[‘_models.ListUsagesResult’]

Gets the current usage information as well as limits for Batch AI resources for given subscription.

Parameters

location (str) – The location for which resource usage is queried.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ListUsagesResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.batchai.models' from '/mnt/vss/_work/1/s/sdk/batchai/azure-mgmt-batchai/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/batchai/models/__init__.py'>

class azure.mgmt.batchai.operations.WorkspacesOperations(client, config, serializer, deserializer)

Bases: object

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

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

begin_create(resource_group_name: str, workspace_name: str, parameters: ‘_models.WorkspaceCreateParameters’, **kwargs: Any) → LROPoller[‘_models.Workspace’]

Creates a Workspace.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• workspace_name (str) – 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.

• parameters (WorkspaceCreateParameters) – Workspace creation parameters.

Keyword Arguments

• 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 Workspace or the result of cls(response)

Return type

LROPoller[Workspace]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, workspace_name: str, **kwargs: Any) → LROPoller[None]

Deletes a Workspace.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• workspace_name (str) – 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.

Keyword Arguments

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

Raises

HttpResponseError –

get(resource_group_name: str, workspace_name: str, **kwargs: Any) → ’_models.Workspace’

Gets information about a Workspace.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• workspace_name (str) – 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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Workspace, or the result of cls(response)

Return type

Workspace

Raises

~azure.core.exceptions.HttpResponseError

list(workspaces_list_options: Optional[‘_models.WorkspacesListOptions’] = None, **kwargs: Any) → Iterable[‘_models.WorkspaceListResult’]

Gets a list of Workspaces associated with the given subscription.

Parameters

workspaces_list_options (WorkspacesListOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[WorkspaceListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_by_resource_group(resource_group_name: str, workspaces_list_by_resource_group_options: Optional[‘_models.WorkspacesListByResourceGroupOptions’] = None, **kwargs: Any) → Iterable[‘_models.WorkspaceListResult’]

Gets a list of Workspaces within the specified resource group.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• workspaces_list_by_resource_group_options (WorkspacesListByResourceGroupOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[WorkspaceListResult]

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, workspace_name: str, parameters: ‘_models.WorkspaceUpdateParameters’, **kwargs: Any) → ’_models.Workspace’

Updates properties of a Workspace.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• workspace_name (str) – 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.

• parameters (WorkspaceUpdateParameters) – Additional parameters for workspace update.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Workspace, or the result of cls(response)

Return type

Workspace

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.batchai.models' from '/mnt/vss/_work/1/s/sdk/batchai/azure-mgmt-batchai/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/batchai/models/__init__.py'>

class azure.mgmt.batchai.operations.ExperimentsOperations(client, config, serializer, deserializer)

Bases: object

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

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

begin_create(resource_group_name: str, workspace_name: str, experiment_name: str, **kwargs: Any) → LROPoller[‘_models.Experiment’]

Creates an Experiment.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• workspace_name (str) – 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) – 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.

Keyword Arguments

• 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 Experiment or the result of cls(response)

Return type

LROPoller[Experiment]

Raises

HttpResponseError –

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

Deletes an Experiment.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• workspace_name (str) – 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) – 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.

Keyword Arguments

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

Raises

HttpResponseError –

get(resource_group_name: str, workspace_name: str, experiment_name: str, **kwargs: Any) → ’_models.Experiment’

Gets information about an Experiment.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• workspace_name (str) – 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) – 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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Experiment, or the result of cls(response)

Return type

Experiment

Raises

~azure.core.exceptions.HttpResponseError

list_by_workspace(resource_group_name: str, workspace_name: str, experiments_list_by_workspace_options: Optional[‘_models.ExperimentsListByWorkspaceOptions’] = None, **kwargs: Any) → Iterable[‘_models.ExperimentListResult’]

Gets a list of Experiments within the specified Workspace.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• workspace_name (str) – 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.

• experiments_list_by_workspace_options (ExperimentsListByWorkspaceOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ExperimentListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.batchai.models' from '/mnt/vss/_work/1/s/sdk/batchai/azure-mgmt-batchai/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/batchai/models/__init__.py'>

class azure.mgmt.batchai.operations.JobsOperations(client, config, serializer, deserializer)

Bases: object

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.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

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

Creates a Job in the given Experiment.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• workspace_name (str) – 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) – 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) – 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.

Keyword Arguments

• 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[Job]

Raises

HttpResponseError –

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

Deletes a Job.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• workspace_name (str) – 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) – 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) – 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.

Keyword Arguments

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

Raises

HttpResponseError –

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

Terminates a job.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• workspace_name (str) – 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) – 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) – 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.

Keyword Arguments

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

Raises

HttpResponseError –

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

Gets information about a Job.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• workspace_name (str) – 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) – 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) – 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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Job, or the result of cls(response)

Return type

Job

Raises

~azure.core.exceptions.HttpResponseError

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’]

Gets a list of Jobs within the specified Experiment.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• workspace_name (str) – 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) – 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 (JobsListByExperimentOptions) – Parameter group.

Keyword Arguments

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[JobListResult]

Raises

~azure.core.exceptions.HttpResponseError

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’]

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

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• workspace_name (str) – 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) – 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) – 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 (JobsListOutputFilesOptions) – Parameter group.

Keyword Arguments

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[FileListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_remote_login_information(resource_group_name: str, workspace_name: str, experiment_name: str, job_name: str, **kwargs: Any) → Iterable[‘_models.RemoteLoginInformationListResult’]

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

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• workspace_name (str) – 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) – 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) – 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.

Keyword Arguments

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[RemoteLoginInformationListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.batchai.models' from '/mnt/vss/_work/1/s/sdk/batchai/azure-mgmt-batchai/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/batchai/models/__init__.py'>

class azure.mgmt.batchai.operations.FileServersOperations(client, config, serializer, deserializer)

Bases: object

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

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

begin_create(resource_group_name: str, workspace_name: str, file_server_name: str, parameters: ‘_models.FileServerCreateParameters’, **kwargs: Any) → LROPoller[‘_models.FileServer’]

Creates a File Server in the given workspace.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• workspace_name (str) – 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.

• file_server_name (str) – The name of the file server within the specified resource group. File server 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 (FileServerCreateParameters) – The parameters to provide for File Server creation.

Keyword Arguments

• 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 FileServer or the result of cls(response)

Return type

LROPoller[FileServer]

Raises

HttpResponseError –

list_by_workspace(resource_group_name: str, workspace_name: str, file_servers_list_by_workspace_options: Optional[‘_models.FileServersListByWorkspaceOptions’] = None, **kwargs: Any) → Iterable[‘_models.FileServerListResult’]

Gets a list of File Servers associated with the specified workspace.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• workspace_name (str) – 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.

• file_servers_list_by_workspace_options (FileServersListByWorkspaceOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[FileServerListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.batchai.models' from '/mnt/vss/_work/1/s/sdk/batchai/azure-mgmt-batchai/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/batchai/models/__init__.py'>

class azure.mgmt.batchai.operations.ClustersOperations(client, config, serializer, deserializer)

Bases: object

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

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

begin_create(resource_group_name: str, workspace_name: str, cluster_name: str, parameters: ‘_models.ClusterCreateParameters’, **kwargs: Any) → LROPoller[‘_models.Cluster’]

Creates a Cluster in the given Workspace.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• workspace_name (str) – 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.

• cluster_name (str) – The name of the cluster within the specified resource group. Cluster 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 (ClusterCreateParameters) – The parameters to provide for the Cluster creation.

Keyword Arguments

• 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 Cluster or the result of cls(response)

Return type

LROPoller[Cluster]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, workspace_name: str, cluster_name: str, **kwargs: Any) → LROPoller[None]

Deletes a Cluster.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• workspace_name (str) – 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.

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

Keyword Arguments

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

Raises

HttpResponseError –

get(resource_group_name: str, workspace_name: str, cluster_name: str, **kwargs: Any) → ’_models.Cluster’

Gets information about a Cluster.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• workspace_name (str) – 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.

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Cluster, or the result of cls(response)

Return type

Cluster

Raises

~azure.core.exceptions.HttpResponseError

list_by_workspace(resource_group_name: str, workspace_name: str, clusters_list_by_workspace_options: Optional[‘_models.ClustersListByWorkspaceOptions’] = None, **kwargs: Any) → Iterable[‘_models.ClusterListResult’]

Gets information about Clusters associated with the given Workspace.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• workspace_name (str) – 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.

• clusters_list_by_workspace_options (ClustersListByWorkspaceOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ClusterListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_remote_login_information(resource_group_name: str, workspace_name: str, cluster_name: str, **kwargs: Any) → Iterable[‘_models.RemoteLoginInformationListResult’]

Get the IP address, port of all the compute nodes in the Cluster.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• workspace_name (str) – 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.

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

Keyword Arguments

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[RemoteLoginInformationListResult]

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, workspace_name: str, cluster_name: str, parameters: ‘_models.ClusterUpdateParameters’, **kwargs: Any) → ’_models.Cluster’

Updates properties of a Cluster.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• workspace_name (str) – 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.

• cluster_name (str) – The name of the cluster within the specified resource group. Cluster 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 (ClusterUpdateParameters) – Additional parameters for cluster update.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Cluster, or the result of cls(response)

Return type

Cluster

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.batchai.models' from '/mnt/vss/_work/1/s/sdk/batchai/azure-mgmt-batchai/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/batchai/models/__init__.py'>