Workspaces Interface

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

public interface Workspaces

Resource collection API of Workspaces.

Method Summary

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

Begins definition for a new Workspace resource.
abstract void delete(String resourceGroupName, String workspaceName)

Deletes a machine learning workspace.
abstract void delete(String resourceGroupName, String workspaceName, Boolean forceToPurge, Context context)

Deletes a machine learning workspace.
abstract void deleteById(String id)

Deletes a machine learning workspace.
abstract void deleteByIdWithResponse(String id, Boolean forceToPurge, Context context)

Deletes a machine learning workspace.
abstract DiagnoseResponseResult diagnose(String resourceGroupName, String workspaceName)

Diagnose workspace setup issue.
abstract DiagnoseResponseResult diagnose(String resourceGroupName, String workspaceName, DiagnoseWorkspaceParameters parameters, Context context)

Diagnose workspace setup issue.
abstract Workspace getById(String id)

Gets the properties of the specified machine learning workspace.
abstract Response<Workspace> getByIdWithResponse(String id, Context context)

Gets the properties of the specified machine learning workspace.
abstract Workspace getByResourceGroup(String resourceGroupName, String workspaceName)

Gets the properties of the specified machine learning workspace.
abstract Response<Workspace> getByResourceGroupWithResponse(String resourceGroupName, String workspaceName, Context context)

Gets the properties of the specified machine learning workspace.
abstract PagedIterable<Workspace> list()

Lists all the available machine learning workspaces under the specified subscription.
abstract PagedIterable<Workspace> list(String skip, Context context)

Lists all the available machine learning workspaces under the specified subscription.
abstract PagedIterable<Workspace> listByResourceGroup(String resourceGroupName)

Lists all the available machine learning workspaces under the specified resource group.
abstract PagedIterable<Workspace> listByResourceGroup(String resourceGroupName, String skip, Context context)

Lists all the available machine learning workspaces under the specified resource group.
abstract ListWorkspaceKeysResult listKeys(String resourceGroupName, String workspaceName)

Lists all the keys associated with this workspace.
abstract Response<ListWorkspaceKeysResult> listKeysWithResponse(String resourceGroupName, String workspaceName, Context context)

Lists all the keys associated with this workspace.
abstract NotebookAccessTokenResult listNotebookAccessToken(String resourceGroupName, String workspaceName)

return notebook access token and refresh token.
abstract Response<NotebookAccessTokenResult> listNotebookAccessTokenWithResponse(String resourceGroupName, String workspaceName, Context context)

return notebook access token and refresh token.
abstract ListNotebookKeysResult listNotebookKeys(String resourceGroupName, String workspaceName)

List keys of a notebook.
abstract Response<ListNotebookKeysResult> listNotebookKeysWithResponse(String resourceGroupName, String workspaceName, Context context)

List keys of a notebook.
abstract ExternalFqdnResponse listOutboundNetworkDependenciesEndpoints(String resourceGroupName, String workspaceName)

Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically.
abstract Response<ExternalFqdnResponse> listOutboundNetworkDependenciesEndpointsWithResponse(String resourceGroupName, String workspaceName, Context context)

Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically.
abstract ListStorageAccountKeysResult listStorageAccountKeys(String resourceGroupName, String workspaceName)

List storage account keys of a workspace.
abstract Response<ListStorageAccountKeysResult> listStorageAccountKeysWithResponse(String resourceGroupName, String workspaceName, Context context)

List storage account keys of a workspace.
abstract NotebookResourceInfo prepareNotebook(String resourceGroupName, String workspaceName)

Prepare a notebook.
abstract NotebookResourceInfo prepareNotebook(String resourceGroupName, String workspaceName, Context context)

Prepare a notebook.
abstract void resyncKeys(String resourceGroupName, String workspaceName)

Resync all the keys associated with this workspace.
abstract void resyncKeys(String resourceGroupName, String workspaceName, Context context)

Resync all the keys associated with this workspace.

Method Details

define

public abstract 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.

delete

public abstract 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.

delete

public abstract void delete(String resourceGroupName, String workspaceName, Boolean forceToPurge, 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.

deleteById

public abstract void deleteById(String id)

Deletes a machine learning workspace.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Boolean forceToPurge, 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.

diagnose

public abstract 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.

diagnose

public abstract DiagnoseResponseResult diagnose(String resourceGroupName, String workspaceName, DiagnoseWorkspaceParameters parameters, 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.

getById

public abstract 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<T>.

getByIdWithResponse

public abstract Response<Workspace> getByIdWithResponse(String id, 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<T>.

getByResourceGroup

public abstract 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.

getByResourceGroupWithResponse

public abstract Response<Workspace> getByResourceGroupWithResponse(String resourceGroupName, String workspaceName, 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<T>.

list

public abstract 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<T>.

list

public abstract PagedIterable<Workspace> list(String skip, 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<T>.

listByResourceGroup

public abstract 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<T>.

listByResourceGroup

public abstract PagedIterable<Workspace> listByResourceGroup(String resourceGroupName, String skip, 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<T>.

listKeys

public abstract 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.

listKeysWithResponse

public abstract Response<ListWorkspaceKeysResult> listKeysWithResponse(String resourceGroupName, String workspaceName, 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<T>.

listNotebookAccessToken

public abstract 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.

listNotebookAccessTokenWithResponse

public abstract Response<NotebookAccessTokenResult> listNotebookAccessTokenWithResponse(String resourceGroupName, String workspaceName, 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<T>.

listNotebookKeys

public abstract 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.

listNotebookKeysWithResponse

public abstract Response<ListNotebookKeysResult> listNotebookKeysWithResponse(String resourceGroupName, String workspaceName, 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<T>.

listOutboundNetworkDependenciesEndpoints

public abstract 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.

listOutboundNetworkDependenciesEndpointsWithResponse

public abstract Response<ExternalFqdnResponse> listOutboundNetworkDependenciesEndpointsWithResponse(String resourceGroupName, String workspaceName, 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<T>.

listStorageAccountKeys

public abstract 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.

listStorageAccountKeysWithResponse

public abstract Response<ListStorageAccountKeysResult> listStorageAccountKeysWithResponse(String resourceGroupName, String workspaceName, 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<T>.

prepareNotebook

public abstract 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.

prepareNotebook

public abstract NotebookResourceInfo prepareNotebook(String resourceGroupName, String workspaceName, 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.

resyncKeys

public abstract 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.

resyncKeys

public abstract void resyncKeys(String resourceGroupName, String workspaceName, 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.

Applies to