Azure Synapse SQL Entra Account
In this article
Overview
You can use this account type to connect Azure Synapse SQL Snaps with data sources that use Azure Synapse SQL Entra account.
Prerequisites
None.
Limitations and Known Issues
None.
Account Settings
Asterisk ( * ): Indicates a mandatory field.
Suggestion icon ( ): Indicates a list that is dynamically populated based on the configuration.
Expression icon ( ): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
Add icon ( ): Indicates that you can add fields in the field set.
Remove icon ( ): Indicates that you can remove fields from the field set.
Field Name | Field Type | Field Dependency | Description | |
---|---|---|---|---|
Label*
Default Value: N/A | String | N/A | Specify a unique label for the account.
| |
Account properties* | ||||
Hostname* Default Value: N/A | String/Expression | N/A | Specify the server's address to which you need to connect. | |
Port number*
| Integer/Expression | N/A | Specify the port number of the database server to which you need to connect. | |
Database name*
| String/Expression | N/A | Specify the name of the database to which you need to connect. | |
Username
| String/Expression | N/A | Specify the username that is allowed to connect to the database. | |
Password
| String/Expression | N/A | Specify the password used to connect to the data source. | |
JDBC JARs | Use this field set to specify the JDBC JAR files to be loaded. Add each JAR file in a separate row. | |||
JDBC driver Default Value: N/A | String | N/A | Specify the driver to use for your application. By default, the latest JDBC driver 12.2.0.jre11 is bundled with the Azure Synapse SQL Account. However, you can manually upload a custom JAR file. | |
JBDC driver class* Default Value: com.microsoft.sqlserver.jdbc.SQLServerDriver | String | N/A | Specify the fully qualified name of the driver class to be used for connecting to the server.
| |
Trust all certificates Default Value: Deselected | Checkbox | N/A | Select this checkbox if all SSL certificates are to be accepted for connecting to the database. | |
External location
| Dropdown list | N/A | Select one of the following options to set the external location for staging data:
| |
External storage endpoint
Default Value: N/A | String/Expression | Appears on selecting Blob Storage or Azure Data Lake Gen2 for External location. | Specify the endpoint path for the selected external location.
| |
Storage Account
| String/Expression | Appears on selecting Blob Storage or Azure Data Lake Gen2 for External location. | Specify your Account name to access the selected Azure external storage location.
| |
Azure container
| String/Expression | Appears on selecting Blob Storage or Azure Data Lake Gen2 for External location. | Specify the name of the container in the Azure storage account.
| |
Azure folder
| String/Expression | Appears on selecting Blob Storage or Azure Data Lake Gen2 for External location. | Specify the relative path for the folder within the container specified above. Leave this field blank to use all the folders in the specified container.
| |
Azure auth type
| Dropdown list | Appears on selecting Blob Storage or Azure Data Lake Gen2 for External location. | Select the authentication type to use for accessing the selected Azure external storage location. Then, provide the values for Azure Identify and Azure Secret fields or the selected authentication type. Available options are:
Learn more about authentication types: COPY INTO (Transact-SQL) in Microsoft Docs. | |
Azure identity
| String/Expression | Appears on selecting Blob Storage or Azure Data Lake Gen2 for External location. | Specify the Azure Identity to access the selected external storage location.
The minimum RBAC roles required are Storage blob data contributor or Storage blob data owner for the AAD registered SQL Database server. | |
Azure secret
| String/Expression | Appears on selecting Blob Storage or Azure Data Lake Gen2 for External location. | Specify the Azure Secret corresponding to the selected authentication type.
Learn more about the expected values for this field.: COPY INTO (Transact-SQL) in Microsoft Docs. | |
Enable error file support Default Value: Deselected | Checkbox | N/A | Select this checkbox to specify the directory within the COPY statement where the rejected rows and the corresponding error file should be written. The error file only applies to CSV file formats. | |
Error file Azure folder | String/Expression | Appears when you select Error file Azure folder. | Specify a valid path to a folder in the Azure container. You can specify the full path from the storage. | |
Use new Azure account for error file Default Value: Deselected | Checkbox | Appears when you select Error file Azure folder. | Select this checkbox if you need to configure a new account. | |
Error file external location
Default Value: Blob Storage | Dropdown list | Appears when you select Use new Azure account for error file. | Choose either of the following external locations where the files containing the data is staged:
| |
External storage endpoint Default Value: N/A
| String/Expression | Appears when you select Use new Azure account for error file. | Specify the endpoint in your external location path. | |
Error file storage account Default Value: N/A | String/Expression | Appears when you select Use new Azure account for error file. | Specify a valid Azure | |
Error file Azure container Default Value: N/A | String/Expression | Appears when you select Use new Azure account for error file. | Specify a valid Azure Container to use for staging data. | |
Error file Azure auth type Default Value: Access Key | Dropdown list | Appears when you select Use new Azure account for error file. | Choose the athorization type to access the error file in Azure Synapse:
| |
Error file Azure identity Default Value: N/A | String/Expression | Appears when you select Use new Azure account for error file. | Specify the Azure Identity that is part of the credential that specifies the authentication mechanism to access the external storage account. | |
Error file Azure secret Default Value: N/A | String/Expression | Appears when you select Use new Azure account for error file. | Secret is part of the credential that specifies the authentication mechanism to access the external storage account | |
Advanced properties | ||||
Auto commit
| Checkbox/Expression | N/A | Select this checkbox to commit each batch 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 execution output only after the execution of all batches is complete. 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. | |
Batch size* Default Value: 50 | Integer/Expression | N/A | Specify the number of statements to execute at a time. | |
Fetch size*
| Integer/Expression | N/A | Specify the number of rows to fetch at a time when executing a query.
| |
Max pool size*
| Integer/Expression | N/A | Specify the maximum number of connections a pool must maintain at a time.
| |
Max lifetime (minutes)*
| Integer/Expression | N/A | Specify the maximum lifetime (in minutes) of a connection in the pool.
| |
Idle timeout (minutes)*
| Integer/Expression | N/A | Specify the maximum time period (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.
| |
Checkout timeout (milliseconds)*
| Integer/Expression | N/A | Specify the timeout (in milliseconds) to wait for a connection to be available when the pool is exhausted. A value of zero waits infinitely—an exception is thrown after the wait time has expired. | |
URL properties | Use this field set to define additonal URL properties to use if any. | |||
URL property name | String/Expression | N/A | Specify a name for the URL property if any. | |
URL property value | String/Expression | N/A | Specify a value for the URL property name. |
Snap Pack History
Related Content
Have feedback? Email documentation@snaplogic.com | Ask a question in the SnapLogic Community
© 2017-2024 SnapLogic, Inc.