Class AzureMLLinkedService

Azure ML Studio Web Service linked service.

Inheritance
System.Object
LinkedService
AzureMLLinkedService
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.Analytics.Synapse.Artifacts.dll
Syntax
[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.AzureMLLinkedService/AzureMLLinkedServiceConverter))]
public class AzureMLLinkedService : Azure.Analytics.Synapse.Artifacts.Models.LinkedService

Constructors

AzureMLLinkedService(Object, SecretBase)

Initializes a new instance of AzureMLLinkedService.

Declaration
public AzureMLLinkedService (object mlEndpoint, Azure.Analytics.Synapse.Artifacts.Models.SecretBase apiKey);
Parameters
System.Object mlEndpoint

The Batch Execution REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string).
SecretBase apiKey

The API key for accessing the Azure ML model endpoint. Please note SecretBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureKeyVaultSecretReference and SecureString.
Exceptions
System.ArgumentNullException

mlEndpoint or apiKey is null.

Properties

ApiKey

The API key for accessing the Azure ML model endpoint. Please note SecretBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureKeyVaultSecretReference and SecureString.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.SecretBase ApiKey { get; set; }
Property Value
SecretBase

Authentication

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

Declaration
public object Authentication { get; set; }
Property Value
System.Object

EncryptedCredential

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

Declaration
public object EncryptedCredential { get; set; }
Property Value
System.Object

MlEndpoint

The Batch Execution REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string).

Declaration
public object MlEndpoint { get; set; }
Property Value
System.Object

ServicePrincipalId

The ID of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service. Type: string (or Expression with resultType string).

Declaration
public object ServicePrincipalId { get; set; }
Property Value
System.Object

ServicePrincipalKey

The key of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service. Please note SecretBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureKeyVaultSecretReference and SecureString.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.SecretBase ServicePrincipalKey { get; set; }
Property Value
SecretBase

Tenant

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

Declaration
public object Tenant { get; set; }
Property Value
System.Object

UpdateResourceEndpoint

The Update Resource REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string).

Declaration
public object UpdateResourceEndpoint { get; set; }
Property Value
System.Object