Package com.azure.resourcemanager.machinelearning.models

Interface Workspaces

public interface Workspaces
Resource collection API of Workspaces.

  • Method Details

    • getByResourceGroupWithResponse

      com.azure.core.http.rest.Response<Workspace> getByResourceGroupWithResponse(String resourceGroupName, String workspaceName, com.azure.core.util.Context context)
      Gets the properties of the specified machine learning workspace.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - Name of Azure Machine Learning workspace.
      context - The context to associate with this operation.
      Returns:
      the properties of the specified machine learning workspace 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.

    • getByResourceGroup

      Workspace getByResourceGroup(String resourceGroupName, String workspaceName)
      Gets the properties of the specified machine learning workspace.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - Name of Azure Machine Learning workspace.
      Returns:
      the properties of the specified machine learning workspace.
      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)
      Deletes a machine learning workspace.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - Name of Azure Machine Learning workspace.
      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, Boolean forceToPurge, com.azure.core.util.Context context)
      Deletes a machine learning workspace.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - Name of Azure Machine Learning workspace.
      forceToPurge - Flag to indicate delete is a purge request.
      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.

    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<Workspace> listByResourceGroup(String resourceGroupName)
      Lists all the available machine learning workspaces under the specified resource group.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      Returns:
      the result of a request to list machine learning workspaces 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.

    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<Workspace> listByResourceGroup(String resourceGroupName, String skip, com.azure.core.util.Context context)
      Lists all the available machine learning workspaces under the specified resource group.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      skip - Continuation token for pagination.
      context - The context to associate with this operation.
      Returns:
      the result of a request to list machine learning workspaces 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.

    • diagnose

      DiagnoseResponseResult diagnose(String resourceGroupName, String workspaceName)
      Diagnose workspace setup issue.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - Name of Azure Machine Learning workspace.
      Returns:
      the 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.

    • diagnose

      DiagnoseResponseResult diagnose(String resourceGroupName, String workspaceName, DiagnoseWorkspaceParameters parameters, com.azure.core.util.Context context)
      Diagnose workspace setup issue.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - Name of Azure Machine Learning workspace.
      parameters - The parameter of diagnosing workspace health.
      context - The context to associate with this operation.
      Returns:
      the 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.

    • listKeysWithResponse

      com.azure.core.http.rest.Response<ListWorkspaceKeysResult> listKeysWithResponse(String resourceGroupName, String workspaceName, com.azure.core.util.Context context)
      Lists all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - Name of Azure Machine Learning workspace.
      context - The context to associate with this operation.
      Returns:
      the response body 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

      ListWorkspaceKeysResult listKeys(String resourceGroupName, String workspaceName)
      Lists all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - Name of Azure Machine Learning workspace.
      Returns:
      the 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.

    • resyncKeys

      void resyncKeys(String resourceGroupName, String workspaceName)
      Resync all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - Name of Azure Machine Learning workspace.
      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.

    • resyncKeys

      void resyncKeys(String resourceGroupName, String workspaceName, com.azure.core.util.Context context)
      Resync all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - Name of Azure Machine Learning workspace.
      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.

    • list

      com.azure.core.http.rest.PagedIterable<Workspace> list()
      Lists all the available machine learning workspaces under the specified subscription.
      Returns:
      the result of a request to list machine learning workspaces as paginated response with PagedIterable.
      Throws:
      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<Workspace> list(String skip, com.azure.core.util.Context context)
      Lists all the available machine learning workspaces under the specified subscription.
      Parameters:
      skip - Continuation token for pagination.
      context - The context to associate with this operation.
      Returns:
      the result of a request to list machine learning workspaces 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.

    • listNotebookAccessTokenWithResponse

      com.azure.core.http.rest.Response<NotebookAccessTokenResult> listNotebookAccessTokenWithResponse(String resourceGroupName, String workspaceName, com.azure.core.util.Context context)
      return notebook access token and refresh token.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - Name of Azure Machine Learning workspace.
      context - The context to associate with this operation.
      Returns:
      the response body 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.

    • listNotebookAccessToken

      NotebookAccessTokenResult listNotebookAccessToken(String resourceGroupName, String workspaceName)
      return notebook access token and refresh token.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - Name of Azure Machine Learning workspace.
      Returns:
      the 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.

    • prepareNotebook

      NotebookResourceInfo prepareNotebook(String resourceGroupName, String workspaceName)
      Prepare a notebook.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - Name of Azure Machine Learning workspace.
      Returns:
      the 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.

    • prepareNotebook

      NotebookResourceInfo prepareNotebook(String resourceGroupName, String workspaceName, com.azure.core.util.Context context)
      Prepare a notebook.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - Name of Azure Machine Learning workspace.
      context - The context to associate with this operation.
      Returns:
      the 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.

    • listStorageAccountKeysWithResponse

      com.azure.core.http.rest.Response<ListStorageAccountKeysResult> listStorageAccountKeysWithResponse(String resourceGroupName, String workspaceName, com.azure.core.util.Context context)
      List storage account keys of a workspace.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - Name of Azure Machine Learning workspace.
      context - The context to associate with this operation.
      Returns:
      the response body 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.

    • listStorageAccountKeys

      ListStorageAccountKeysResult listStorageAccountKeys(String resourceGroupName, String workspaceName)
      List storage account keys of a workspace.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - Name of Azure Machine Learning workspace.
      Returns:
      the 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.

    • listNotebookKeysWithResponse

      com.azure.core.http.rest.Response<ListNotebookKeysResult> listNotebookKeysWithResponse(String resourceGroupName, String workspaceName, com.azure.core.util.Context context)
      List keys of a notebook.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - Name of Azure Machine Learning workspace.
      context - The context to associate with this operation.
      Returns:
      the response body 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.

    • listNotebookKeys

      ListNotebookKeysResult listNotebookKeys(String resourceGroupName, String workspaceName)
      List keys of a notebook.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - Name of Azure Machine Learning workspace.
      Returns:
      the 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.

    • listOutboundNetworkDependenciesEndpointsWithResponse

      com.azure.core.http.rest.Response<ExternalFqdnResponse> listOutboundNetworkDependenciesEndpointsWithResponse(String resourceGroupName, String workspaceName, com.azure.core.util.Context context)
      Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - Name of Azure Machine Learning workspace.
      context - The context to associate with this operation.
      Returns:
      the response body 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.

    • listOutboundNetworkDependenciesEndpoints

      ExternalFqdnResponse listOutboundNetworkDependenciesEndpoints(String resourceGroupName, String workspaceName)
      Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - Name of Azure Machine Learning workspace.
      Returns:
      the 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.

    • getById

      Workspace getById(String id)
      Gets the properties of the specified machine learning workspace.
      Parameters:
      id - the resource ID.
      Returns:
      the properties of the specified machine learning workspace 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<Workspace> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Gets the properties of the specified machine learning workspace.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      the properties of the specified machine learning workspace 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.

    • deleteById

      void deleteById(String id)
      Deletes a machine learning workspace.
      Parameters:
      id - the resource ID.
      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.

    • deleteByIdWithResponse

      void deleteByIdWithResponse(String id, Boolean forceToPurge, com.azure.core.util.Context context)
      Deletes a machine learning workspace.
      Parameters:
      id - the resource ID.
      forceToPurge - Flag to indicate delete is a purge request.
      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.

    • define

      Workspace.DefinitionStages.Blank define(String name)
      Begins definition for a new Workspace resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new Workspace definition.