WorkspaceConnections interface

Interface representing a WorkspaceConnections.

Methods

create(string, string, string, WorkspaceConnection, WorkspaceConnectionsCreateOptionalParams)

Add a new workspace connection.

delete(string, string, string, WorkspaceConnectionsDeleteOptionalParams)

Delete a workspace connection.

get(string, string, string, WorkspaceConnectionsGetOptionalParams)

Get the detail of a workspace connection.

list(string, string, WorkspaceConnectionsListOptionalParams)

List all connections under a AML workspace.

Method Details

create(string, string, string, WorkspaceConnection, WorkspaceConnectionsCreateOptionalParams)

Add a new workspace connection.

function create(resourceGroupName: string, workspaceName: string, connectionName: string, parameters: WorkspaceConnection, options?: WorkspaceConnectionsCreateOptionalParams): Promise<WorkspaceConnection>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

Name of Azure Machine Learning workspace.

connectionName

string

Friendly name of the workspace connection

parameters
WorkspaceConnection

The object for creating or updating a new workspace connection

options
WorkspaceConnectionsCreateOptionalParams

The options parameters.

Returns

delete(string, string, string, WorkspaceConnectionsDeleteOptionalParams)

Delete a workspace connection.

function delete(resourceGroupName: string, workspaceName: string, connectionName: string, options?: WorkspaceConnectionsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

Name of Azure Machine Learning workspace.

connectionName

string

Friendly name of the workspace connection

options
WorkspaceConnectionsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, WorkspaceConnectionsGetOptionalParams)

Get the detail of a workspace connection.

function get(resourceGroupName: string, workspaceName: string, connectionName: string, options?: WorkspaceConnectionsGetOptionalParams): Promise<WorkspaceConnection>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

Name of Azure Machine Learning workspace.

connectionName

string

Friendly name of the workspace connection

options
WorkspaceConnectionsGetOptionalParams

The options parameters.

Returns

list(string, string, WorkspaceConnectionsListOptionalParams)

List all connections under a AML workspace.

function list(resourceGroupName: string, workspaceName: string, options?: WorkspaceConnectionsListOptionalParams): PagedAsyncIterableIterator<WorkspaceConnection, WorkspaceConnection[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

Name of Azure Machine Learning workspace.

options
WorkspaceConnectionsListOptionalParams

The options parameters.

Returns