Azure Data Catalog¶
The Azure Data Catalog connector is a Palantir-provided driver for Azure Data Catalog.
To create a new Azure Data Catalog source, follow the standard setup flow for Palantir-provided drivers, then use the sections below for Azure Data Catalog-specific configuration and networking. For the complete property reference, see the official Azure Data Catalog driver documentation ↗.
Configuration¶
The properties below are mandatory or recommended.
| Property | Required? | Description | Default |
|---|---|---|---|
AuthScheme ↗ |
Recommended | Specifies the type of authentication to use when connecting to Azure Data Catalog. If this property is left blank, the default authentication is used. | AzureServicePrincipal |
AzureTenant ↗ |
Recommended | Identifies the Azure Data Catalog tenant being used to access data, either by name (for example, contoso.onmicrosoft.com) or ID. (Conditional). | — |
CatalogName ↗ |
Recommended | The name of the catalog to connect to. | defaultcatalog |
InitiateOAuth ↗ |
Recommended | Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. | GETANDREFRESH |
OAuthClientId ↗ |
Recommended | Specifies the client Id that was assigned when the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server. | — |
OAuthClientSecret ↗ |
Recommended | Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret). This secret registers the custom application with the OAuth authorization server. | — |
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 |
|---|---|
| api.azuredatacatalog.com | Always |
| datacatalog.azure.com | Always |
| login.microsoftonline.com | If AuthScheme=AzureAD (default), AzureServicePrincipal, AzureServicePrincipalCert AND AzureEnvironment=GLOBAL (default) |
| login.chinacloudapi.cn | If AuthScheme=AzureAD (default), AzureServicePrincipal , AzureServicePrincipalCert AND AzureEnvironment=CHINA |
| login.microsoftonline.us | If AuthScheme=AzureAD (default), AzureServicePrincipal, AzureServicePrincipalCert AND AzureEnvironment=USGOVT or USGOVTDOD |
中文翻译¶
# Azure Data Catalog
<!-- BEGIN GENERATED:intro -->
Azure Data Catalog 连接器是一个由 Palantir 提供的驱动程序(Palantir-provided driver)，用于连接 Azure Data Catalog。
要创建新的 Azure Data Catalog 数据源，请遵循 [Palantir 提供驱动程序的标准设置流程](https://palantir.com/docs/foundry/data-integration/foundry-provided-drivers/#setup)，然后使用以下各节进行 Azure Data Catalog 特定的配置和网络设置。有关完整的属性参考，请参阅 [Azure Data Catalog 驱动程序官方文档 ↗](https://cdn.cdata.com/help/GNK/jdbc/pg_connectionj.htm)。
<!-- END GENERATED:intro -->
<!-- BEGIN GENERATED:configuration -->
## 配置
以下属性为必填或推荐项。
| 属性 | 是否必填 | 描述 | 默认值 |
|---|---|---|---|
| [`AuthScheme` ↗](https://cdn.cdata.com/help/GNK/jdbc/RSBAzureDataCatalog_p_AuthScheme.htm) | 推荐 | 指定连接到 Azure Data Catalog 时使用的身份验证类型。如果此属性留空，则使用默认身份验证。 | `AzureServicePrincipal` |
| [`AzureTenant` ↗](https://cdn.cdata.com/help/GNK/jdbc/RSBAzureDataCatalog_p_AzureTenant.htm) | 推荐 | 标识用于访问数据的 Azure Data Catalog 租户，可通过名称（例如 contoso.onmicrosoft.com）或 ID 指定。（条件性） | — |
| [`CatalogName` ↗](https://cdn.cdata.com/help/GNK/jdbc/RSBAzureDataCatalog_p_CatalogName.htm) | 推荐 | 要连接的目录名称。 | `defaultcatalog` |
| [`InitiateOAuth` ↗](https://cdn.cdata.com/help/GNK/jdbc/RSBAzureDataCatalog_p_InitiateOAuth.htm) | 推荐 | 指定获取或刷新 OAuth 访问令牌的过程，该令牌用于在已认证的授权用户工作时维持其访问权限。 | `GETANDREFRESH` |
| [`OAuthClientId` ↗](https://cdn.cdata.com/help/GNK/jdbc/RSBAzureDataCatalog_p_OAuthClientId.htm) | 推荐 | 指定创建自定义 OAuth 应用程序时分配的客户端 ID（也称为消费者密钥）。此 ID 用于在 OAuth 授权服务器上注册自定义应用程序。 | — |
| [`OAuthClientSecret` ↗](https://cdn.cdata.com/help/GNK/jdbc/RSBAzureDataCatalog_p_OAuthClientSecret.htm) | 推荐 | 指定创建自定义 OAuth 应用程序时分配的客户端密钥（也称为消费者密钥）。此密钥用于在 OAuth 授权服务器上注册自定义应用程序。 | — |
<!-- END GENERATED:configuration -->
<!-- BEGIN GENERATED:networking -->
## 网络配置
下表列出了数据源为成功运行而需要能够访问的域名。
对于每个域名，请添加相应的[出站策略(egress policy)](https://palantir.com/docs/foundry/administration/configure-egress/)。如果数据源部署在本地且无法从 Foundry 直接访问，请改用[代理出站策略(agent proxy egress policy)](https://palantir.com/docs/foundry/administration/configure-egress/#agent-proxy-egress-policies)；代理主机本身也必须能够访问所列出的域名。有关详细信息，请参阅[使用代理作为代理服务器](https://palantir.com/docs/foundry/data-connection/agent-proxy/)。
| 域名 | 必需条件 |
|--- |--- |
| api.azuredatacatalog.com | 始终需要 |
| datacatalog.azure.com | 始终需要 |
| login.microsoftonline.com | 如果 `AuthScheme=AzureAD`（默认）、AzureServicePrincipal、AzureServicePrincipalCert 且 `AzureEnvironment=GLOBAL`（默认） |
| login.chinacloudapi.cn | 如果 `AuthScheme=AzureAD`（默认）、AzureServicePrincipal、AzureServicePrincipalCert 且 `AzureEnvironment=CHINA` |
| login.microsoftonline.us | 如果 `AuthScheme=AzureAD`（默认）、AzureServicePrincipal、AzureServicePrincipalCert 且 `AzureEnvironment=USGOVT` 或 USGOVTDOD |
<!-- END GENERATED:networking -->