Package com.azure.resourcemanager.machinelearning.models

Interface Computes

public interface Computes

Resource collection API of Computes.

Method Summary

Modifier and Type	Method	Description
ComputeResource.DefinitionStages.Blank	define(String name)	Begins definition for a new ComputeResource resource.
void	delete(String resourceGroupName, String workspaceName, String computeName, UnderlyingResourceAction underlyingResourceAction)	Deletes specified Machine Learning compute.
void	delete(String resourceGroupName, String workspaceName, String computeName, UnderlyingResourceAction underlyingResourceAction, com.azure.core.util.Context context)	Deletes specified Machine Learning compute.
ComputeResource	get(String resourceGroupName, String workspaceName, String computeName)	Gets compute definition by its name.
ComputeResource	getById(String id)	Gets compute definition by its name.
com.azure.core.http.rest.Response<ComputeResource>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Gets compute definition by its name.
com.azure.core.http.rest.Response<ComputeResource>	getWithResponse(String resourceGroupName, String workspaceName, String computeName, com.azure.core.util.Context context)	Gets compute definition by its name.
com.azure.core.http.rest.PagedIterable<ComputeResource>	list(String resourceGroupName, String workspaceName)	Gets computes in specified workspace.
com.azure.core.http.rest.PagedIterable<ComputeResource>	list(String resourceGroupName, String workspaceName, String skip, com.azure.core.util.Context context)	Gets computes in specified workspace.
ComputeSecrets	listKeys(String resourceGroupName, String workspaceName, String computeName)	Gets secrets related to Machine Learning compute (storage keys, service credentials, etc).
com.azure.core.http.rest.Response<ComputeSecrets>	listKeysWithResponse(String resourceGroupName, String workspaceName, String computeName, com.azure.core.util.Context context)	Gets secrets related to Machine Learning compute (storage keys, service credentials, etc).
com.azure.core.http.rest.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.
com.azure.core.http.rest.PagedIterable<AmlComputeNodeInformation>	listNodes(String resourceGroupName, String workspaceName, String computeName, com.azure.core.util.Context context)	Get the details (e.g IP address, port etc) of all the compute nodes in the compute.
void	restart(String resourceGroupName, String workspaceName, String computeName)	Posts a restart action to a compute instance.
void	restart(String resourceGroupName, String workspaceName, String computeName, com.azure.core.util.Context context)	Posts a restart action to a compute instance.
void	start(String resourceGroupName, String workspaceName, String computeName)	Posts a start action to a compute instance.
void	start(String resourceGroupName, String workspaceName, String computeName, com.azure.core.util.Context context)	Posts a start action to a compute instance.
void	stop(String resourceGroupName, String workspaceName, String computeName)	Posts a stop action to a compute instance.
void	stop(String resourceGroupName, String workspaceName, String computeName, com.azure.core.util.Context context)	Posts a stop action to a compute instance.

Method Detail

list

com.azure.core.http.rest.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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

list

com.azure.core.http.rest.PagedIterable<ComputeResource> list(String resourceGroupName,
                                                             String workspaceName,
                                                             String skip,
                                                             com.azure.core.util.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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

get

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getWithResponse

com.azure.core.http.rest.Response<ComputeResource> getWithResponse(String resourceGroupName,
                                                                   String workspaceName,
                                                                   String computeName,
                                                                   com.azure.core.util.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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

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

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

void delete(String resourceGroupName,
            String workspaceName,
            String computeName,
            UnderlyingResourceAction underlyingResourceAction,
            com.azure.core.util.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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listNodes

com.azure.core.http.rest.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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listNodes

com.azure.core.http.rest.PagedIterable<AmlComputeNodeInformation> listNodes(String resourceGroupName,
                                                                            String workspaceName,
                                                                            String computeName,
                                                                            com.azure.core.util.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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listKeys

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

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listKeysWithResponse

com.azure.core.http.rest.Response<ComputeSecrets> listKeysWithResponse(String resourceGroupName,
                                                                       String workspaceName,
                                                                       String computeName,
                                                                       com.azure.core.util.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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

start

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

start

void start(String resourceGroupName,
           String workspaceName,
           String computeName,
           com.azure.core.util.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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

stop

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

stop

void stop(String resourceGroupName,
          String workspaceName,
          String computeName,
          com.azure.core.util.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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

restart

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

restart

void restart(String resourceGroupName,
             String workspaceName,
             String computeName,
             com.azure.core.util.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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getById

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByIdWithResponse

com.azure.core.http.rest.Response<ComputeResource> getByIdWithResponse(String id,
                                                                       com.azure.core.util.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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

define

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.