SqlServerLinkedService Class

Reference

SQL Server linked service.

All required parameters must be populated in order to send to server.

Inheritance: azure.mgmt.datafactory.models._models_py3.LinkedService

SqlServerLinkedService

Constructor

SqlServerLinkedService(*, additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, version: str | None = None, connect_via: _models.IntegrationRuntimeReference | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification] | None = None, annotations: List[MutableMapping[str, Any]] | None = None, server: MutableMapping[str, Any] | None = None, database: MutableMapping[str, Any] | None = None, encrypt: MutableMapping[str, Any] | None = None, trust_server_certificate: MutableMapping[str, Any] | None = None, host_name_in_certificate: MutableMapping[str, Any] | None = None, application_intent: MutableMapping[str, Any] | None = None, connect_timeout: MutableMapping[str, Any] | None = None, connect_retry_count: MutableMapping[str, Any] | None = None, connect_retry_interval: MutableMapping[str, Any] | None = None, load_balance_timeout: MutableMapping[str, Any] | None = None, command_timeout: MutableMapping[str, Any] | None = None, integrated_security: MutableMapping[str, Any] | None = None, failover_partner: MutableMapping[str, Any] | None = None, max_pool_size: MutableMapping[str, Any] | None = None, min_pool_size: MutableMapping[str, Any] | None = None, multiple_active_result_sets: MutableMapping[str, Any] | None = None, multi_subnet_failover: MutableMapping[str, Any] | None = None, packet_size: MutableMapping[str, Any] | None = None, pooling: MutableMapping[str, Any] | None = None, connection_string: MutableMapping[str, Any] | None = None, authentication_type: str | _models.SqlServerAuthenticationType | None = None, user_name: MutableMapping[str, Any] | None = None, password: _models.SecretBase | None = None, encrypted_credential: str | None = None, always_encrypted_settings: _models.SqlAlwaysEncryptedProperties | None = None, credential: _models.CredentialReference | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
additional_properties	dict[str, <xref:JSON>] Unmatched properties from the message are deserialized to this collection.
version	str Version of the linked service.
connect_via	IntegrationRuntimeReference The integration runtime reference.
description	str Linked service description.
parameters	dict[str, ParameterSpecification] Parameters for linked service.
annotations	list[<xref:JSON>] List of tags that can be used for describing the linked service.
server	<xref:JSON> 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).
database	<xref:JSON> The name of the database, used by recommended version. Type: string (or Expression with resultType string).
encrypt	<xref:JSON> 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).
trust_server_certificate	<xref:JSON> 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).
host_name_in_certificate	<xref:JSON> 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).
application_intent	<xref:JSON> 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).
connect_timeout	<xref:JSON> 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).
connect_retry_count	<xref:JSON> 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_retry_interval	<xref:JSON> 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).
load_balance_timeout	<xref:JSON> 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).
command_timeout	<xref:JSON> 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).
integrated_security	<xref:JSON> 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).
failover_partner	<xref:JSON> 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).
max_pool_size	<xref:JSON> 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_pool_size	<xref:JSON> 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_active_result_sets	<xref:JSON> 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_subnet_failover	<xref:JSON> 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_size	<xref:JSON> 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	<xref:JSON> 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).
connection_string	<xref:JSON> The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
authentication_type	str or SqlServerAuthenticationType The type used for authentication. Type: string. Known values are: "SQL", "Windows", and "UserAssignedManagedIdentity".
user_name	<xref:JSON> The on-premises Windows authentication user name. Type: string (or Expression with resultType string).
password	SecretBase The on-premises Windows authentication password.
encrypted_credential	str The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
always_encrypted_settings	SqlAlwaysEncryptedProperties Sql always encrypted properties.
credential	CredentialReference The credential reference containing authentication information.

Variables

Name	Description
additional_properties	dict[str, <xref:JSON>] Unmatched properties from the message are deserialized to this collection.
type	str Type of linked service. Required.
version	str Version of the linked service.
connect_via	IntegrationRuntimeReference The integration runtime reference.
description	str Linked service description.
parameters	dict[str, ParameterSpecification] Parameters for linked service.
annotations	list[<xref:JSON>] List of tags that can be used for describing the linked service.
server	<xref:JSON> 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).
database	<xref:JSON> The name of the database, used by recommended version. Type: string (or Expression with resultType string).
encrypt	<xref:JSON> 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).
trust_server_certificate	<xref:JSON> 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).
host_name_in_certificate	<xref:JSON> 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).
application_intent	<xref:JSON> 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).
connect_timeout	<xref:JSON> 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).
connect_retry_count	<xref:JSON> 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_retry_interval	<xref:JSON> 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).
load_balance_timeout	<xref:JSON> 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).
command_timeout	<xref:JSON> 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).
integrated_security	<xref:JSON> 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).
failover_partner	<xref:JSON> 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).
max_pool_size	<xref:JSON> 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_pool_size	<xref:JSON> 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_active_result_sets	<xref:JSON> 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_subnet_failover	<xref:JSON> 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_size	<xref:JSON> 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	<xref:JSON> 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).
connection_string	<xref:JSON> The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
authentication_type	str or SqlServerAuthenticationType The type used for authentication. Type: string. Known values are: "SQL", "Windows", and "UserAssignedManagedIdentity".
user_name	<xref:JSON> The on-premises Windows authentication user name. Type: string (or Expression with resultType string).
password	SecretBase The on-premises Windows authentication password.
encrypted_credential	str The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
always_encrypted_settings	SqlAlwaysEncryptedProperties Sql always encrypted properties.
credential	CredentialReference The credential reference containing authentication information.

Share via

SqlServerLinkedService Class

Constructor

Keyword-Only Parameters

Variables

Additional resources