MachineLearningComputeOperations Class

MachineLearningComputeOperations 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

MachineLearningComputeOperations

Constructor

MachineLearningComputeOperations(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_or_update	Creates or updates compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation. If your intent is to create a new compute, do a GET first to verify that it does not exist yet.
begin_delete	Deletes specified Machine Learning compute.
begin_update	Updates properties of a compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation.
get	Gets compute definition by its name. Any secrets (storage keys, service credentials, etc) are not returned - use 'keys' nested resource to get them.
list_by_workspace	Gets computes in specified workspace.
list_keys	Gets secrets related to Machine Learning compute (storage keys, service credentials, etc).
list_nodes	Get the details (e.g IP address, port etc) of all the compute nodes in the compute.
restart	Posts a restart action to a compute instance.
start	Posts a start action to a compute instance.
stop	Posts a stop action to a compute instance.

begin_create_or_update

Creates or updates compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation. If your intent is to create a new compute, do a GET first to verify that it does not exist yet.

begin_create_or_update(resource_group_name: str, workspace_name: str, compute_name: str, parameters: _models.ComputeResource, **kwargs: Any) -> LROPoller[_models.ComputeResource]

Parameters

resource_group_name

str

Required

Name of the resource group in which workspace is located.

workspace_name

str

Required

Name of Azure Machine Learning workspace.

compute_name

str

Required

Name of the Azure Machine Learning compute.

parameters

ComputeResource

Required

Payload with Machine Learning compute definition.

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

True for ARMPolling, False for no polling, or a polling object for 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 ComputeResource or the result of cls(response)

Return type

LROPoller[ComputeResource]

Exceptions

HttpResponseError

begin_delete

Deletes specified Machine Learning compute.

begin_delete(resource_group_name: str, workspace_name: str, compute_name: str, underlying_resource_action: Union[str, _models.UnderlyingResourceAction], **kwargs: Any) -> LROPoller[None]

Parameters

resource_group_name

str

Required

Name of the resource group in which workspace is located.

workspace_name

str

Required

Name of Azure Machine Learning workspace.

compute_name

str

Required

Name of the Azure Machine Learning compute.

underlying_resource_action

str or UnderlyingResourceAction

Required

Delete the underlying compute if 'Delete', or detach the underlying compute from workspace if 'Detach'.

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

True for ARMPolling, False for no polling, or a polling object for 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_update

Updates properties of a compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation.

begin_update(resource_group_name: str, workspace_name: str, compute_name: str, parameters: _models.ClusterUpdateParameters, **kwargs: Any) -> LROPoller[_models.ComputeResource]

Parameters

resource_group_name

str

Required

Name of the resource group in which workspace is located.

workspace_name

str

Required

Name of Azure Machine Learning workspace.

compute_name

str

Required

Name of the Azure Machine Learning compute.

parameters

ClusterUpdateParameters

Required

Additional parameters for cluster update.

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

True for ARMPolling, False for no polling, or a polling object for 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 ComputeResource or the result of cls(response)

Return type

LROPoller[ComputeResource]

Exceptions

HttpResponseError

get

Gets compute definition by its name. Any secrets (storage keys, service credentials, etc) are not returned - use 'keys' nested resource to get them.

get(resource_group_name: str, workspace_name: str, compute_name: str, **kwargs: Any) -> _models.ComputeResource

Parameters

resource_group_name

str

Required

Name of the resource group in which workspace is located.

workspace_name

str

Required

Name of Azure Machine Learning workspace.

compute_name

str

Required

Name of the Azure Machine Learning compute.

cls

callable

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

Returns

ComputeResource, or the result of cls(response)

Return type

ComputeResource

Exceptions

HttpResponseError

list_by_workspace

Gets computes in specified workspace.

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

Parameters

resource_group_name

str

Required

Name of the resource group in which workspace is located.

workspace_name

str

Required

Name of Azure Machine Learning workspace.

skiptoken

str

default value: None

Continuation token for pagination.

cls

callable

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

Returns

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

Return type

ItemPaged[PaginatedComputeResourcesList]

Exceptions

HttpResponseError

list_keys

Gets secrets related to Machine Learning compute (storage keys, service credentials, etc).

list_keys(resource_group_name: str, workspace_name: str, compute_name: str, **kwargs: Any) -> _models.ComputeSecrets

Parameters

resource_group_name

str

Required

Name of the resource group in which workspace is located.

workspace_name

str

Required

Name of Azure Machine Learning workspace.

compute_name

str

Required

Name of the Azure Machine Learning compute.

cls

callable

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

Returns

ComputeSecrets, or the result of cls(response)

Return type

ComputeSecrets

Exceptions

HttpResponseError

list_nodes

Get the details (e.g IP address, port etc) of all the compute nodes in the compute.

list_nodes(resource_group_name: str, workspace_name: str, compute_name: str, **kwargs: Any) -> _models.AmlComputeNodesInformation

Parameters

resource_group_name

str

Required

Name of the resource group in which workspace is located.

workspace_name

str

Required

Name of Azure Machine Learning workspace.

compute_name

str

Required

Name of the Azure Machine Learning compute.

cls

callable

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

Returns

AmlComputeNodesInformation, or the result of cls(response)

Return type

AmlComputeNodesInformation

Exceptions

HttpResponseError

restart

Posts a restart action to a compute instance.

restart(resource_group_name: str, workspace_name: str, compute_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group in which workspace is located.

workspace_name

str

Required

Name of Azure Machine Learning workspace.

compute_name

str

Required

Name of the Azure Machine Learning compute.

cls

callable

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

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

start

Posts a start action to a compute instance.

start(resource_group_name: str, workspace_name: str, compute_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group in which workspace is located.

workspace_name

str

Required

Name of Azure Machine Learning workspace.

compute_name

str

Required

Name of the Azure Machine Learning compute.

cls

callable

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

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

stop

Posts a stop action to a compute instance.

stop(resource_group_name: str, workspace_name: str, compute_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group in which workspace is located.

workspace_name

str

Required

Name of Azure Machine Learning workspace.

compute_name

str

Required

Name of the Azure Machine Learning compute.

cls

callable

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

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

Attributes

models

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