ComputesClient Interface

Package:
com.azure.resourcemanager.machinelearning.fluent
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-machinelearning:1.1.0

public interface ComputesClient

An instance of this class provides access to all the operations defined in ComputesClient.

Method Summary

Modifier and Type Method and Description
abstract SyncPoller<PollResult<ComputeResourceInner>,ComputeResourceInner> beginCreateOrUpdate(String resourceGroupName, String workspaceName, String computeName, ComputeResourceInner parameters)

Creates or updates compute.
abstract SyncPoller<PollResult<ComputeResourceInner>,ComputeResourceInner> beginCreateOrUpdate(String resourceGroupName, String workspaceName, String computeName, ComputeResourceInner parameters, Context context)

Creates or updates compute.
abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String workspaceName, String computeName, UnderlyingResourceAction underlyingResourceAction)

Deletes specified Machine Learning compute.
abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String workspaceName, String computeName, UnderlyingResourceAction underlyingResourceAction, Context context)

Deletes specified Machine Learning compute.
abstract SyncPoller<PollResult<Void>,Void> beginRestart(String resourceGroupName, String workspaceName, String computeName)

Posts a restart action to a compute instance.
abstract SyncPoller<PollResult<Void>,Void> beginRestart(String resourceGroupName, String workspaceName, String computeName, Context context)

Posts a restart action to a compute instance.
abstract SyncPoller<PollResult<Void>,Void> beginStart(String resourceGroupName, String workspaceName, String computeName)

Posts a start action to a compute instance.
abstract SyncPoller<PollResult<Void>,Void> beginStart(String resourceGroupName, String workspaceName, String computeName, Context context)

Posts a start action to a compute instance.
abstract SyncPoller<PollResult<Void>,Void> beginStop(String resourceGroupName, String workspaceName, String computeName)

Posts a stop action to a compute instance.
abstract SyncPoller<PollResult<Void>,Void> beginStop(String resourceGroupName, String workspaceName, String computeName, Context context)

Posts a stop action to a compute instance.
abstract SyncPoller<PollResult<ComputeResourceInner>,ComputeResourceInner> beginUpdate(String resourceGroupName, String workspaceName, String computeName, ClusterUpdateParameters parameters)

Updates properties of a compute.
abstract SyncPoller<PollResult<ComputeResourceInner>,ComputeResourceInner> beginUpdate(String resourceGroupName, String workspaceName, String computeName, ClusterUpdateParameters parameters, Context context)

Updates properties of a compute.
abstract ComputeResourceInner createOrUpdate(String resourceGroupName, String workspaceName, String computeName, ComputeResourceInner parameters)

Creates or updates compute.
abstract ComputeResourceInner createOrUpdate(String resourceGroupName, String workspaceName, String computeName, ComputeResourceInner parameters, Context context)

Creates or updates compute.
abstract void delete(String resourceGroupName, String workspaceName, String computeName, UnderlyingResourceAction underlyingResourceAction)

Deletes specified Machine Learning compute.
abstract void delete(String resourceGroupName, String workspaceName, String computeName, UnderlyingResourceAction underlyingResourceAction, Context context)

Deletes specified Machine Learning compute.
abstract ComputeResourceInner get(String resourceGroupName, String workspaceName, String computeName)

Gets compute definition by its name.
abstract Response<ComputeResourceInner> getWithResponse(String resourceGroupName, String workspaceName, String computeName, Context context)

Gets compute definition by its name.
abstract PagedIterable<ComputeResourceInner> list(String resourceGroupName, String workspaceName)

Gets computes in specified workspace.
abstract PagedIterable<ComputeResourceInner> list(String resourceGroupName, String workspaceName, String skip, Context context)

Gets computes in specified workspace.
abstract ComputeSecretsInner listKeys(String resourceGroupName, String workspaceName, String computeName)

Gets secrets related to Machine Learning compute (storage keys, service credentials, etc).
abstract Response<ComputeSecretsInner> listKeysWithResponse(String resourceGroupName, String workspaceName, String computeName, Context context)

Gets secrets related to Machine Learning compute (storage keys, service credentials, etc).
abstract PagedIterable<AmlComputeNodeInformation> listNodes(String resourceGroupName, String workspaceName, String computeName)

Get the details (e.g IP address, port etc) of all the compute nodes in the compute.
abstract PagedIterable<AmlComputeNodeInformation> listNodes(String resourceGroupName, String workspaceName, String computeName, Context context)

Get the details (e.g IP address, port etc) of all the compute nodes in the compute.
abstract void restart(String resourceGroupName, String workspaceName, String computeName)

Posts a restart action to a compute instance.
abstract void restart(String resourceGroupName, String workspaceName, String computeName, Context context)

Posts a restart action to a compute instance.
abstract void start(String resourceGroupName, String workspaceName, String computeName)

Posts a start action to a compute instance.
abstract void start(String resourceGroupName, String workspaceName, String computeName, Context context)

Posts a start action to a compute instance.
abstract void stop(String resourceGroupName, String workspaceName, String computeName)

Posts a stop action to a compute instance.
abstract void stop(String resourceGroupName, String workspaceName, String computeName, Context context)

Posts a stop action to a compute instance.
abstract ComputeResourceInner update(String resourceGroupName, String workspaceName, String computeName, ClusterUpdateParameters parameters)

Updates properties of a compute.
abstract ComputeResourceInner update(String resourceGroupName, String workspaceName, String computeName, ClusterUpdateParameters parameters, Context context)

Updates properties of a compute.

Method Details

beginCreateOrUpdate

public abstract SyncPoller<PollResult<ComputeResourceInner>,ComputeResourceInner> beginCreateOrUpdate(String resourceGroupName, String workspaceName, String computeName, ComputeResourceInner parameters)

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.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
computeName - Name of the Azure Machine Learning compute.
parameters - Payload with Machine Learning compute definition.

Returns:

the SyncPoller<T,U> for polling of machine Learning compute object wrapped into ARM resource envelope.

beginCreateOrUpdate

public abstract SyncPoller<PollResult<ComputeResourceInner>,ComputeResourceInner> beginCreateOrUpdate(String resourceGroupName, String workspaceName, String computeName, ComputeResourceInner parameters, Context context)

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.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
computeName - Name of the Azure Machine Learning compute.
parameters - Payload with Machine Learning compute definition.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of machine Learning compute object wrapped into ARM resource envelope.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String workspaceName, String computeName, UnderlyingResourceAction underlyingResourceAction)

Deletes specified Machine Learning compute.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
computeName - Name of the Azure Machine Learning compute.
underlyingResourceAction - Delete the underlying compute if 'Delete', or detach the underlying compute from workspace if 'Detach'.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String workspaceName, String computeName, UnderlyingResourceAction underlyingResourceAction, Context context)

Deletes specified Machine Learning compute.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
computeName - Name of the Azure Machine Learning compute.
underlyingResourceAction - Delete the underlying compute if 'Delete', or detach the underlying compute from workspace if 'Detach'.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginRestart

public abstract SyncPoller<PollResult<Void>,Void> beginRestart(String resourceGroupName, String workspaceName, String computeName)

Posts a restart action to a compute instance.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
computeName - Name of the Azure Machine Learning compute.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginRestart

public abstract SyncPoller<PollResult<Void>,Void> beginRestart(String resourceGroupName, String workspaceName, String computeName, Context context)

Posts a restart action to a compute instance.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
computeName - Name of the Azure Machine Learning compute.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginStart

public abstract SyncPoller<PollResult<Void>,Void> beginStart(String resourceGroupName, String workspaceName, String computeName)

Posts a start action to a compute instance.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
computeName - Name of the Azure Machine Learning compute.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginStart

public abstract SyncPoller<PollResult<Void>,Void> beginStart(String resourceGroupName, String workspaceName, String computeName, Context context)

Posts a start action to a compute instance.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
computeName - Name of the Azure Machine Learning compute.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginStop

public abstract SyncPoller<PollResult<Void>,Void> beginStop(String resourceGroupName, String workspaceName, String computeName)

Posts a stop action to a compute instance.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
computeName - Name of the Azure Machine Learning compute.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginStop

public abstract SyncPoller<PollResult<Void>,Void> beginStop(String resourceGroupName, String workspaceName, String computeName, Context context)

Posts a stop action to a compute instance.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
computeName - Name of the Azure Machine Learning compute.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginUpdate

public abstract SyncPoller<PollResult<ComputeResourceInner>,ComputeResourceInner> beginUpdate(String resourceGroupName, String workspaceName, String computeName, ClusterUpdateParameters parameters)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
computeName - Name of the Azure Machine Learning compute.
parameters - Additional parameters for cluster update.

Returns:

the SyncPoller<T,U> for polling of machine Learning compute object wrapped into ARM resource envelope.

beginUpdate

public abstract SyncPoller<PollResult<ComputeResourceInner>,ComputeResourceInner> beginUpdate(String resourceGroupName, String workspaceName, String computeName, ClusterUpdateParameters parameters, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
computeName - Name of the Azure Machine Learning compute.
parameters - Additional parameters for cluster update.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of machine Learning compute object wrapped into ARM resource envelope.

createOrUpdate

public abstract ComputeResourceInner createOrUpdate(String resourceGroupName, String workspaceName, String computeName, ComputeResourceInner parameters)

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.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
computeName - Name of the Azure Machine Learning compute.
parameters - Payload with Machine Learning compute definition.

Returns:

machine Learning compute object wrapped into ARM resource envelope.

createOrUpdate

public abstract ComputeResourceInner createOrUpdate(String resourceGroupName, String workspaceName, String computeName, ComputeResourceInner parameters, Context context)

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.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
computeName - Name of the Azure Machine Learning compute.
parameters - Payload with Machine Learning compute definition.
context - The context to associate with this operation.

Returns:

machine Learning compute object wrapped into ARM resource envelope.

delete

public abstract void delete(String resourceGroupName, String workspaceName, String computeName, UnderlyingResourceAction underlyingResourceAction)

Deletes specified Machine Learning compute.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
computeName - Name of the Azure Machine Learning compute.
underlyingResourceAction - Delete the underlying compute if 'Delete', or detach the underlying compute from workspace if 'Detach'.

delete

public abstract void delete(String resourceGroupName, String workspaceName, String computeName, UnderlyingResourceAction underlyingResourceAction, Context context)

Deletes specified Machine Learning compute.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
computeName - Name of the Azure Machine Learning compute.
underlyingResourceAction - Delete the underlying compute if 'Delete', or detach the underlying compute from workspace if 'Detach'.
context - The context to associate with this operation.

get

public abstract ComputeResourceInner get(String resourceGroupName, String workspaceName, String computeName)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
computeName - Name of the Azure Machine Learning compute.

Returns:

compute definition by its name.

getWithResponse

public abstract Response<ComputeResourceInner> getWithResponse(String resourceGroupName, String workspaceName, String computeName, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
computeName - Name of the Azure Machine Learning compute.
context - The context to associate with this operation.

Returns:

compute definition by its name along with Response<T>.

list

public abstract PagedIterable<ComputeResourceInner> list(String resourceGroupName, String workspaceName)

Gets computes in specified workspace.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.

Returns:

computes in specified workspace as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<ComputeResourceInner> list(String resourceGroupName, String workspaceName, String skip, Context context)

Gets computes in specified workspace.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
skip - Continuation token for pagination.
context - The context to associate with this operation.

Returns:

computes in specified workspace as paginated response with PagedIterable<T>.

listKeys

public abstract ComputeSecretsInner listKeys(String resourceGroupName, String workspaceName, String computeName)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
computeName - Name of the Azure Machine Learning compute.

Returns:

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

listKeysWithResponse

public abstract Response<ComputeSecretsInner> listKeysWithResponse(String resourceGroupName, String workspaceName, String computeName, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
computeName - Name of the Azure Machine Learning compute.
context - The context to associate with this operation.

Returns:

secrets related to Machine Learning compute (storage keys, service credentials, etc) along with Response<T>.

listNodes

public abstract PagedIterable<AmlComputeNodeInformation> listNodes(String resourceGroupName, String workspaceName, String computeName)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
computeName - Name of the Azure Machine Learning compute.

Returns:

the details (e.g IP address, port etc) of all the compute nodes in the compute as paginated response with PagedIterable<T>.

listNodes

public abstract PagedIterable<AmlComputeNodeInformation> listNodes(String resourceGroupName, String workspaceName, String computeName, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
computeName - Name of the Azure Machine Learning compute.
context - The context to associate with this operation.

Returns:

the details (e.g IP address, port etc) of all the compute nodes in the compute as paginated response with PagedIterable<T>.

restart

public abstract void restart(String resourceGroupName, String workspaceName, String computeName)

Posts a restart action to a compute instance.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
computeName - Name of the Azure Machine Learning compute.

restart

public abstract void restart(String resourceGroupName, String workspaceName, String computeName, Context context)

Posts a restart action to a compute instance.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
computeName - Name of the Azure Machine Learning compute.
context - The context to associate with this operation.

start

public abstract void start(String resourceGroupName, String workspaceName, String computeName)

Posts a start action to a compute instance.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
computeName - Name of the Azure Machine Learning compute.

start

public abstract void start(String resourceGroupName, String workspaceName, String computeName, Context context)

Posts a start action to a compute instance.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
computeName - Name of the Azure Machine Learning compute.
context - The context to associate with this operation.

stop

public abstract void stop(String resourceGroupName, String workspaceName, String computeName)

Posts a stop action to a compute instance.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
computeName - Name of the Azure Machine Learning compute.

stop

public abstract void stop(String resourceGroupName, String workspaceName, String computeName, Context context)

Posts a stop action to a compute instance.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
computeName - Name of the Azure Machine Learning compute.
context - The context to associate with this operation.

update

public abstract ComputeResourceInner update(String resourceGroupName, String workspaceName, String computeName, ClusterUpdateParameters parameters)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
computeName - Name of the Azure Machine Learning compute.
parameters - Additional parameters for cluster update.

Returns:

machine Learning compute object wrapped into ARM resource envelope.

update

public abstract ComputeResourceInner update(String resourceGroupName, String workspaceName, String computeName, ClusterUpdateParameters parameters, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
computeName - Name of the Azure Machine Learning compute.
parameters - Additional parameters for cluster update.
context - The context to associate with this operation.

Returns:

machine Learning compute object wrapped into ARM resource envelope.

Applies to