Computes Interface

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

public interface Computes

Resource collection API of Computes.

Method Summary

Modifier and Type Method and Description
abstract Blank define(String name)

Begins definition for a new ComputeResource resource.
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 ComputeResource get(String resourceGroupName, String workspaceName, String computeName)

Gets compute definition by its name.
abstract ComputeResource getById(String id)

Gets compute definition by its name.
abstract Response<ComputeResource> getByIdWithResponse(String id, Context context)

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

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

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

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

Gets secrets related to Machine Learning compute (storage keys, service credentials, etc).
abstract Response<ComputeSecrets> 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.

Method Details

define

public abstract ComputeResource.DefinitionStages.Blank define(String name)

Begins definition for a new ComputeResource resource.

Parameters:

name - resource name.

Returns:

the first stage of the new ComputeResource definition.

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

getById

public abstract ComputeResource getById(String id)

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

Parameters:

id - the resource ID.

Returns:

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

getByIdWithResponse

public abstract Response<ComputeResource> getByIdWithResponse(String id, 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:

id - the resource ID.
context - The context to associate with this operation.

Returns:

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

getWithResponse

public abstract Response<ComputeResource> 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<ComputeResource> 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<ComputeResource> 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 ComputeSecrets 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<ComputeSecrets> 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.

Applies to