WorkspaceConnectionsOperations Class

WorkspaceConnectionsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

WorkspaceConnectionsOperations

Constructor

WorkspaceConnectionsOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

create	Add a new workspace connection.
delete	Delete a workspace connection.
get	Get the detail of a workspace connection.
list	List all connections under a AML workspace.

create

Add a new workspace connection.

create(resource_group_name: str, workspace_name: str, connection_name: str, parameters: _models.WorkspaceConnectionDto, **kwargs: Any) -> _models.WorkspaceConnection

Parameters

resource_group_name

str

Required

Name of the resource group in which workspace is located.

workspace_name

str

Required

Name of Azure Machine Learning workspace.

connection_name

str

Required

Friendly name of the workspace connection.

parameters

WorkspaceConnectionDto

Required

The object for creating or updating a new workspace connection.

cls

callable

A custom type or function that will be passed the direct response

Returns

WorkspaceConnection, or the result of cls(response)

Return type

WorkspaceConnection

Exceptions

HttpResponseError

delete

Delete a workspace connection.

delete(resource_group_name: str, workspace_name: str, connection_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group in which workspace is located.

workspace_name

str

Required

Name of Azure Machine Learning workspace.

connection_name

str

Required

Friendly name of the workspace connection.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

get

Get the detail of a workspace connection.

get(resource_group_name: str, workspace_name: str, connection_name: str, **kwargs: Any) -> _models.WorkspaceConnection

Parameters

resource_group_name

str

Required

Name of the resource group in which workspace is located.

workspace_name

str

Required

Name of Azure Machine Learning workspace.

connection_name

str

Required

Friendly name of the workspace connection.

cls

callable

A custom type or function that will be passed the direct response

Returns

WorkspaceConnection, or the result of cls(response)

Return type

WorkspaceConnection

Exceptions

HttpResponseError

list

List all connections under a AML workspace.

list(resource_group_name: str, workspace_name: str, target: Optional[str] = None, category: Optional[str] = None, **kwargs: Any) -> Iterable[_models.PaginatedWorkspaceConnectionsList]

Parameters

resource_group_name

str

Required

Name of the resource group in which workspace is located.

workspace_name

str

Required

Name of Azure Machine Learning workspace.

target

str

default value: None

Target of the workspace connection.

category

str

default value: None

Category of the workspace connection.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PaginatedWorkspaceConnectionsList or the result of cls(response)

Return type

ItemPaged[PaginatedWorkspaceConnectionsList]

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.machinelearningservices.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\machinelearningservices\\models\\__init__.py'>