AzureSqlDatabaseLinkedServiceTypeProperties interface
Azure SQL Database linked service properties.
- Extends
Properties
always |
Sql always encrypted properties. |
authentication |
The type used for authentication. Type: string. |
azure |
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). |
connection |
The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. |
credential | The credential reference containing authentication information. |
encrypted |
The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. |
password | The Azure key vault secret reference of password in connection string. |
service |
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. |
service |
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). |
service |
The ID of the service principal used to authenticate against Azure SQL Database. Type: string (or Expression with resultType string). |
service |
The key of the service principal used to authenticate against Azure SQL Database. |
tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). |
user |
The user name to be used when connecting to server. Type: string (or Expression with resultType string). |
Inherited Properties
application |
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). |
command |
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). |
connect |
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). |
connect |
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). |
connect |
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). |
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). |
failover |
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). |
host |
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). |
integrated |
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). |
load |
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). |
max |
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). |
min |
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). |
multiple |
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). |
multi |
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). |
packet |
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). |
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). |
trust |
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). |
Property Details
alwaysEncryptedSettings
Sql always encrypted properties.
alwaysEncryptedSettings?: SqlAlwaysEncryptedProperties
Property Value
authenticationType
The type used for authentication. Type: string.
authenticationType?: string
Property Value
string
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).
azureCloudType?: any
Property Value
any
connectionString
The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
connectionString?: any
Property Value
any
credential
The credential reference containing authentication information.
credential?: CredentialReference
Property Value
encryptedCredential
The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
encryptedCredential?: string
Property Value
string
password
The Azure key vault secret reference of password in connection string.
password?: AzureKeyVaultSecretReference
Property Value
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.
servicePrincipalCredential?: SecretBaseUnion
Property Value
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).
servicePrincipalCredentialType?: any
Property Value
any
servicePrincipalId
The ID of the service principal used to authenticate against Azure SQL Database. Type: string (or Expression with resultType string).
servicePrincipalId?: any
Property Value
any
servicePrincipalKey
The key of the service principal used to authenticate against Azure SQL Database.
servicePrincipalKey?: SecretBaseUnion
Property Value
tenant
The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).
tenant?: any
Property Value
any
userName
The user name to be used when connecting to server. Type: string (or Expression with resultType string).
userName?: any
Property Value
any
Inherited Property Details
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
Inherited From SqlServerBaseLinkedServiceTypeProperties.applicationIntent
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
Inherited From SqlServerBaseLinkedServiceTypeProperties.commandTimeout
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
Inherited From SqlServerBaseLinkedServiceTypeProperties.connectRetryCount
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
Inherited From SqlServerBaseLinkedServiceTypeProperties.connectRetryInterval
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
Inherited From SqlServerBaseLinkedServiceTypeProperties.connectTimeout
database
The name of the database, used by recommended version. Type: string (or Expression with resultType string).
database?: any
Property Value
any
Inherited From SqlServerBaseLinkedServiceTypeProperties.database
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
Inherited From SqlServerBaseLinkedServiceTypeProperties.encrypt
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
Inherited From SqlServerBaseLinkedServiceTypeProperties.failoverPartner
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
Inherited From SqlServerBaseLinkedServiceTypeProperties.hostNameInCertificate
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
Inherited From SqlServerBaseLinkedServiceTypeProperties.integratedSecurity
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
Inherited From SqlServerBaseLinkedServiceTypeProperties.loadBalanceTimeout
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
Inherited From SqlServerBaseLinkedServiceTypeProperties.maxPoolSize
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
Inherited From SqlServerBaseLinkedServiceTypeProperties.minPoolSize
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
Inherited From SqlServerBaseLinkedServiceTypeProperties.multipleActiveResultSets
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
Inherited From SqlServerBaseLinkedServiceTypeProperties.multiSubnetFailover
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
Inherited From SqlServerBaseLinkedServiceTypeProperties.packetSize
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
Inherited From SqlServerBaseLinkedServiceTypeProperties.pooling
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
Inherited From SqlServerBaseLinkedServiceTypeProperties.server
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
Inherited From SqlServerBaseLinkedServiceTypeProperties.trustServerCertificate