LinkedService Class

Note

This is an experimental class, and may change at any time. Please see https://aka.ms/azuremlexperimental for more information.

Defines an Resource for managing linking between AML workspace with other services on Azure.

Initialize LinkedService object.

Inheritance

builtins.object

LinkedService

Constructor

LinkedService(workspace, name, type, linked_service_resource_id, system_assigned_identity_principal_id)

Parameters

Name	Description
workspace Required	Workspace The AzureML workspace in which the linked service exists.
name Required	str The name of the linked service.
type Required	str type of the linked service.
linked_service_resource_id Required	str arm resource id of the linked service.
system_assigned_identity_principal_id Required	str system assigned identity principal id of the linked service.

Methods

get	Get the linked service under the given workspace based on link name.
list	List the linked services under the given workspace.
register	Register a linked service under the given workspace.
unregister	Delink this linked service.

get

Get the linked service under the given workspace based on link name.

static get(workspace, name)

Parameters

Name	Description
workspace Required	Workspace The AzureML workspace in which the linked service is to be fetched.
name Required	str A name of a linked service.

Returns

Type	Description
LinkedService	A linked service under the given workspace.

list

List the linked services under the given workspace.

static list(workspace)

Parameters

Name	Description
workspace Required	Workspace The AzureML workspace in which the linked service is to be listed.

Returns

Type	Description
[LinkedService]	A list of the linked services under the given workspace.

register

Register a linked service under the given workspace.

static register(workspace, name, linked_service_config)

Parameters

Name	Description
workspace Required	Workspace The AzureML workspace in which the linked service is to be registered.
name Required	str The name of the linked service.
linked_service_config Required	LinkedServiceConfiguration The configuration linked service.

Returns

Type	Description
LinkedService	A linked service under the given workspace.

unregister

Delink this linked service.

unregister()

Attributes

linked_service_resource_id

Return the linked service resource id.

Returns

Type	Description
str	The linked service resource id.

name

Return the linked service name.

Returns

Type	Description
str	The linked service name.

system_assigned_identity_principal_id

Return the linked service system assigned identity principal id.

Returns

Type	Description
str	The linked service system assigned identity principal id.

type

Return the linked service type, such as Synapse.

Returns

Type	Description
str	The linked service type.