Class OdbcLinkedService

Open Database Connectivity (ODBC) linked service.

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

Constructors

OdbcLinkedService(Object)

Initializes a new instance of OdbcLinkedService.

Declaration
public OdbcLinkedService (object connectionString);
Parameters
System.Object connectionString

The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, SecureString or AzureKeyVaultSecretReference.
Exceptions
System.ArgumentNullException

connectionString is null.

Properties

AuthenticationType

Type of authentication used to connect to the ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string).

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

ConnectionString

The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, SecureString or AzureKeyVaultSecretReference.

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

Credential

The access credential portion of the connection string specified in driver-specific property-value format. 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 Credential { get; set; }
Property Value
SecretBase

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

Password

Password for Basic authentication. 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 Password { get; set; }
Property Value
SecretBase

UserName

User name for Basic authentication. Type: string (or Expression with resultType string).

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