WorkspaceConnections Interface

public interface WorkspaceConnections

Resource collection API of WorkspaceConnections.

Method Summary

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

Begins definition for a new WorkspaceConnection resource.

abstract void delete(String resourceGroupName, String workspaceName, String connectionName)

Delete a workspace connection.

abstract void deleteById(String id)

Delete a workspace connection.

abstract Response<Void> deleteByIdWithResponse(String id, Context context)

Delete a workspace connection.

abstract Response<Void> deleteWithResponse(String resourceGroupName, String workspaceName, String connectionName, Context context)

Delete a workspace connection.

abstract WorkspaceConnection get(String resourceGroupName, String workspaceName, String connectionName)

Get the detail of a workspace connection.

abstract WorkspaceConnection getById(String id)

Get the detail of a workspace connection.

abstract Response<WorkspaceConnection> getByIdWithResponse(String id, Context context)

Get the detail of a workspace connection.

abstract Response<WorkspaceConnection> getWithResponse(String resourceGroupName, String workspaceName, String connectionName, Context context)

Get the detail of a workspace connection.

abstract PagedIterable<WorkspaceConnection> list(String resourceGroupName, String workspaceName)

List all connections under a AML workspace.

abstract PagedIterable<WorkspaceConnection> list(String resourceGroupName, String workspaceName, String target, String category, Context context)

List all connections under a AML workspace.

Method Details

define

public abstract WorkspaceConnection.DefinitionStages.Blank define(String name)

Begins definition for a new WorkspaceConnection resource.

Parameters:

name - resource name.

Returns:

the first stage of the new WorkspaceConnection definition.

delete

public abstract void delete(String resourceGroupName, String workspaceName, String connectionName)

Delete a workspace connection.

Parameters:

resourceGroupName - Name of the resource group in which workspace is located.
workspaceName - Name of Azure Machine Learning workspace.
connectionName - Friendly name of the workspace connection.

deleteById

public abstract void deleteById(String id)

Delete a workspace connection.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract Response deleteByIdWithResponse(String id, Context context)

Delete a workspace connection.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

Returns:

the response.

deleteWithResponse

public abstract Response deleteWithResponse(String resourceGroupName, String workspaceName, String connectionName, Context context)

Delete a workspace connection.

Parameters:

resourceGroupName - Name of the resource group in which workspace is located.
workspaceName - Name of Azure Machine Learning workspace.
connectionName - Friendly name of the workspace connection.
context - The context to associate with this operation.

Returns:

the response.

get

public abstract WorkspaceConnection get(String resourceGroupName, String workspaceName, String connectionName)

Get the detail of a workspace connection.

Parameters:

resourceGroupName - Name of the resource group in which workspace is located.
workspaceName - Name of Azure Machine Learning workspace.
connectionName - Friendly name of the workspace connection.

Returns:

the detail of a workspace connection.

getById

public abstract WorkspaceConnection getById(String id)

Get the detail of a workspace connection.

Parameters:

id - the resource ID.

Returns:

the detail of a workspace connection.

getByIdWithResponse

public abstract Response getByIdWithResponse(String id, Context context)

Get the detail of a workspace connection.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

Returns:

the detail of a workspace connection.

getWithResponse

public abstract Response getWithResponse(String resourceGroupName, String workspaceName, String connectionName, Context context)

Get the detail of a workspace connection.

Parameters:

resourceGroupName - Name of the resource group in which workspace is located.
workspaceName - Name of Azure Machine Learning workspace.
connectionName - Friendly name of the workspace connection.
context - The context to associate with this operation.

Returns:

the detail of a workspace connection.

list

public abstract PagedIterable list(String resourceGroupName, String workspaceName)

List all connections under a AML workspace.

Parameters:

resourceGroupName - Name of the resource group in which workspace is located.
workspaceName - Name of Azure Machine Learning workspace.

Returns:

paginated list of Workspace connection objects.

list

public abstract PagedIterable list(String resourceGroupName, String workspaceName, String target, String category, Context context)

List all connections under a AML workspace.

Parameters:

resourceGroupName - Name of the resource group in which workspace is located.
workspaceName - Name of Azure Machine Learning workspace.
target - Target of the workspace connection.
category - Category of the workspace connection.
context - The context to associate with this operation.

Returns:

paginated list of Workspace connection objects.

Applies to