WorkspaceConnections | @azure/arm-machinelearning

Interface representing a WorkspaceConnections.

Hierarchy

WorkspaceConnections

Implemented by

WorkspaceConnectionsImpl

Index

Methods

create

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

- Defined in operationsInterfaces/workspaceConnections.ts:42
Add a new workspace connection.

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
- Optional options: WorkspaceConnectionsCreateOptionalParams
  
  The options parameters.
Returns Promise<WorkspaceConnectionsCreateResponse>

delete

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

- Defined in operationsInterfaces/workspaceConnections.ts:69
Delete a workspace connection.

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
- Optional options: WorkspaceConnectionsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

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

- Defined in operationsInterfaces/workspaceConnections.ts:56
Get the detail of a workspace connection.

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
- Optional options: WorkspaceConnectionsGetOptionalParams
  
  The options parameters.
Returns Promise<WorkspaceConnectionsGetResponse>

list

list(resourceGroupName: string, workspaceName: string, options?: WorkspaceConnectionsListOptionalParams): PagedAsyncIterableIterator<WorkspaceConnection>

- Defined in operationsInterfaces/workspaceConnections.ts:29
List all connections under a AML workspace.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  Name of Azure Machine Learning workspace.
- Optional options: WorkspaceConnectionsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<WorkspaceConnection>

Hierarchy

Implemented by

Index

Methods

Methods

create

Parameters

resourceGroupName: string

workspaceName: string

connectionName: string

parameters: WorkspaceConnection

Optional options: WorkspaceConnectionsCreateOptionalParams

Returns Promise<WorkspaceConnectionsCreateResponse>

delete

Parameters

resourceGroupName: string

workspaceName: string

connectionName: string

Optional options: WorkspaceConnectionsDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

workspaceName: string

connectionName: string

Optional options: WorkspaceConnectionsGetOptionalParams

Returns Promise<WorkspaceConnectionsGetResponse>

list

Parameters

resourceGroupName: string

workspaceName: string

Optional options: WorkspaceConnectionsListOptionalParams

Returns PagedAsyncIterableIterator<WorkspaceConnection>