WorkspacesClient Interface

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

public interface WorkspacesClient

An instance of this class provides access to all the operations defined in WorkspacesClient.

Method Summary

Modifier and Type Method and Description
abstract SyncPoller<PollResult<WorkspaceInner>,WorkspaceInner> beginCreateOrUpdate(String resourceGroupName, String workspaceName, WorkspaceInner parameters)

Creates or updates a workspace with the specified parameters.
abstract SyncPoller<PollResult<WorkspaceInner>,WorkspaceInner> beginCreateOrUpdate(String resourceGroupName, String workspaceName, WorkspaceInner parameters, Context context)

Creates or updates a workspace with the specified parameters.
abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String workspaceName)

Deletes a machine learning workspace.
abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String workspaceName, Boolean forceToPurge, Context context)

Deletes a machine learning workspace.
abstract SyncPoller<PollResult<DiagnoseResponseResultInner>,DiagnoseResponseResultInner> beginDiagnose(String resourceGroupName, String workspaceName)

Diagnose workspace setup issue.
abstract SyncPoller<PollResult<DiagnoseResponseResultInner>,DiagnoseResponseResultInner> beginDiagnose(String resourceGroupName, String workspaceName, DiagnoseWorkspaceParameters parameters, Context context)

Diagnose workspace setup issue.
abstract SyncPoller<PollResult<NotebookResourceInfoInner>,NotebookResourceInfoInner> beginPrepareNotebook(String resourceGroupName, String workspaceName)

Prepare a notebook.
abstract SyncPoller<PollResult<NotebookResourceInfoInner>,NotebookResourceInfoInner> beginPrepareNotebook(String resourceGroupName, String workspaceName, Context context)

Prepare a notebook.
abstract SyncPoller<PollResult<Void>,Void> beginResyncKeys(String resourceGroupName, String workspaceName)

Resync all the keys associated with this workspace.
abstract SyncPoller<PollResult<Void>,Void> beginResyncKeys(String resourceGroupName, String workspaceName, Context context)

Resync all the keys associated with this workspace.
abstract SyncPoller<PollResult<WorkspaceInner>,WorkspaceInner> beginUpdate(String resourceGroupName, String workspaceName, WorkspaceUpdateParameters parameters)

Updates a machine learning workspace with the specified parameters.
abstract SyncPoller<PollResult<WorkspaceInner>,WorkspaceInner> beginUpdate(String resourceGroupName, String workspaceName, WorkspaceUpdateParameters parameters, Context context)

Updates a machine learning workspace with the specified parameters.
abstract WorkspaceInner createOrUpdate(String resourceGroupName, String workspaceName, WorkspaceInner parameters)

Creates or updates a workspace with the specified parameters.
abstract WorkspaceInner createOrUpdate(String resourceGroupName, String workspaceName, WorkspaceInner parameters, Context context)

Creates or updates a workspace with the specified parameters.
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 DiagnoseResponseResultInner diagnose(String resourceGroupName, String workspaceName)

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

Diagnose workspace setup issue.
abstract WorkspaceInner getByResourceGroup(String resourceGroupName, String workspaceName)

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

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

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

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

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

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

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

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

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

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

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

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

Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically.
abstract Response<ExternalFqdnResponseInner> 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 ListStorageAccountKeysResultInner listStorageAccountKeys(String resourceGroupName, String workspaceName)

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

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

Prepare a notebook.
abstract NotebookResourceInfoInner 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.
abstract WorkspaceInner update(String resourceGroupName, String workspaceName, WorkspaceUpdateParameters parameters)

Updates a machine learning workspace with the specified parameters.
abstract WorkspaceInner update(String resourceGroupName, String workspaceName, WorkspaceUpdateParameters parameters, Context context)

Updates a machine learning workspace with the specified parameters.

Method Details

beginCreateOrUpdate

public abstract SyncPoller<PollResult<WorkspaceInner>,WorkspaceInner> beginCreateOrUpdate(String resourceGroupName, String workspaceName, WorkspaceInner parameters)

Creates or updates a workspace with the specified parameters.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
parameters - The parameters for creating or updating a machine learning workspace.

Returns:

the SyncPoller<T,U> for polling of an object that represents a machine learning workspace.

beginCreateOrUpdate

public abstract SyncPoller<PollResult<WorkspaceInner>,WorkspaceInner> beginCreateOrUpdate(String resourceGroupName, String workspaceName, WorkspaceInner parameters, Context context)

Creates or updates a workspace with the specified parameters.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
parameters - The parameters for creating or updating a machine learning workspace.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of an object that represents a machine learning workspace.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(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.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(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.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginDiagnose

public abstract SyncPoller<PollResult<DiagnoseResponseResultInner>,DiagnoseResponseResultInner> beginDiagnose(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 SyncPoller<T,U> for polling of long-running operation.

beginDiagnose

public abstract SyncPoller<PollResult<DiagnoseResponseResultInner>,DiagnoseResponseResultInner> beginDiagnose(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 SyncPoller<T,U> for polling of long-running operation.

beginPrepareNotebook

public abstract SyncPoller<PollResult<NotebookResourceInfoInner>,NotebookResourceInfoInner> beginPrepareNotebook(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 SyncPoller<T,U> for polling of long-running operation.

beginPrepareNotebook

public abstract SyncPoller<PollResult<NotebookResourceInfoInner>,NotebookResourceInfoInner> beginPrepareNotebook(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 SyncPoller<T,U> for polling of long-running operation.

beginResyncKeys

public abstract SyncPoller<PollResult<Void>,Void> beginResyncKeys(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.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginResyncKeys

public abstract SyncPoller<PollResult<Void>,Void> beginResyncKeys(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.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginUpdate

public abstract SyncPoller<PollResult<WorkspaceInner>,WorkspaceInner> beginUpdate(String resourceGroupName, String workspaceName, WorkspaceUpdateParameters parameters)

Updates a machine learning workspace with the specified parameters.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
parameters - The parameters for updating a machine learning workspace.

Returns:

the SyncPoller<T,U> for polling of an object that represents a machine learning workspace.

beginUpdate

public abstract SyncPoller<PollResult<WorkspaceInner>,WorkspaceInner> beginUpdate(String resourceGroupName, String workspaceName, WorkspaceUpdateParameters parameters, Context context)

Updates a machine learning workspace with the specified parameters.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
parameters - The parameters for updating a machine learning workspace.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of an object that represents a machine learning workspace.

createOrUpdate

public abstract WorkspaceInner createOrUpdate(String resourceGroupName, String workspaceName, WorkspaceInner parameters)

Creates or updates a workspace with the specified parameters.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
parameters - The parameters for creating or updating a machine learning workspace.

Returns:

an object that represents a machine learning workspace.

createOrUpdate

public abstract WorkspaceInner createOrUpdate(String resourceGroupName, String workspaceName, WorkspaceInner parameters, Context context)

Creates or updates a workspace with the specified parameters.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
parameters - The parameters for creating or updating a machine learning workspace.
context - The context to associate with this operation.

Returns:

an object that represents a machine learning workspace.

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.

diagnose

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

getByResourceGroup

public abstract WorkspaceInner 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<WorkspaceInner> 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<WorkspaceInner> 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<WorkspaceInner> 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<WorkspaceInner> 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<WorkspaceInner> 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 ListWorkspaceKeysResultInner 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<ListWorkspaceKeysResultInner> 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 NotebookAccessTokenResultInner 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<NotebookAccessTokenResultInner> 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 ListNotebookKeysResultInner 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<ListNotebookKeysResultInner> 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 ExternalFqdnResponseInner 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<ExternalFqdnResponseInner> 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 ListStorageAccountKeysResultInner 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<ListStorageAccountKeysResultInner> 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 NotebookResourceInfoInner 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 NotebookResourceInfoInner 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.

update

public abstract WorkspaceInner update(String resourceGroupName, String workspaceName, WorkspaceUpdateParameters parameters)

Updates a machine learning workspace with the specified parameters.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
parameters - The parameters for updating a machine learning workspace.

Returns:

an object that represents a machine learning workspace.

update

public abstract WorkspaceInner update(String resourceGroupName, String workspaceName, WorkspaceUpdateParameters parameters, Context context)

Updates a machine learning workspace with the specified parameters.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - Name of Azure Machine Learning workspace.
parameters - The parameters for updating a machine learning workspace.
context - The context to associate with this operation.

Returns:

an object that represents a machine learning workspace.

Applies to