SqlServerLinkedService Class
- java.
lang. Object - com.
azure. resourcemanager. datafactory. models. LinkedService - com.
azure. resourcemanager. datafactory. models. SqlServerLinkedService
- com.
- com.
public final 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 |
|---|---|
|
Sql |
alwaysEncryptedSettings()
Get the always |
| Object |
applicationIntent()
Get the application |
|
Sql |
authenticationType()
Get the authentication |
| Object |
commandTimeout()
Get the command |
| Object |
connectionString()
Get the connection |
| Object |
connectRetryCount()
Get the connect |
| Object |
connectRetryInterval()
Get the connect |
| Object |
connectTimeout()
Get the connect |
|
Credential |
credential()
Get the credential property: The credential reference containing authentication information. |
| Object |
database()
Get the database property: The name of the database, used by recommended version. |
| Object |
encrypt()
Get the encrypt property: Indicate whether TLS encryption is required for all data sent between the client and server, used by recommended version. |
| String |
encryptedCredential()
Get the encrypted |
| Object |
failoverPartner()
Get the failover |
|
static
Sql |
fromJson(JsonReader jsonReader)
Reads an instance of Sql |
| Object |
hostnameInCertificate()
Get the hostname |
| Object |
integratedSecurity()
Get the integrated |
| Object |
loadBalanceTimeout()
Get the load |
| Object |
maxPoolSize()
Get the max |
| Object |
minPoolSize()
Get the min |
| Object |
multipleActiveResultSets()
Get the multiple |
| Object |
multiSubnetFailover()
Get the multi |
| Object |
packetSize()
Get the packet |
|
Secret |
password()
Get the password property: The on-premises Windows authentication password. |
| Object |
pooling()
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 |
server()
Get the server property: The name or network address of the instance of SQL Server to which to connect, used by recommended version. |
|
Json |
toJson(JsonWriter jsonWriter) |
| Object |
trustServerCertificate()
Get the trust |
| String |
type()
Get the type property: Type of linked service. |
| Object |
username()
Get the username property: The on-premises Windows authentication user name. |
| void |
validate()
Validates the instance. |
|
Sql |
withAlwaysEncryptedSettings(SqlAlwaysEncryptedProperties alwaysEncryptedSettings)
Set the always |
|
Sql |
withAnnotations(List<Object> annotations)
Set the annotations property: List of tags that can be used for describing the linked service. |
|
Sql |
withApplicationIntent(Object applicationIntent)
Set the application |
|
Sql |
withAuthenticationType(SqlServerAuthenticationType authenticationType)
Set the authentication |
|
Sql |
withCommandTimeout(Object commandTimeout)
Set the command |
|
Sql |
withConnectionString(Object connectionString)
Set the connection |
|
Sql |
withConnectRetryCount(Object connectRetryCount)
Set the connect |
|
Sql |
withConnectRetryInterval(Object connectRetryInterval)
Set the connect |
|
Sql |
withConnectTimeout(Object connectTimeout)
Set the connect |
|
Sql |
withConnectVia(IntegrationRuntimeReference connectVia)
Set the connect |
|
Sql |
withCredential(CredentialReference credential)
Set the credential property: The credential reference containing authentication information. |
|
Sql |
withDatabase(Object database)
Set the database property: The name of the database, used by recommended version. |
|
Sql |
withDescription(String description)
Set the description property: Linked service description. |
|
Sql |
withEncrypt(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 |
withEncryptedCredential(String encryptedCredential)
Set the encrypted |
|
Sql |
withFailoverPartner(Object failoverPartner)
Set the failover |
|
Sql |
withHostnameInCertificate(Object hostnameInCertificate)
Set the hostname |
|
Sql |
withIntegratedSecurity(Object integratedSecurity)
Set the integrated |
|
Sql |
withLoadBalanceTimeout(Object loadBalanceTimeout)
Set the load |
|
Sql |
withMaxPoolSize(Object maxPoolSize)
Set the max |
|
Sql |
withMinPoolSize(Object minPoolSize)
Set the min |
|
Sql |
withMultipleActiveResultSets(Object multipleActiveResultSets)
Set the multiple |
|
Sql |
withMultiSubnetFailover(Object multiSubnetFailover)
Set the multi |
|
Sql |
withPacketSize(Object packetSize)
Set the packet |
|
Sql |
withParameters(Map<String,ParameterSpecification> parameters)
Set the parameters property: Parameters for linked service. |
|
Sql |
withPassword(SecretBase password)
Set the password property: The on-premises Windows authentication password. |
|
Sql |
withPooling(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 |
withServer(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 |
withTrustServerCertificate(Object trustServerCertificate)
Set the trust |
|
Sql |
withUsername(Object username)
Set the username property: The on-premises Windows authentication user name. |
|
Sql |
withVersion(String version)
Set the version property: Version of the linked service. |
Methods inherited from LinkedService
Methods inherited from java.lang.Object
Constructor Details
SqlServerLinkedService
public SqlServerLinkedService()
Creates an instance of SqlServerLinkedService class.
Method Details
alwaysEncryptedSettings
public SqlAlwaysEncryptedProperties alwaysEncryptedSettings()
Get the alwaysEncryptedSettings property: Sql always encrypted properties.
Returns:
applicationIntent
public Object applicationIntent()
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:
authenticationType
public SqlServerAuthenticationType authenticationType()
Get the authenticationType property: The type used for authentication. Type: string.
Returns:
commandTimeout
public Object commandTimeout()
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:
connectionString
public Object connectionString()
Get the connectionString property: The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
Returns:
connectRetryCount
public Object connectRetryCount()
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:
connectRetryInterval
public Object connectRetryInterval()
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:
connectTimeout
public Object connectTimeout()
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:
credential
public CredentialReference credential()
Get the credential property: The credential reference containing authentication information.
Returns:
database
public Object database()
Get the database property: The name of the database, used by recommended version. Type: string (or Expression with resultType string).
Returns:
encrypt
public Object encrypt()
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:
encryptedCredential
public String encryptedCredential()
Get the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
Returns:
failoverPartner
public Object failoverPartner()
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:
fromJson
public static SqlServerLinkedService fromJson(JsonReader jsonReader)
Reads an instance of SqlServerLinkedService from the JsonReader.
Parameters:
Returns:
Throws:
hostnameInCertificate
public Object hostnameInCertificate()
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:
integratedSecurity
public Object integratedSecurity()
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:
loadBalanceTimeout
public Object loadBalanceTimeout()
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:
maxPoolSize
public Object maxPoolSize()
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:
minPoolSize
public Object minPoolSize()
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:
multipleActiveResultSets
public Object multipleActiveResultSets()
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, used by recommended version. Type: Boolean (or Expression with resultType boolean).
Returns:
multiSubnetFailover
public Object multiSubnetFailover()
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:
packetSize
public Object packetSize()
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:
password
public SecretBase password()
Get the password property: The on-premises Windows authentication password.
Returns:
pooling
public Object pooling()
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:
server
public Object server()
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:
toJson
public JsonWriter toJson(JsonWriter jsonWriter)
Overrides:
SqlServerLinkedService.toJson(JsonWriter jsonWriter)Parameters:
Throws:
trustServerCertificate
public Object trustServerCertificate()
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:
type
public String type()
Get the type property: Type of linked service.
Overrides:
SqlServerLinkedService.type()Returns:
username
public Object username()
Get the username property: The on-premises Windows authentication user name. Type: string (or Expression with resultType string).
Returns:
validate
public void validate()
Validates the instance.
Overrides:
SqlServerLinkedService.validate()withAlwaysEncryptedSettings
public SqlServerLinkedService withAlwaysEncryptedSettings(SqlAlwaysEncryptedProperties alwaysEncryptedSettings)
Set the alwaysEncryptedSettings property: Sql always encrypted properties.
Parameters:
Returns:
withAnnotations
public SqlServerLinkedService withAnnotations(List<Object> annotations)
Set the annotations property: List of tags that can be used for describing the linked service.
Overrides:
SqlServerLinkedService.withAnnotations(List<Object> annotations)Parameters:
withApplicationIntent
public SqlServerLinkedService withApplicationIntent(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:
withAuthenticationType
public SqlServerLinkedService withAuthenticationType(SqlServerAuthenticationType authenticationType)
Set the authenticationType property: The type used for authentication. Type: string.
Parameters:
Returns:
withCommandTimeout
public SqlServerLinkedService withCommandTimeout(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:
withConnectionString
public SqlServerLinkedService withConnectionString(Object connectionString)
Set the connectionString property: The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
Parameters:
Returns:
withConnectRetryCount
public SqlServerLinkedService withConnectRetryCount(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:
withConnectRetryInterval
public SqlServerLinkedService withConnectRetryInterval(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:
withConnectTimeout
public SqlServerLinkedService withConnectTimeout(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:
withConnectVia
public SqlServerLinkedService withConnectVia(IntegrationRuntimeReference connectVia)
Set the connectVia property: The integration runtime reference.
Overrides:
SqlServerLinkedService.withConnectVia(IntegrationRuntimeReference connectVia)Parameters:
withCredential
public SqlServerLinkedService withCredential(CredentialReference credential)
Set the credential property: The credential reference containing authentication information.
Parameters:
Returns:
withDatabase
public SqlServerLinkedService withDatabase(Object database)
Set the database property: The name of the database, used by recommended version. Type: string (or Expression with resultType string).
Parameters:
Returns:
withDescription
public SqlServerLinkedService withDescription(String description)
Set the description property: Linked service description.
Overrides:
SqlServerLinkedService.withDescription(String description)Parameters:
withEncrypt
public SqlServerLinkedService withEncrypt(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:
withEncryptedCredential
public SqlServerLinkedService withEncryptedCredential(String encryptedCredential)
Set the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
Parameters:
Returns:
withFailoverPartner
public SqlServerLinkedService withFailoverPartner(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:
withHostnameInCertificate
public SqlServerLinkedService withHostnameInCertificate(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:
withIntegratedSecurity
public SqlServerLinkedService withIntegratedSecurity(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:
withLoadBalanceTimeout
public SqlServerLinkedService withLoadBalanceTimeout(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:
withMaxPoolSize
public SqlServerLinkedService withMaxPoolSize(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:
withMinPoolSize
public SqlServerLinkedService withMinPoolSize(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:
withMultipleActiveResultSets
public SqlServerLinkedService withMultipleActiveResultSets(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, used by recommended version. Type: Boolean (or Expression with resultType boolean).
Parameters:
Returns:
withMultiSubnetFailover
public SqlServerLinkedService withMultiSubnetFailover(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:
withPacketSize
public SqlServerLinkedService withPacketSize(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:
withParameters
public SqlServerLinkedService withParameters(Map<String,ParameterSpecification> parameters)
Set the parameters property: Parameters for linked service.
Overrides:
SqlServerLinkedService.withParameters(Map<String,ParameterSpecification> parameters)Parameters:
withPassword
public SqlServerLinkedService withPassword(SecretBase password)
Set the password property: The on-premises Windows authentication password.
Parameters:
Returns:
withPooling
public SqlServerLinkedService withPooling(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:
withServer
public SqlServerLinkedService withServer(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:
withTrustServerCertificate
public SqlServerLinkedService withTrustServerCertificate(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:
withUsername
public SqlServerLinkedService withUsername(Object username)
Set the username property: The on-premises Windows authentication user name. Type: string (or Expression with resultType string).
Parameters:
Returns:
withVersion
public SqlServerLinkedService withVersion(String version)
Set the version property: Version of the linked service.
Overrides:
SqlServerLinkedService.withVersion(String version)Parameters: