Share via

WorkspaceConnections interface

  • Reference
Package:
@azure/arm-machinelearning

Interface representing a WorkspaceConnections.

Methods

create(string, string, string, WorkspaceConnectionPropertiesV2BasicResource, WorkspaceConnectionsCreateOptionalParams)
delete(string, string, string, WorkspaceConnectionsDeleteOptionalParams)
get(string, string, string, WorkspaceConnectionsGetOptionalParams)
list(string, string, WorkspaceConnectionsListOptionalParams)
listSecrets(string, string, string, WorkspaceConnectionsListSecretsOptionalParams)

List all the secrets of a machine learning workspaces connections.

Method Details

create(string, string, string, WorkspaceConnectionPropertiesV2BasicResource, WorkspaceConnectionsCreateOptionalParams) 

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

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
WorkspaceConnectionPropertiesV2BasicResource

The object for creating or updating a new workspace connection

options
WorkspaceConnectionsCreateOptionalParams

The options parameters.

Returns

Promise<WorkspaceConnectionPropertiesV2BasicResource>

delete(string, string, string, WorkspaceConnectionsDeleteOptionalParams) 

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) 

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

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

Promise<WorkspaceConnectionPropertiesV2BasicResource>

list(string, string, WorkspaceConnectionsListOptionalParams) 

function list(resourceGroupName: string, workspaceName: string, options?: WorkspaceConnectionsListOptionalParams): PagedAsyncIterableIterator<WorkspaceConnectionPropertiesV2BasicResource, WorkspaceConnectionPropertiesV2BasicResource[], 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

PagedAsyncIterableIterator<WorkspaceConnectionPropertiesV2BasicResource, WorkspaceConnectionPropertiesV2BasicResource[], PageSettings>

listSecrets(string, string, string, WorkspaceConnectionsListSecretsOptionalParams)

List all the secrets of a machine learning workspaces connections.

function listSecrets(resourceGroupName: string, workspaceName: string, connectionName: string, options?: WorkspaceConnectionsListSecretsOptionalParams): Promise<WorkspaceConnectionPropertiesV2BasicResource>

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
WorkspaceConnectionsListSecretsOptionalParams

The options parameters.

Returns

Promise<WorkspaceConnectionPropertiesV2BasicResource>