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

workspace

Workspace

Required

The AzureML workspace in which the linked service exists.

name

str

Required

The name of the linked service.

type

str

Required

type of the linked service.

linked_service_resource_id

str

Required

arm resource id of the linked service.

system_assigned_identity_principal_id

str

Required

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

workspace

Workspace

Required

The AzureML workspace in which the linked service is to be fetched.

name

str

Required

A name of a linked service.

Returns

A linked service under the given workspace.

Return type

LinkedService

list

List the linked services under the given workspace.

static list(workspace)

Parameters

workspace

Workspace

Required

The AzureML workspace in which the linked service is to be listed.

Returns

A list of the linked services under the given workspace.

Return type

[LinkedService]

register

Register a linked service under the given workspace.

static register(workspace, name, linked_service_config)

Parameters

workspace

Workspace

Required

The AzureML workspace in which the linked service is to be registered.

name

str

Required

The name of the linked service.

linked_service_config

LinkedServiceConfiguration

Required

The configuration linked service.

Returns

A linked service under the given workspace.

Return type

LinkedService

unregister

Delink this linked service.

unregister()

Attributes

linked_service_resource_id

Return the linked service resource id.

Returns

The linked service resource id.

Return type

str

name

Return the linked service name.

Returns

The linked service name.

Return type

str

system_assigned_identity_principal_id

Return the linked service system assigned identity principal id.

Returns

The linked service system assigned identity principal id.

Return type

str

type

Return the linked service type, such as Synapse.

Returns

The linked service type.

Return type

str