SqlServerLinkedService Class
- java.
lang. Object - com.
azure. analytics. synapse. artifacts. models. LinkedService - com.
azure. analytics. synapse. artifacts. models. SqlServerLinkedService
- com.
- com.
public class SqlServerLinkedService
extends LinkedService
SQL Server linked service.
Constructor Summary
| Constructor | Description |
|---|---|
| SqlServerLinkedService() |
Creates an instance of Sql |
Method Summary
| Modifier and Type | Method and Description |
|---|---|
|
static
Sql |
fromJson(JsonReader jsonReader)
Reads an instance of Sql |
|
Sql |
getAlwaysEncryptedSettings()
Get the always |
| Object |
getApplicationIntent()
Get the application |
|
Sql |
getAuthenticationType()
Get the authentication |
| Object |
getCommandTimeout()
Get the command |
| Object |
getConnectionString()
Get the connection |
| Object |
getConnectRetryCount()
Get the connect |
| Object |
getConnectRetryInterval()
Get the connect |
| Object |
getConnectTimeout()
Get the connect |
|
Credential |
getCredential()
Get the credential property: The credential reference containing authentication information. |
| Object |
getDatabase()
Get the database property: The name of the database, used by recommended version. |
| Object |
getEncrypt()
Get the encrypt property: Indicate whether TLS encryption is required for all data sent between the client and server, used by recommended version. |
| Object |
getEncryptedCredential()
Get the encrypted |
| Object |
getFailoverPartner()
Get the failover |
| Object |
getHostNameInCertificate()
Get the host |
| Object |
getIntegratedSecurity()
Get the integrated |
| Object |
getLoadBalanceTimeout()
Get the load |
| Object |
getMaxPoolSize()
Get the max |
| Object |
getMinPoolSize()
Get the min |
| Object |
getMultipleActiveResultSets()
Get the multiple |
| Object |
getMultiSubnetFailover()
Get the multi |
| Object |
getPacketSize()
Get the packet |
|
Secret |
getPassword()
Get the password property: The on-premises Windows authentication password. |
| Object |
getPooling()
Get the pooling property: Indicate whether the connection will be pooled or explicitly opened every time that the connection is requested, used by recommended version. |
| Object |
getServer()
Get the server property: The name or network address of the instance of SQL Server to which to connect, used by recommended version. |
| Object |
getTrustServerCertificate()
Get the trust |
| String |
getType()
Get the type property: Type of linked service. |
| Object |
getUserName()
Get the user |
|
Sql |
setAlwaysEncryptedSettings(SqlAlwaysEncryptedProperties alwaysEncryptedSettings)
Set the always |
|
Sql |
setAnnotations(List<Object> annotations)
Set the annotations property: List of tags that can be used for describing the linked service. |
|
Sql |
setApplicationIntent(Object applicationIntent)
Set the application |
|
Sql |
setAuthenticationType(SqlServerAuthenticationType authenticationType)
Set the authentication |
|
Sql |
setCommandTimeout(Object commandTimeout)
Set the command |
|
Sql |
setConnectionString(Object connectionString)
Set the connection |
|
Sql |
setConnectRetryCount(Object connectRetryCount)
Set the connect |
|
Sql |
setConnectRetryInterval(Object connectRetryInterval)
Set the connect |
|
Sql |
setConnectTimeout(Object connectTimeout)
Set the connect |
|
Sql |
setConnectVia(IntegrationRuntimeReference connectVia)
Set the connect |
|
Sql |
setCredential(CredentialReference credential)
Set the credential property: The credential reference containing authentication information. |
|
Sql |
setDatabase(Object database)
Set the database property: The name of the database, used by recommended version. |
|
Sql |
setDescription(String description)
Set the description property: Linked service description. |
|
Sql |
setEncrypt(Object encrypt)
Set the encrypt property: Indicate whether TLS encryption is required for all data sent between the client and server, used by recommended version. |
|
Sql |
setEncryptedCredential(Object encryptedCredential)
Set the encrypted |
|
Sql |
setFailoverPartner(Object failoverPartner)
Set the failover |
|
Sql |
setHostNameInCertificate(Object hostNameInCertificate)
Set the host |
|
Sql |
setIntegratedSecurity(Object integratedSecurity)
Set the integrated |
|
Sql |
setLoadBalanceTimeout(Object loadBalanceTimeout)
Set the load |
|
Sql |
setMaxPoolSize(Object maxPoolSize)
Set the max |
|
Sql |
setMinPoolSize(Object minPoolSize)
Set the min |
|
Sql |
setMultipleActiveResultSets(Object multipleActiveResultSets)
Set the multiple |
|
Sql |
setMultiSubnetFailover(Object multiSubnetFailover)
Set the multi |
|
Sql |
setPacketSize(Object packetSize)
Set the packet |
|
Sql |
setParameters(Map<String,ParameterSpecification> parameters)
Set the parameters property: Parameters for linked service. |
|
Sql |
setPassword(SecretBase password)
Set the password property: The on-premises Windows authentication password. |
|
Sql |
setPooling(Object pooling)
Set the pooling property: Indicate whether the connection will be pooled or explicitly opened every time that the connection is requested, used by recommended version. |
|
Sql |
setServer(Object server)
Set the server property: The name or network address of the instance of SQL Server to which to connect, used by recommended version. |
|
Sql |
setTrustServerCertificate(Object trustServerCertificate)
Set the trust |
|
Sql |
setUserName(Object userName)
Set the user |
|
Sql |
setVersion(String version)
Set the version property: Version of the linked service. |
|
Json |
toJson(JsonWriter jsonWriter) |
Methods inherited from LinkedService
Methods inherited from java.lang.Object
Constructor Details
SqlServerLinkedService
public SqlServerLinkedService()
Creates an instance of SqlServerLinkedService class.
Method Details
fromJson
public static SqlServerLinkedService fromJson(JsonReader jsonReader)
Reads an instance of SqlServerLinkedService from the JsonReader.
Parameters:
Returns:
Throws:
getAlwaysEncryptedSettings
public SqlAlwaysEncryptedProperties getAlwaysEncryptedSettings()
Get the alwaysEncryptedSettings property: Sql always encrypted properties.
Returns:
getApplicationIntent
public Object getApplicationIntent()
Get the applicationIntent property: 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).
Returns:
getAuthenticationType
public SqlServerAuthenticationType getAuthenticationType()
Get the authenticationType property: The type used for authentication. Type: string.
Returns:
getCommandTimeout
public Object getCommandTimeout()
Get the commandTimeout property: 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).
Returns:
getConnectionString
public Object getConnectionString()
Get the connectionString property: The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
Returns:
getConnectRetryCount
public Object getConnectRetryCount()
Get the connectRetryCount property: 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).
Returns:
getConnectRetryInterval
public Object getConnectRetryInterval()
Get the connectRetryInterval property: 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).
Returns:
getConnectTimeout
public Object getConnectTimeout()
Get the connectTimeout property: 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).
Returns:
getCredential
public CredentialReference getCredential()
Get the credential property: The credential reference containing authentication information.
Returns:
getDatabase
public Object getDatabase()
Get the database property: The name of the database, used by recommended version. Type: string (or Expression with resultType string).
Returns:
getEncrypt
public Object getEncrypt()
Get the encrypt property: 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).
Returns:
getEncryptedCredential
public Object getEncryptedCredential()
Get the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).
Returns:
getFailoverPartner
public Object getFailoverPartner()
Get the failoverPartner property: 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).
Returns:
getHostNameInCertificate
public Object getHostNameInCertificate()
Get the hostNameInCertificate property: 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).
Returns:
getIntegratedSecurity
public Object getIntegratedSecurity()
Get the integratedSecurity property: 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).
Returns:
getLoadBalanceTimeout
public Object getLoadBalanceTimeout()
Get the loadBalanceTimeout property: 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).
Returns:
getMaxPoolSize
public Object getMaxPoolSize()
Get the maxPoolSize property: 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).
Returns:
getMinPoolSize
public Object getMinPoolSize()
Get the minPoolSize property: 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).
Returns:
getMultipleActiveResultSets
public Object getMultipleActiveResultSets()
Get the multipleActiveResultSets property: 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).
Returns:
getMultiSubnetFailover
public Object getMultiSubnetFailover()
Get the multiSubnetFailover property: 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).
Returns:
getPacketSize
public Object getPacketSize()
Get the packetSize property: 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).
Returns:
getPassword
public SecretBase getPassword()
Get the password property: The on-premises Windows authentication password.
Returns:
getPooling
public Object getPooling()
Get the pooling property: 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).
Returns:
getServer
public Object getServer()
Get the server property: 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).
Returns:
getTrustServerCertificate
public Object getTrustServerCertificate()
Get the trustServerCertificate property: 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).
Returns:
getType
public String getType()
Get the type property: Type of linked service.
Overrides:
SqlServerLinkedService.getType()Returns:
getUserName
public Object getUserName()
Get the userName property: The on-premises Windows authentication user name. Type: string (or Expression with resultType string).
Returns:
setAlwaysEncryptedSettings
public SqlServerLinkedService setAlwaysEncryptedSettings(SqlAlwaysEncryptedProperties alwaysEncryptedSettings)
Set the alwaysEncryptedSettings property: Sql always encrypted properties.
Parameters:
Returns:
setAnnotations
public SqlServerLinkedService setAnnotations(List<Object> annotations)
Set the annotations property: List of tags that can be used for describing the linked service.
Overrides:
SqlServerLinkedService.setAnnotations(List<Object> annotations)Parameters:
setApplicationIntent
public SqlServerLinkedService setApplicationIntent(Object applicationIntent)
Set the applicationIntent property: 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).
Parameters:
Returns:
setAuthenticationType
public SqlServerLinkedService setAuthenticationType(SqlServerAuthenticationType authenticationType)
Set the authenticationType property: The type used for authentication. Type: string.
Parameters:
Returns:
setCommandTimeout
public SqlServerLinkedService setCommandTimeout(Object commandTimeout)
Set the commandTimeout property: 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).
Parameters:
Returns:
setConnectionString
public SqlServerLinkedService setConnectionString(Object connectionString)
Set the connectionString property: The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
Parameters:
Returns:
setConnectRetryCount
public SqlServerLinkedService setConnectRetryCount(Object connectRetryCount)
Set the connectRetryCount property: 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).
Parameters:
Returns:
setConnectRetryInterval
public SqlServerLinkedService setConnectRetryInterval(Object connectRetryInterval)
Set the connectRetryInterval property: 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).
Parameters:
Returns:
setConnectTimeout
public SqlServerLinkedService setConnectTimeout(Object connectTimeout)
Set the connectTimeout property: 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).
Parameters:
Returns:
setConnectVia
public SqlServerLinkedService setConnectVia(IntegrationRuntimeReference connectVia)
Set the connectVia property: The integration runtime reference.
Overrides:
SqlServerLinkedService.setConnectVia(IntegrationRuntimeReference connectVia)Parameters:
setCredential
public SqlServerLinkedService setCredential(CredentialReference credential)
Set the credential property: The credential reference containing authentication information.
Parameters:
Returns:
setDatabase
public SqlServerLinkedService setDatabase(Object database)
Set the database property: The name of the database, used by recommended version. Type: string (or Expression with resultType string).
Parameters:
Returns:
setDescription
public SqlServerLinkedService setDescription(String description)
Set the description property: Linked service description.
Overrides:
SqlServerLinkedService.setDescription(String description)Parameters:
setEncrypt
public SqlServerLinkedService setEncrypt(Object encrypt)
Set the encrypt property: 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).
Parameters:
Returns:
setEncryptedCredential
public SqlServerLinkedService setEncryptedCredential(Object encryptedCredential)
Set the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).
Parameters:
Returns:
setFailoverPartner
public SqlServerLinkedService setFailoverPartner(Object failoverPartner)
Set the failoverPartner property: 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).
Parameters:
Returns:
setHostNameInCertificate
public SqlServerLinkedService setHostNameInCertificate(Object hostNameInCertificate)
Set the hostNameInCertificate property: 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).
Parameters:
Returns:
setIntegratedSecurity
public SqlServerLinkedService setIntegratedSecurity(Object integratedSecurity)
Set the integratedSecurity property: 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).
Parameters:
Returns:
setLoadBalanceTimeout
public SqlServerLinkedService setLoadBalanceTimeout(Object loadBalanceTimeout)
Set the loadBalanceTimeout property: 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).
Parameters:
Returns:
setMaxPoolSize
public SqlServerLinkedService setMaxPoolSize(Object maxPoolSize)
Set the maxPoolSize property: 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).
Parameters:
Returns:
setMinPoolSize
public SqlServerLinkedService setMinPoolSize(Object minPoolSize)
Set the minPoolSize property: 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).
Parameters:
Returns:
setMultipleActiveResultSets
public SqlServerLinkedService setMultipleActiveResultSets(Object multipleActiveResultSets)
Set the multipleActiveResultSets property: 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).
Parameters:
Returns:
setMultiSubnetFailover
public SqlServerLinkedService setMultiSubnetFailover(Object multiSubnetFailover)
Set the multiSubnetFailover property: 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).
Parameters:
Returns:
setPacketSize
public SqlServerLinkedService setPacketSize(Object packetSize)
Set the packetSize property: 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).
Parameters:
Returns:
setParameters
public SqlServerLinkedService setParameters(Map<String,ParameterSpecification> parameters)
Set the parameters property: Parameters for linked service.
Overrides:
SqlServerLinkedService.setParameters(Map<String,ParameterSpecification> parameters)Parameters:
setPassword
public SqlServerLinkedService setPassword(SecretBase password)
Set the password property: The on-premises Windows authentication password.
Parameters:
Returns:
setPooling
public SqlServerLinkedService setPooling(Object pooling)
Set the pooling property: 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).
Parameters:
Returns:
setServer
public SqlServerLinkedService setServer(Object server)
Set the server property: 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).
Parameters:
Returns:
setTrustServerCertificate
public SqlServerLinkedService setTrustServerCertificate(Object trustServerCertificate)
Set the trustServerCertificate property: 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).
Parameters:
Returns:
setUserName
public SqlServerLinkedService setUserName(Object userName)
Set the userName property: The on-premises Windows authentication user name. Type: string (or Expression with resultType string).
Parameters:
Returns:
setVersion
public SqlServerLinkedService setVersion(String version)
Set the version property: Version of the linked service.
Overrides:
SqlServerLinkedService.setVersion(String version)Parameters:
toJson
public JsonWriter toJson(JsonWriter jsonWriter)
Overrides:
SqlServerLinkedService.toJson(JsonWriter jsonWriter)Parameters:
Throws: