SqlServerLinkedService interface

  • Reference
Package:
@azure/arm-datafactory

SQL Server linked service.

Extends
LinkedService

Properties

alwaysEncryptedSettings

Sql always encrypted properties.
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).
authenticationType

The type used for authentication. Type: string.
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).
connectionString

The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
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).
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).
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).
credential

The credential reference containing authentication information.
database

The name of the database, used by recommended version. Type: string (or Expression with resultType string).
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).
encryptedCredential

The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
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).
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).
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).
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).
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).
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).
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, used by recommended version. Type: Boolean (or Expression with resultType boolean).
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).
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).
password

The on-premises Windows authentication password.
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).
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).
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).
type

Polymorphic discriminator, which specifies the different types this object can be
userName

The on-premises Windows authentication user name. Type: string (or Expression with resultType string).

Inherited Properties

annotations

List of tags that can be used for describing the linked service.
connectVia

The integration runtime reference.
description

Linked service description.
parameters

Parameters for linked service.
version

Version of the linked service.

Property Details

alwaysEncryptedSettings

Sql always encrypted properties.

alwaysEncryptedSettings?: SqlAlwaysEncryptedProperties

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).

applicationIntent?: any

Property Value

any

authenticationType

The type used for authentication. Type: string.

authenticationType?: string

Property Value

string

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).

commandTimeout?: any

Property Value

any

connectionString

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

connectionString?: any

Property Value

any

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).

connectRetryCount?: any

Property Value

any

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).

connectRetryInterval?: any

Property Value

any

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).

connectTimeout?: any

Property Value

any

credential

The credential reference containing authentication information.

credential?: CredentialReference

Property Value

CredentialReference

database

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

database?: any

Property Value

any

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).

encrypt?: any

Property Value

any

encryptedCredential

The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.

encryptedCredential?: string

Property Value

string

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).

failoverPartner?: any

Property Value

any

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).

hostNameInCertificate?: any

Property Value

any

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).

integratedSecurity?: any

Property Value

any

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).

loadBalanceTimeout?: any

Property Value

any

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).

maxPoolSize?: any

Property Value

any

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).

minPoolSize?: any

Property Value

any

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, used by recommended version. Type: Boolean (or Expression with resultType boolean).

multipleActiveResultSets?: any

Property Value

any

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).

multiSubnetFailover?: any

Property Value

any

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).

packetSize?: any

Property Value

any

password

The on-premises Windows authentication password.

password?: SecretBaseUnion

Property Value

SecretBaseUnion

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).

pooling?: any

Property Value

any

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).

server?: any

Property Value

any

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).

trustServerCertificate?: any

Property Value

any

type

Polymorphic discriminator, which specifies the different types this object can be

type: "SqlServer"

Property Value

"SqlServer"

userName

The on-premises Windows authentication user name. Type: string (or Expression with resultType string).

userName?: any

Property Value

any

Inherited Property Details

annotations

List of tags that can be used for describing the linked service.

annotations?: any[]

Property Value

any[]

Inherited From LinkedService.annotations

connectVia

The integration runtime reference.

connectVia?: IntegrationRuntimeReference

Property Value

IntegrationRuntimeReference

Inherited From LinkedService.connectVia

description

Linked service description.

description?: string

Property Value

string

Inherited From LinkedService.description

parameters

Parameters for linked service.

parameters?: {[propertyName: string]: ParameterSpecification}

Property Value

{[propertyName: string]: ParameterSpecification}

Inherited From LinkedService.parameters

version

Version of the linked service.

version?: string

Property Value

string

Inherited From LinkedService.version