Interface ComputesClient


public interface ComputesClient
An instance of this class provides access to all the operations defined in ComputesClient.
  • Method Details

    • list

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

      com.azure.core.http.rest.Response<ComputeResourceInner> 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.
    • get

      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.
      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.
    • beginCreateOrUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.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 for polling of machine Learning compute object wrapped into ARM resource envelope.
      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.
    • beginCreateOrUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ComputeResourceInner>,ComputeResourceInner> beginCreateOrUpdate(String resourceGroupName, String workspaceName, String computeName, ComputeResourceInner parameters, com.azure.core.util.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 for polling of machine Learning compute object wrapped into ARM resource envelope.
      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.
    • createOrUpdate

      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.
      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.
    • createOrUpdate

      ComputeResourceInner createOrUpdate(String resourceGroupName, String workspaceName, String computeName, ComputeResourceInner parameters, com.azure.core.util.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.
      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.
    • beginUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.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 for polling of machine Learning compute object wrapped into ARM resource envelope.
      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.
    • beginUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ComputeResourceInner>,ComputeResourceInner> beginUpdate(String resourceGroupName, String workspaceName, String computeName, ClusterUpdateParameters parameters, com.azure.core.util.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 for polling of machine Learning compute object wrapped into ARM resource envelope.
      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.
    • update

      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.
      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.
    • update

      ComputeResourceInner update(String resourceGroupName, String workspaceName, String computeName, ClusterUpdateParameters parameters, com.azure.core.util.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.
      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.
    • beginDelete

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.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 for polling of long-running 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.
    • beginDelete

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(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.
      Returns:
      the SyncPoller for polling of long-running 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.
    • 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.
    • listKeysWithResponse

      com.azure.core.http.rest.Response<ComputeSecretsInner> 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.
    • listKeys

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

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.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 for polling of long-running 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.
    • beginStart

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginStart(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.
      Returns:
      the SyncPoller for polling of long-running 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.
    • 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.
    • beginStop

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.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 for polling of long-running 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.
    • beginStop

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginStop(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.
      Returns:
      the SyncPoller for polling of long-running 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.
    • beginRestart

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.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 for polling of long-running 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.
    • beginRestart

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginRestart(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.
      Returns:
      the SyncPoller for polling of long-running 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.