Azure SQL Entra Dynamic Account

Overview

You can use this account type to connect Azure SQL Snaps with data sources that use Azure SQL Entra Dynamic Account.

Note: Dynamic Account types support Secrets Management, a SnapLogic add-on that allows you to store endpoint credentials in a third-party secrets manager. Orgs using Secrets Management provide the information necessary to retrieve the secrets in expression-enabled dynamic Account fields. During validation and execution, Pipelines obtain the credentials directly from the secrets manager. Learn more about Secrets Management.


Prerequisites

  • Valid Database.
  • Valid Azure Storage credentials.

Account settings

Note: Learn about the common controls in the Snap settings dialog.
Field/Field set Description
Label*

String

Required. Unique name for the account.

Default value: N/A

Account properties

Fieldset
Required. Enter the information to create a connection to the database.
Hostname

String/Expression
Required. Specify the server's address to connect to.

Default value: N/A

Example: 191.235.87.130

Port number

String/Expression
Required. Specify the database server's port to connect to.

Default value: 1433

Example: 3306

Database name

String/Expression
Required. Specify the database name to connect to.

Default value: N/A

Example: sldatabase

Authentication mode

Dropdown list
Required. Select either of the following options for Azure SQL Authentication:
  • Active Directory Password: Provide Username and Password for authentication.
  • Active Directory Service Principal: Provide Client ID and Client Secret from service principals for authentication.
  • Active Directory Service Principal Certificate: Provide Client ID and Keystore values for client certificate-based authentication.
Note:
  • An Azure Active Directory (Azure AD) service principal is the local representation of an application object in a single tenant or directory.
  • Service principals define who can access the application, and what resources the application can access.

Default value: Active Directory Password

Example: Active Directory Service Principal

Client ID

String/Expression

Appears when you select Active Directory Service Principal Certificate as the Authentication mode.

Required. Specify the ID of an Azure Active Directory application.

Default value: N/A

Example: d4cbb84cbd-cv87-bc75-78yv-90fcd-b319c51

Keystore

String/Expression

Appears when you select Active Directory Service Principal Certificate as the Authentication mode.

Required. Specify the location of the keystore file. The location can be SLDB or any other unauthorized endpoint.

Default value: N/A

Example: CertificateWithoutPwd.pfx

Keystore password

String/Expression

Appears when you select Active Directory Service Principal Certificate as the Authentication mode.

Specify the password for the keystore file.

Default value: N/A

Example: 1234test

Key alias

String/Expression

Appears when you select Active Directory Service Principal Certificate as the Authentication mode.

Required. Specify the alias of the private key used from the keystore file.

Default value: N/A

Example: thisisanalias

Private key passphrase

String/Expression

Appears when you select Active Directory Service Principal Certificate as the Authentication mode.

Specify the passphrase for the private key.
Note: You can leave the field empty if the passphrase is the same as the keystore password.

Default value: N/A

Example: 1234test

Username

String/Expression

Appears when you select Active Directory Password as the Authentication mode.

Specify the username to connect to the database. The username is used as the default username when retrieving connections. The username must be valid in order to set up the data source.

Default value: N/A

Example: sladmin

Password

String/Expression

Appears when you select Active Directory Password as the Authentication mode.

Specify the password to connect to the data source. The password is used as the default password when retrieving connections. The password must be valid in order to set up the data source.

Default value: N/A

Example: <Encrypted>

Trust all certificates

Checkbox
Select this checkbox to allow all SSL certificates for connecting to the database.

Default value: Deselected

Advanced properties

Fieldset
Specify advanced properties for connecting to the database.
Auto commit

Checkbox/Expression
Select this checkbox to commit each of the batches immediately after it is executed. If the Snap fails, only the batch being executed at that moment is rolled back.

Deselect this checkbox to commit the output only after all the batches are executed. If the Snap fails, the entire transaction is rolled back, unless the Snap finds invalid input data before it sends the insert request to the server, and routes the error documents to the Error view.

Default value: Selected

Batch size

Integer/Expression
Required. Specify the number of statements to execute at a time.
Note:
  • Select queries are not batched.
  • Using a large batch size could use up the JDBC placeholder limit of 2100.

Default value: 50

Example: 90

Fetch size

Integer/Expression
Required. Specify the number of rows to fetch at a time when executing a query. Large values could cause the server to run out of memory.

Default value: 100

Example: 300

Max pool size

Integer/Expression
Required. Specify the maximum number of connections a pool will maintain at a time.

Default value: 50

Example: 90

Max lifetime (minutes)

Integer/Expression
Required. Specify the maximum lifetime (in minutes) of a connection in the pool. Ensure that the value you enter is a few seconds shorter than any database or infrastructure-imposed connection time limit. A value of 0 indicates an infinite lifetime, subject to the Idle Timeout value. An in-use connection is never retired. Connections are removed only after they are closed.

Default value: 30

Idle timeout (minutes)

Integer/Expression
Required. Specify the maximum amount of time (in minutes) a connection is allowed to sit idle in the pool. A value of 0 indicates that idle connections are never removed from the pool.

Default value: 5

Checkout timeout (milliseconds)

Integer/Expression
Required. Specify the timeout (in milliseconds) to wait for a connection to be available when the pool is exhausted. Zero waits forever. An exception will be thrown after the wait time has expired.
Note: If you specify 0, the Snap waits infinitely until the connection is available. Therefore, we recommend you not to specify 0 for Checkout Timeout.

Default value: 10000

URL properties

Fieldset
Use this field set to set additional URL properties if any.
URL property name

String/Expression
URL property name.

Default value: N/A

Example: Example corp

URL property value

String/Expression
URL property value.

Default value: N/A

Example: https://www.example.com

Note: Click Validate after entering the required details to ensure that all fields have been filled accurately. Click Apply to save the settings.