Azure Synapse¶
The Azure Synapse connector is a Palantir-provided driver for Azure Synapse.
To create a new Azure Synapse source, follow the standard setup flow for Palantir-provided drivers, then use the sections below for Azure Synapse-specific configuration and networking. For the complete property reference, see the official Azure Synapse driver documentation ↗.
Configuration¶
The properties below are mandatory or recommended.
| Property | Required? | Description | Default |
|---|---|---|---|
AuthScheme ↗ |
Mandatory | The scheme used for authentication. Accepted entries are Password, AzureAD, AzureServicePrincipal, AzureServicePrincipalCert, AzureMSI, AzurePassword. | Password |
Database ↗ |
Mandatory | The name of the Synapse database. | — |
Encrypt ↗ |
Mandatory | This field sets whether SSL is enabled and whether the 'Strict' encryption type is used. | TRUE |
Server ↗ |
Mandatory | The name of the server running Synapse. | {serverAddress} |
InitiateOAuth ↗ |
Recommended | Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. | REFRESH |
OAuthClientId ↗ |
Recommended | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. | — |
OAuthClientSecret ↗ |
Recommended | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. | — |
Password ↗ |
Recommended | Specifies the password of the authenticating user account. | — |
Port ↗ |
Recommended | The port of the Synapse. | 1433 |
User ↗ |
Recommended | Specifies the user ID of the authenticating Azure Synapse user account. | — |
Networking¶
The table below lists the domains that the source needs to be able to access in order to successfully run.
For each domain, add a corresponding egress policy. If the source is hosted on-premises and not directly reachable from Foundry, use an agent proxy egress policy instead; the agent host itself must also be able to reach the listed domains. See using an agent as a proxy for details.
| Domain | Required |
|---|---|
| \ |
Always. Server and Port connection properties (default Port=1433) |
| \ |
Used for staging data in COPY mode |
| login.microsoftonline.com | If AuthScheme=AzureAD, AzureServicePrincipal, AzureServicePrincipalCert, AzurePassword AND AzureEnvironment=GLOBAL (default) |
| login.chinacloudapi.cn | If AuthScheme=AzureAD, AzureServicePrincipal , AzureServicePrincipalCert, AzurePassword AND AzureEnvironment=CHINA |
| login.microsoftonline.us | If AuthScheme=AzureAD, AzureServicePrincipal, AzureServicePrincipalCert, AzurePassword AND AzureEnvironment=USGOVT or USGOVTDOD |
中文翻译¶
Azure Synapse¶
Azure Synapse 连接器是 Palantir 提供的用于 Azure Synapse 的驱动程序（Palantir-provided driver）。
要创建新的 Azure Synapse 数据源，请遵循 Palantir 提供驱动程序的标准设置流程（standard setup flow），然后使用以下各节进行 Azure Synapse 特定的配置和网络设置。有关完整的属性参考，请参阅官方 Azure Synapse 驱动程序文档（official Azure Synapse driver documentation）。
配置（Configuration）¶
以下属性为必填或推荐项。
| 属性（Property） | 是否必填 | 描述（Description） | 默认值（Default） |
|---|---|---|---|
AuthScheme ↗ |
必填 | 用于身份验证的方案。可接受的条目为：Password、AzureAD、AzureServicePrincipal、AzureServicePrincipalCert、AzureMSI、AzurePassword。 | Password |
Database ↗ |
必填 | Synapse 数据库的名称。 | — |
Encrypt ↗ |
必填 | 此字段设置是否启用 SSL 以及是否使用"严格"加密类型。 | TRUE |
Server ↗ |
必填 | 运行 Synapse 的服务器名称。 | {serverAddress} |
InitiateOAuth ↗ |
推荐 | 指定获取或刷新 OAuth 访问令牌的过程，该令牌用于在已验证授权的用户工作时维持其访问权限。 | REFRESH |
OAuthClientId ↗ |
推荐 | 指定分配给自定义 OAuth 应用程序的客户端 ID（也称为消费者密钥）。此 ID 用于在身份验证过程中向 OAuth 授权服务器标识应用程序。 | — |
OAuthClientSecret ↗ |
推荐 | 指定分配给自定义 OAuth 应用程序的客户端密钥。此机密值用于向 OAuth 授权服务器验证应用程序的身份。 | — |
Password ↗ |
推荐 | 指定进行身份验证的用户账户的密码。 | — |
Port ↗ |
推荐 | Synapse 的端口。 | 1433 |
User ↗ |
推荐 | 指定进行身份验证的 Azure Synapse 用户账户的用户 ID。 | — |
网络设置（Networking）¶
下表列出了数据源为成功运行而需要能够访问的域名。
对于每个域名，请添加相应的出站策略（egress policy）。如果数据源托管在本地且无法直接从 Foundry 访问，请改用代理出站策略（agent proxy egress policy）；代理主机本身也必须能够访问所列出的域名。有关详细信息，请参阅使用代理作为代理（using an agent as a proxy）。
| 域名（Domain） | 是否必需 |
|---|---|
| \ |
始终必需。服务器和端口连接属性（默认 Port=1433） |
| \ |
用于在 COPY 模式下暂存数据 |
| login.microsoftonline.com | 如果 AuthScheme=AzureAD、AzureServicePrincipal、AzureServicePrincipalCert、AzurePassword 且 AzureEnvironment=GLOBAL（默认） |
| login.chinacloudapi.cn | 如果 AuthScheme=AzureAD、AzureServicePrincipal、AzureServicePrincipalCert、AzurePassword 且 AzureEnvironment=CHINA |
| login.microsoftonline.us | 如果 AuthScheme=AzureAD、AzureServicePrincipal、AzureServicePrincipalCert、AzurePassword 且 AzureEnvironment=USGOVT 或 USGOVTDOD |