ClustersOperations Class

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.

Inheritance

builtins.object

ClustersOperations

Constructor

ClustersOperations(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 Cluster in the given Workspace.
begin_delete	Deletes a Cluster.
get	Gets information about a Cluster.
list_by_workspace	Gets information about Clusters associated with the given Workspace.
list_remote_login_information	Get the IP address, port of all the compute nodes in the Cluster.
update	Updates properties of a Cluster.

begin_create

Creates a Cluster in the given Workspace.

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

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.

cluster_name

str

Required

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

<xref:batch_ai.models.ClusterCreateParameters>

Required

The parameters to provide for the Cluster 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 Cluster or the result of cls(response)

Return type

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

Exceptions

HttpResponseError

begin_delete

Deletes a Cluster.

begin_delete(resource_group_name: str, workspace_name: str, cluster_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.

cluster_name

str

Required

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.

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

get(resource_group_name: str, workspace_name: str, cluster_name: str, **kwargs: Any) -> _models.Cluster

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.

cluster_name

str

Required

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.

cls

callable

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

Returns

Cluster, or the result of cls(response)

Return type

<xref:batch_ai.models.Cluster>

Exceptions

HttpResponseError

list_by_workspace

Gets information about Clusters associated with the given Workspace.

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

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.

clusters_list_by_workspace_options

<xref:batch_ai.models.ClustersListByWorkspaceOptions>

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

Return type

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

Exceptions

HttpResponseError

list_remote_login_information

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

list_remote_login_information(resource_group_name: str, workspace_name: str, cluster_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.

cluster_name

str

Required

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.

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

update

Updates properties of a Cluster.

update(resource_group_name: str, workspace_name: str, cluster_name: str, parameters: _models.ClusterUpdateParameters, **kwargs: Any) -> _models.Cluster

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.

cluster_name

str

Required

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

<xref:batch_ai.models.ClusterUpdateParameters>

Required

Additional parameters for cluster update.

cls

callable

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

Returns

Cluster, or the result of cls(response)

Return type

<xref:batch_ai.models.Cluster>

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'>