AzureMLServiceLinkedService Class

Package:

com.azure.analytics.synapse.artifacts.models

Maven Artifact:

com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.14

• java.lang.Object
• • com.azure.analytics.synapse.artifacts.models.LinkedService
  • • com.azure.analytics.synapse.artifacts.models.AzureMLServiceLinkedService

public class AzureMLServiceLinkedService
extends LinkedService

Azure ML Service linked service.

Constructor Summary

Constructor	Description
AzureMLServiceLinkedService()	Creates an instance of AzureMLServiceLinkedService class.

Method Summary

Modifier and Type	Method and Description
Object	getAuthentication() Get the authentication property: Type of authentication (Required to specify MSI) used to connect to AzureML.
Object	getEncryptedCredential() Get the encryptedCredential property: The encrypted credential used for authentication.
Object	getMlWorkspaceName() Get the mlWorkspaceName property: Azure ML Service workspace name.
Object	getResourceGroupName() Get the resourceGroupName property: Azure ML Service workspace resource group name.
Object	getServicePrincipalId() Get the servicePrincipalId property: The ID of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline.
SecretBase	getServicePrincipalKey() Get the servicePrincipalKey property: The key of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline.
Object	getSubscriptionId() Get the subscriptionId property: Azure ML Service workspace subscription ID.
Object	getTenant() Get the tenant property: The name or ID of the tenant to which the service principal belongs.
AzureMLServiceLinkedService	setAnnotations(List<Object> annotations) Set the annotations property: List of tags that can be used for describing the linked service.
AzureMLServiceLinkedService	setAuthentication(Object authentication) Set the authentication property: Type of authentication (Required to specify MSI) used to connect to AzureML.
AzureMLServiceLinkedService	setConnectVia(IntegrationRuntimeReference connectVia) Set the connectVia property: The integration runtime reference.
AzureMLServiceLinkedService	setDescription(String description) Set the description property: Linked service description.
AzureMLServiceLinkedService	setEncryptedCredential(Object encryptedCredential) Set the encryptedCredential property: The encrypted credential used for authentication.
AzureMLServiceLinkedService	setMlWorkspaceName(Object mlWorkspaceName) Set the mlWorkspaceName property: Azure ML Service workspace name.
AzureMLServiceLinkedService	setParameters(Map<String,ParameterSpecification> parameters) Set the parameters property: Parameters for linked service.
AzureMLServiceLinkedService	setResourceGroupName(Object resourceGroupName) Set the resourceGroupName property: Azure ML Service workspace resource group name.
AzureMLServiceLinkedService	setServicePrincipalId(Object servicePrincipalId) Set the servicePrincipalId property: The ID of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline.
AzureMLServiceLinkedService	setServicePrincipalKey(SecretBase servicePrincipalKey) Set the servicePrincipalKey property: The key of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline.
AzureMLServiceLinkedService	setSubscriptionId(Object subscriptionId) Set the subscriptionId property: Azure ML Service workspace subscription ID.
AzureMLServiceLinkedService	setTenant(Object tenant) Set the tenant property: The name or ID of the tenant to which the service principal belongs.

Methods inherited from LinkedService

getAdditionalProperties getAnnotations getConnectVia getDescription getParameters setAdditionalProperties setAnnotations setConnectVia setDescription setParameters

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AzureMLServiceLinkedService

public AzureMLServiceLinkedService()

Creates an instance of AzureMLServiceLinkedService class.

Method Details

getAuthentication

public Object getAuthentication()

Get the authentication property: Type of authentication (Required to specify MSI) used to connect to AzureML. Type: string (or Expression with resultType string).

Returns:

the authentication value.

getEncryptedCredential

public Object getEncryptedCredential()

Get the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Returns:

the encryptedCredential value.

getMlWorkspaceName

public Object getMlWorkspaceName()

Get the mlWorkspaceName property: Azure ML Service workspace name. Type: string (or Expression with resultType string).

Returns:

the mlWorkspaceName value.

getResourceGroupName

public Object getResourceGroupName()

Get the resourceGroupName property: Azure ML Service workspace resource group name. Type: string (or Expression with resultType string).

Returns:

the resourceGroupName value.

getServicePrincipalId

public Object getServicePrincipalId()

Get the servicePrincipalId property: The ID of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline. Type: string (or Expression with resultType string).

Returns:

the servicePrincipalId value.

getServicePrincipalKey

public SecretBase getServicePrincipalKey()

Get the servicePrincipalKey property: The key of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline.

Returns:

the servicePrincipalKey value.

getSubscriptionId

public Object getSubscriptionId()

Get the subscriptionId property: Azure ML Service workspace subscription ID. Type: string (or Expression with resultType string).

Returns:

the subscriptionId value.

getTenant

public Object getTenant()

Get the tenant property: The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

Returns:

the tenant value.

setAnnotations

public AzureMLServiceLinkedService setAnnotations(List

Set the annotations property: List of tags that can be used for describing the linked service.

Overrides:

AzureMLServiceLinkedService.setAnnotations(List<Object> annotations)

Parameters:

annotations

setAuthentication

public AzureMLServiceLinkedService setAuthentication(Object authentication)

Set the authentication property: Type of authentication (Required to specify MSI) used to connect to AzureML. Type: string (or Expression with resultType string).

Parameters:

authentication - the authentication value to set.

Returns:

the AzureMLServiceLinkedService object itself.

setConnectVia

public AzureMLServiceLinkedService setConnectVia(IntegrationRuntimeReference connectVia)

Set the connectVia property: The integration runtime reference.

Overrides:

AzureMLServiceLinkedService.setConnectVia(IntegrationRuntimeReference connectVia)

Parameters:

connectVia

setDescription

public AzureMLServiceLinkedService setDescription(String description)

Set the description property: Linked service description.

Overrides:

AzureMLServiceLinkedService.setDescription(String description)

Parameters:

description

setEncryptedCredential

public AzureMLServiceLinkedService setEncryptedCredential(Object encryptedCredential)

Set the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Parameters:

encryptedCredential - the encryptedCredential value to set.

Returns:

the AzureMLServiceLinkedService object itself.

setMlWorkspaceName

public AzureMLServiceLinkedService setMlWorkspaceName(Object mlWorkspaceName)

Set the mlWorkspaceName property: Azure ML Service workspace name. Type: string (or Expression with resultType string).

Parameters:

mlWorkspaceName - the mlWorkspaceName value to set.

Returns:

the AzureMLServiceLinkedService object itself.

setParameters

public AzureMLServiceLinkedService setParameters(Map parameters)

Set the parameters property: Parameters for linked service.

Overrides:

AzureMLServiceLinkedService.setParameters(Map<String,ParameterSpecification> parameters)

Parameters:

parameters

setResourceGroupName

public AzureMLServiceLinkedService setResourceGroupName(Object resourceGroupName)

Set the resourceGroupName property: Azure ML Service workspace resource group name. Type: string (or Expression with resultType string).

Parameters:

resourceGroupName - the resourceGroupName value to set.

Returns:

the AzureMLServiceLinkedService object itself.

setServicePrincipalId

public AzureMLServiceLinkedService setServicePrincipalId(Object servicePrincipalId)

Set the servicePrincipalId property: The ID of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline. Type: string (or Expression with resultType string).

Parameters:

servicePrincipalId - the servicePrincipalId value to set.

Returns:

the AzureMLServiceLinkedService object itself.

setServicePrincipalKey

public AzureMLServiceLinkedService setServicePrincipalKey(SecretBase servicePrincipalKey)

Set the servicePrincipalKey property: The key of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline.

Parameters:

servicePrincipalKey - the servicePrincipalKey value to set.

Returns:

the AzureMLServiceLinkedService object itself.

setSubscriptionId

public AzureMLServiceLinkedService setSubscriptionId(Object subscriptionId)

Set the subscriptionId property: Azure ML Service workspace subscription ID. Type: string (or Expression with resultType string).

Parameters:

subscriptionId - the subscriptionId value to set.

Returns:

the AzureMLServiceLinkedService object itself.

setTenant

public AzureMLServiceLinkedService setTenant(Object tenant)

Set the tenant property: The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

Parameters:

tenant - the tenant value to set.

Returns:

the AzureMLServiceLinkedService object itself.