Class AzureSqlMILinkedService

Azure SQL Managed Instance linked service.

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

Constructors

AzureSqlMILinkedService()

Initializes a new instance of AzureSqlMILinkedService.

Declaration
public AzureSqlMILinkedService ();

Properties

AlwaysEncryptedSettings

Sql always encrypted properties.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.SqlAlwaysEncryptedProperties AlwaysEncryptedSettings { get; set; }
Property Value
SqlAlwaysEncryptedProperties

ApplicationIntent

The application workload type when connecting to a server, used by recommended version. Possible values are ReadOnly and ReadWrite. Type: string (or Expression with resultType string).

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

AuthenticationType

The type used for authentication. Type: string.

Declaration
public Nullable<Azure.Analytics.Synapse.Artifacts.Models.AzureSqlMIAuthenticationType> AuthenticationType { get; set; }
Property Value
System.Nullable<AzureSqlMIAuthenticationType>

AzureCloudType

Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).

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

CommandTimeout

The default wait time (in seconds) before terminating the attempt to execute a command and generating an error, used by recommended version. Type: integer (or Expression with resultType integer).

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

ConnectionString

The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

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

ConnectRetryCount

The number of re-connections attempted after identifying that there was an idle connection failure, used by recommended version. This must be an integer between 0 and 255. Type: integer (or Expression with resultType integer).

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

ConnectRetryInterval

The amount of time (in seconds) between each re-connection attempt after identifying that there was an idle connection failure, used by recommended version. This must be an integer between 1 and 60. Type: integer (or Expression with resultType integer).

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

ConnectTimeout

The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error, used by recommended version. Type: integer (or Expression with resultType integer).

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

Credential

The credential reference containing authentication information.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.CredentialReference Credential { get; set; }
Property Value
CredentialReference

Database

The name of the database, used by recommended version. Type: string (or Expression with resultType string).

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

Encrypt

Indicate whether TLS encryption is required for all data sent between the client and server, used by recommended version. Possible values are true/yes/mandatory, false/no/optional and strict. Type: string (or Expression with resultType string).

Declaration
public object Encrypt { 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

FailoverPartner

The name or address of the partner server to connect to if the primary server is down, used by recommended version. Type: string (or Expression with resultType string).

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

HostNameInCertificate

The host name to use when validating the server certificate for the connection. When not specified, the server name from the Data Source is used for certificate validation, used by recommended version. Type: string (or Expression with resultType string).

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

IntegratedSecurity

Indicate whether User ID and Password are specified in the connection (when false) or whether the current Windows account credentials are used for authentication (when true), used by recommended version. Type: Boolean (or Expression with resultType boolean).

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

LoadBalanceTimeout

The minimum time, in seconds, for the connection to live in the connection pool before being destroyed, used by recommended version. Type: integer (or Expression with resultType integer).

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

MaxPoolSize

The maximum number of connections allowed in the connection pool for this specific connection string, used by recommended version. Type: integer (or Expression with resultType integer).

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

MinPoolSize

The minimum number of connections allowed in the connection pool for this specific connection string, used by recommended version. Type: integer (or Expression with resultType integer).

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

MultipleActiveResultSets

When true, an application can maintain multiple active result sets (MARS). When false, an application must process or cancel all result sets from one batch before it can execute any other batch on that connection. Type: Boolean (or Expression with resultType boolean).

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

MultiSubnetFailover

If your application is connecting to an AlwaysOn availability group (AG) on different subnets, setting MultiSubnetFailover=true provides faster detection of and connection to the (currently) active server, used by recommended version. Type: Boolean (or Expression with resultType boolean).

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

PacketSize

The size in bytes of the network packets used to communicate with an instance of server, used by recommended version. Type: integer (or Expression with resultType integer).

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

Password

The Azure key vault secret reference of password in connection string.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.AzureKeyVaultSecretReference Password { get; set; }
Property Value
AzureKeyVaultSecretReference

Pooling

Indicate whether the connection will be pooled or explicitly opened every time that the connection is requested, used by recommended version. Type: Boolean (or Expression with resultType boolean).

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

Server

The name or network address of the instance of SQL Server to which to connect, used by recommended version. Type: string (or Expression with resultType string).

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

ServicePrincipalCredential

The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference. 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 ServicePrincipalCredential { get; set; }
Property Value
SecretBase

ServicePrincipalCredentialType

The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).

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

ServicePrincipalId

The ID of the service principal used to authenticate against Azure SQL Managed Instance. 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 Azure SQL Managed Instance. 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

TrustServerCertificate

Indicate whether the channel will be encrypted while bypassing walking the certificate chain to validate trust, used by recommended version. Type: Boolean (or Expression with resultType boolean).

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

UserName

The user name to be used when connecting to server. Type: string (or Expression with resultType string).

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