Azure Data Catalog Connection Details¶

Introduction¶

Connector Version

This documentation is based on version 23.0.8803 of the connector.

Get Started¶

Azure Data Catalog Version Support

The connector leverages version 2016-03-30 of the Azure Data Catalog API to enable read access to Azure Data Catalog.

Establish a Connection¶

Connect to Azure Data Catalog¶

You can optionally set the following to read the different catalog data returned from Azure Data Catalog.

• CatalogName: Set this to the catalog name associated with your Azure Data Catalog. If left blank, the default catalogis is used.

  To get your catalog name, navigate to the Azure Portal home page > Data Catalog > Catalog Name

Authenticate to Azure Data Catalog¶

Azure AD¶

Azure AD is Microsoft’s multi-tenant, cloud-based directory and identity management service. It is user-based authentication that requires that you set AuthScheme to AzureAD.

Desktop Applications¶

provides an embedded OAuth application that simplifies authentication at the desktop.

Before you connect, set the following variables:

• InitiateOAuth: GETANDREFRESH. Used to automatically get and refresh the OAuthAccessToken. provides an embedded OAuth application that simplifies authentication at the desktop; that is, in situations where the user is using a local server not connected to the internet.

  You can also authenticate from the desktop via a custom OAuth application, which you configure and register at the Azure Data Catalog console. For further information, see Creating a Custom OAuth Application.

• Custom Azure AD applications only:

  • OAuthClientId: The client ID assigned when you registered your custom OAuth application.
  • OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.
  • CallbackURL: The redirect URI defined when you registered your custom OAuth application.

When you connect, the connector opens the Azure Data Catalog's OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:

1. Extracts the access token from the callback URL and authenticates requests.
2. Obtains a new access token when the old one expires.
3. Saves OAuth values in OAuthSettingsLocation. These values persist across connections.

When the access token expires, the connector refreshes it automatically.

Azure Service Principal¶

Azure Service Principal is role-based application-based authentication. This means that authentication is done per application, rather than per user. All tasks taken on by the application are executed without a default user context, but based on the assigned roles. The application access to the resources is controlled through the assigned roles' permissions.

For information about how to set up Azure Service Principal authentication, see

Create a Custom OAuth Application¶

Azure Data Catalog supports authentication using Azure AD and Azure Service Principal, both of which are OAuth-based.

This topic describes how to:

• create and register custom OAuth application for Azure AD or Azure Service Principal
• provide Admin Consent to a custom OAuth application
• create a custom OAuth application for use with client credentials

Azure AD¶

In portal.azure.com:

1. Log in to https://portal.azure.com.
2. In the left-hand navigation pane, select Azure Active Directory, then applicationRegistrations.
3. Click New registration.
4. Enter a name for the application.
5. Select the desired tenant setup: single- or multi-tenant, and public or private use.
   • If you select the default option, "Accounts in this organizational directory only", you must set the AzureTenant connection property to the ID of the Azure AD Tenant when establishing a connection with the Azure Data Catalog connector. Otherwise, the authentication attempt fails with an error.
   • If your application is for private use only, specify Accounts in this organization directory only.
   • If you want to distribute your application, choose one of the multi-tenant options.
6. Set the redirect URL to http://localhost:33333 (the connector's default) OR specify a different port and set CallbackURL to the exact reply URL you defined.
7. Click Register to register the new application. An application management screen displays.
   Note the value in Application (client) ID as the OAuthClientId and the Directory (tenant) ID as the AzureTenant.
8. Navigate to Certificates & Secrets and define the application authentication type. There are two types of authentication available: certificate (recommended) or client secret.
   • For certificate authentication: In Certificates & Secrets, select Upload certificate, then upload the certificate from your local machine.
   • For creating a new client secret: In Certificates & Secrets, select New Client Secret for the application and specify its duration. After the client secret is saved, Azure Data Catalog displays the key value. Copy this value, as it is displayed only once. This value becomes the OAuthClientSecret.
9. Select API Permissions > Add > Delegated permissions.
10. Select Azure Data Catalog > Delegated Permissions > user_impersonation.
11. Save your changes.
12. If you have specified the use of permissions that require admin consent (such as the Application Permissions), you can grant them from the current tenant on the API Permissions page.

Azure Service Principal¶

To use Azure Service Principal authentication, you must set up the ability to assign a role to the authentication application, then register an application with the Azure AD tenant to create a new Service Principal. That new Service Principal can then leverage the assigned role-based access

control to access resources in your subscription.

In portal.azure.com:

1. Create a custom OAuth AD application, as described above.
2. Use the search bar to search for the Subscriptions service.
3. Open the Subscriptions page.
4. Select the subscription to which to assign the application.
5. Open the Access control (IAM).
6. Select Add > Add role assignment. Azure Data Catalog opens the Add role assignment page.
7. Assign your custom Azure AD application the role of Owner.

Admin Consent¶

Some custom applications require administrative permissions to operate within an Azure Active Directory tenant. Admin consent can be granted when creating a new custom OAuth application, by adding relevant permissions that are already marked with "Admin Consent Required". Admin consent is also required to use Client Credentials in the OAuth flow.

To grant admin consent:

1. Have an admin log in to portal.azure.com.
2. Navigate to App Registrations and find the custom OAuth application you created.
3. Under API Permissions, click Grant Consent.

This gives your application permissions on the tenant under which it was created.

Consent for Client Credentials¶

OAuth supports the use of client credentials to authenticate. In a client credentials OAuth flow, credentials are created for the authenticating application itself. The auth flow acts just like the usual auth flow except that there is no prompt for an associated user to provide credentials.

All tasks accepted by the application are executed outside of the context of a default user.

use them in a client OAuth flow. You must always create a custom OAuth application to use client credentials.

In portal.azure.com:

1. Create a custom OAuth application, as described above.
2. Navigate to App Registrations.
3. Find the application you just created, and open API Permissions.
4. Select the Microsoft Graph permissions. There are two distinct sets of permissions: Delegated and Application.
5. Under Application Permissions, select the permissions you require for your integration.

.

Managed Service Identity (MSI)¶

If you are running Azure Data Catalog on an Azure VM and want to leverage MSI to connect, set AuthScheme to AzureMSI.

User-Managed Identities¶

To obtain a token for a managed identity, use the OAuthClientId property to specify the managed identity's "client_id".

When your VM has multiple user-assigned managed identities, you must also specify OAuthClientId.

Use Azure Service Principal¶

Azure Service Principal¶

Azure Service Principal is role-based application-based authentication. This means that authentication is done per application, rather than per user. All tasks taken by the app are done without a default user context, but based on the assigned roles. The application access to the resources is controlled through the assigned roles' permissions.

To use Azure Service Principal authentication, you must:

• Set up the ability to assign a role to the authentication application. To do this, create a custom OAuth AD application, as described in

  Creating a Custom OAuth Application¶

  Azure Data Catalog supports authentication using Azure AD and Azure Service Principal, both of which are OAuth-based.

  This topic describes how to:

  • create and register custom OAuth application for Azure AD or Azure Service Principal
  • provide Admin Consent to a custom OAuth application
  • create a custom OAuth application for use with client credentials

  Azure AD¶

  In portal.azure.com:

  1. Log in to https://portal.azure.com.
  2. In the left-hand navigation pane, select Azure Active Directory, then applicationRegistrations.
  3. Click New registration.
  4. Enter a name for the application.
  5. Select the desired tenant setup: single- or multi-tenant, and public or private use.
     • If you select the default option, "Accounts in this organizational directory only", you must set the AzureTenant connection property to the ID of the Azure AD Tenant when establishing a connection with the Azure Data Catalog connector. Otherwise, the authentication attempt fails with an error.
     • If your application is for private use only, specify Accounts in this organization directory only.
     • If you want to distribute your application, choose one of the multi-tenant options.
  6. Set the redirect URL to http://localhost:33333 (the connector's default) OR specify a different port and set CallbackURL to the exact reply URL you defined.
  7. Click Register to register the new application. An application management screen displays.
     Note the value in Application (client) ID as the OAuthClientId and the Directory (tenant) ID as the AzureTenant.
  8. Navigate to Certificates & Secrets and define the application authentication type. There are two types of authentication available: certificate (recommended) or client secret.
     • For certificate authentication: In Certificates & Secrets, select Upload certificate, then upload the certificate from your local machine.
     • For creating a new client secret: In Certificates & Secrets, select New Client Secret for the application and specify its duration. After the client secret is saved, Azure Data Catalog displays the key value. Copy this value, as it is displayed only once. This value becomes the OAuthClientSecret.
  9. Select API Permissions > Add > Delegated permissions.
  10. Select Azure Data Catalog > Delegated Permissions > user_impersonation.
  11. Save your changes.
  12. If you have specified the use of permissions that require admin consent (such as the Application Permissions), you can grant them from the current tenant on the API Permissions page.

  Azure Service Principal¶

  To use Azure Service Principal authentication, you must set up the ability to assign a role to the authentication application, then register an application with the Azure AD tenant to create a new Service Principal. That new Service Principal can then leverage the assigned role-based access

  control to access resources in your subscription.

  In portal.azure.com:

  1. Create a custom OAuth AD application, as described above.
  2. Use the search bar to search for the Subscriptions service.
  3. Open the Subscriptions page.
  4. Select the subscription to which to assign the application.
  5. Open the Access control (IAM).
  6. Select Add > Add role assignment. Azure Data Catalog opens the Add role assignment page.
  7. Assign your custom Azure AD application the role of Owner.

  Admin Consent¶

  Some custom applications require administrative permissions to operate within an Azure Active Directory tenant. Admin consent can be granted when creating a new custom OAuth application, by adding relevant permissions that are already marked with "Admin Consent Required". Admin consent is also required to use Client Credentials in the OAuth flow.

  To grant admin consent:

  1. Have an admin log in to portal.azure.com.
  2. Navigate to App Registrations and find the custom OAuth application you created.
  3. Under API Permissions, click Grant Consent.

  This gives your application permissions on the tenant under which it was created.

  Consent for Client Credentials¶

  OAuth supports the use of client credentials to authenticate. In a client credentials OAuth flow, credentials are created for the authenticating application itself. The auth flow acts just like the usual auth flow except that there is no prompt for an associated user to provide credentials.

  All tasks accepted by the application are executed outside of the context of a default user.

• Register an application with an Azure AD tenant, to create a new service principal that can be used with the role-based access control, to access resources in your subscription.

Do the following:

1. Create a custom Azure AD application, as described in

   Creating a Custom OAuth Application¶

   Azure Data Catalog supports authentication using Azure AD and Azure Service Principal, both of which are OAuth-based.

   This topic describes how to:

   • create and register custom OAuth application for Azure AD or Azure Service Principal
   • provide Admin Consent to a custom OAuth application
   • create a custom OAuth application for use with client credentials

   Azure AD¶

   In portal.azure.com:

   1. Log in to https://portal.azure.com.
   2. In the left-hand navigation pane, select Azure Active Directory, then applicationRegistrations.
   3. Click New registration.
   4. Enter a name for the application.
   5. Select the desired tenant setup: single- or multi-tenant, and public or private use.
      • If you select the default option, "Accounts in this organizational directory only", you must set the AzureTenant connection property to the ID of the Azure AD Tenant when establishing a connection with the Azure Data Catalog connector. Otherwise, the authentication attempt fails with an error.
      • If your application is for private use only, specify Accounts in this organization directory only.
      • If you want to distribute your application, choose one of the multi-tenant options.
   6. Set the redirect URL to http://localhost:33333 (the connector's default) OR specify a different port and set CallbackURL to the exact reply URL you defined.
   7. Click Register to register the new application. An application management screen displays.
      Note the value in Application (client) ID as the OAuthClientId and the Directory (tenant) ID as the AzureTenant.
   8. Navigate to Certificates & Secrets and define the application authentication type. There are two types of authentication available: certificate (recommended) or client secret.
      • For certificate authentication: In Certificates & Secrets, select Upload certificate, then upload the certificate from your local machine.
      • For creating a new client secret: In Certificates & Secrets, select New Client Secret for the application and specify its duration. After the client secret is saved, Azure Data Catalog displays the key value. Copy this value, as it is displayed only once. This value becomes the OAuthClientSecret.
   9. Select API Permissions > Add > Delegated permissions.
   10. Select Azure Data Catalog > Delegated Permissions > user_impersonation.
   11. Save your changes.
   12. If you have specified the use of permissions that require admin consent (such as the Application Permissions), you can grant them from the current tenant on the API Permissions page.

   Azure Service Principal¶

   To use Azure Service Principal authentication, you must set up the ability to assign a role to the authentication application, then register an application with the Azure AD tenant to create a new Service Principal. That new Service Principal can then leverage the assigned role-based access

   control to access resources in your subscription.

   In portal.azure.com:

   1. Create a custom OAuth AD application, as described above.
   2. Use the search bar to search for the Subscriptions service.
   3. Open the Subscriptions page.
   4. Select the subscription to which to assign the application.
   5. Open the Access control (IAM).
   6. Select Add > Add role assignment. Azure Data Catalog opens the Add role assignment page.
   7. Assign your custom Azure AD application the role of Owner.

   Admin Consent¶

   Some custom applications require administrative permissions to operate within an Azure Active Directory tenant. Admin consent can be granted when creating a new custom OAuth application, by adding relevant permissions that are already marked with "Admin Consent Required". Admin consent is also required to use Client Credentials in the OAuth flow.

   To grant admin consent:

   1. Have an admin log in to portal.azure.com.
   2. Navigate to App Registrations and find the custom OAuth application you created.
   3. Under API Permissions, click Grant Consent.

   This gives your application permissions on the tenant under which it was created.

   Consent for Client Credentials¶

   OAuth supports the use of client credentials to authenticate. In a client credentials OAuth flow, credentials are created for the authenticating application itself. The auth flow acts just like the usual auth flow except that there is no prompt for an associated user to provide credentials.

   All tasks accepted by the application are executed outside of the context of a default user.

1. Assign a role to the application:
   1. Use the search bar to search for the Subscriptions service.
   2. Open the Subscriptions page.
   3. Select the subscription to which to assign the application.
   4. Open the Access control (IAM).
   5. Select Add > Add role assignment. Azure Data Catalog opens the Add role assignment page.
   6. Assign your custom Azure AD application the role of Owner.

Admin Consent¶

Admin consent occurs when the Admin for an Azure Active Directory tenant grants permissions to a custom application that explicitly requires an admin to consent to the use case.

When creating a new Azure AD application in the Azure Portal, you must specify which permissions the application requires. Some permissions may be marked as "Admin Consent Required". For example, all Groups permissions require Admin Consent. If your application requires admin consent, there are two ways you can do this.

The easiest way to grant admin consent is to have an admin log into portal.azure.com and navigate to the application you have created in App Registrations. Under API Permissions, click Grant Consent. This gives your application permissions on the tenant under which it was created.

If your organization has multiple tenants or you must grant application permissions for other tenants outside your organization, use the GetAdminConsentURL stored procedure to generate the Admin Authorization URL. Unlike the GetOAuthAuthorizationURL stored procedure, no important information is returned from this endpoint. Rather, after the OAuth application is successfully authorized, it returns a Boolean indicating that permissions have been granted.

After the administrator has approved the OAuth Application, you can continue to authenticate.

Client Credentials¶

Client credentials refers to a flow in OAuth where there is no direct user authentication taking place. Instead, credentials are created for just the application itself. All tasks taken by the application are done without a default user context. This makes the authentication flow a bit different from the standard flow.

All permissions related to the client OAuth flow require admin consent. This means you cannot use the application embedded with the Azure Data Catalog connector in the client OAuth flow. You must create your own OAuth application to use client credentials. See

Create a Custom OAuth Application¶

Azure Data Catalog supports authentication using Azure AD and Azure Service Principal, both of which are OAuth-based.

This topic describes how to:

• create and register custom OAuth application for Azure AD or Azure Service Principal
• provide Admin Consent to a custom OAuth application
• create a custom OAuth application for use with client credentials

Azure AD¶

In portal.azure.com:

1. Log in to https://portal.azure.com.
2. In the left-hand navigation pane, select Azure Active Directory, then applicationRegistrations.
3. Click New registration.
4. Enter a name for the application.
5. Select the desired tenant setup: single- or multi-tenant, and public or private use.
   • If you select the default option, "Accounts in this organizational directory only", you must set the AzureTenant connection property to the ID of the Azure AD Tenant when establishing a connection with the Azure Data Catalog connector. Otherwise, the authentication attempt fails with an error.
   • If your application is for private use only, specify Accounts in this organization directory only.
   • If you want to distribute your application, choose one of the multi-tenant options.
6. Set the redirect URL to http://localhost:33333 (the connector's default) OR specify a different port and set CallbackURL to the exact reply URL you defined.
7. Click Register to register the new application. An application management screen displays.
   Note the value in Application (client) ID as the OAuthClientId and the Directory (tenant) ID as the AzureTenant.
8. Navigate to Certificates & Secrets and define the application authentication type. There are two types of authentication available: certificate (recommended) or client secret.
   • For certificate authentication: In Certificates & Secrets, select Upload certificate, then upload the certificate from your local machine.
   • For creating a new client secret: In Certificates & Secrets, select New Client Secret for the application and specify its duration. After the client secret is saved, Azure Data Catalog displays the key value. Copy this value, as it is displayed only once. This value becomes the OAuthClientSecret.
9. Select API Permissions > Add > Delegated permissions.
10. Select Azure Data Catalog > Delegated Permissions > user_impersonation.
11. Save your changes.
12. If you have specified the use of permissions that require admin consent (such as the Application Permissions), you can grant them from the current tenant on the API Permissions page.

Azure Service Principal¶

To use Azure Service Principal authentication, you must set up the ability to assign a role to the authentication application, then register an application with the Azure AD tenant to create a new Service Principal. That new Service Principal can then leverage the assigned role-based access

control to access resources in your subscription.

In portal.azure.com:

1. Create a custom OAuth AD application, as described above.
2. Use the search bar to search for the Subscriptions service.
3. Open the Subscriptions page.
4. Select the subscription to which to assign the application.
5. Open the Access control (IAM).
6. Select Add > Add role assignment. Azure Data Catalog opens the Add role assignment page.
7. Assign your custom Azure AD application the role of Owner.

Admin Consent¶

Some custom applications require administrative permissions to operate within an Azure Active Directory tenant. Admin consent can be granted when creating a new custom OAuth application, by adding relevant permissions that are already marked with "Admin Consent Required". Admin consent is also required to use Client Credentials in the OAuth flow.

To grant admin consent:

1. Have an admin log in to portal.azure.com.
2. Navigate to App Registrations and find the custom OAuth application you created.
3. Under API Permissions, click Grant Consent.

This gives your application permissions on the tenant under which it was created.

Consent for Client Credentials¶

OAuth supports the use of client credentials to authenticate. In a client credentials OAuth flow, credentials are created for the authenticating application itself. The auth flow acts just like the usual auth flow except that there is no prompt for an associated user to provide credentials.

All tasks accepted by the application are executed outside of the context of a default user.

use them in a client OAuth flow. You must always create a custom OAuth application to use client credentials.

In portal.azure.com:

1. Create a custom OAuth application, as described above.
2. Navigate to App Registrations.
3. Find the application you just created, and open API Permissions.
4. Select the Microsoft Graph permissions. There are two distinct sets of permissions: Delegated and Application.
5. Under Application Permissions, select the permissions you require for your integration.

for more information.

In your App Registration in portal.azure.com, navigate to API Permissions and select the Microsoft Graph permissions. There are two distinct sets of permissions: Delegated permissions and Application permissions. The permissions used during client credential authentication are under "Application Permissions".

Select the permissions you require for your integration. After you do this, set the following connection properties:

• AuthScheme: AzureServicePrincipal.
• InitiateOAuth: GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
• AzureTenant: The tenant you wish to connect to.
• OAuthGrantType: CLIENT.
• OAuthClientId: The client ID in your application settings.
• OAuthClientSecret: The client secret in your application settings.

Authentication with client credentials takes place automatically like any other connection, except there is no window opened prompting the user. Because there is no user context, there is no need for a browser popup. Connections will take place and be handled internally.

Create a Custom OAuth Application¶

Create a Custom OAuth Application¶

Azure Data Catalog supports authentication using Azure AD and Azure Service Principal, both of which are OAuth-based.

This topic describes how to:

• create and register custom OAuth application for Azure AD or Azure Service Principal
• provide Admin Consent to a custom OAuth application
• create a custom OAuth application for use with client credentials

Azure AD¶

In portal.azure.com:

1. Log in to https://portal.azure.com.
2. In the left-hand navigation pane, select Azure Active Directory, then applicationRegistrations.
3. Click New registration.
4. Enter a name for the application.
5. Select the desired tenant setup: single- or multi-tenant, and public or private use.
   • If you select the default option, "Accounts in this organizational directory only", you must set the AzureTenant connection property to the ID of the Azure AD Tenant when establishing a connection with the Azure Data Catalog connector. Otherwise, the authentication attempt fails with an error.
   • If your application is for private use only, specify Accounts in this organization directory only.
   • If you want to distribute your application, choose one of the multi-tenant options.
6. Set the redirect URL to http://localhost:33333 (the connector's default) OR specify a different port and set CallbackURL to the exact reply URL you defined.
7. Click Register to register the new application. An application management screen displays.
   Note the value in Application (client) ID as the OAuthClientId and the Directory (tenant) ID as the AzureTenant.
8. Navigate to Certificates & Secrets and define the application authentication type. There are two types of authentication available: certificate (recommended) or client secret.
   • For certificate authentication: In Certificates & Secrets, select Upload certificate, then upload the certificate from your local machine.
   • For creating a new client secret: In Certificates & Secrets, select New Client Secret for the application and specify its duration. After the client secret is saved, Azure Data Catalog displays the key value. Copy this value, as it is displayed only once. This value becomes the OAuthClientSecret.
9. Select API Permissions > Add > Delegated permissions.
10. Select Azure Data Catalog > Delegated Permissions > user_impersonation.
11. Save your changes.
12. If you have specified the use of permissions that require admin consent (such as the Application Permissions), you can grant them from the current tenant on the API Permissions page.

Azure Service Principal¶

To use Azure Service Principal authentication, you must set up the ability to assign a role to the authentication application, then register an application with the Azure AD tenant to create a new Service Principal. That new Service Principal can then leverage the assigned role-based access

control to access resources in your subscription.

In portal.azure.com:

1. Create a custom OAuth AD application, as described above.
2. Use the search bar to search for the Subscriptions service.
3. Open the Subscriptions page.
4. Select the subscription to which to assign the application.
5. Open the Access control (IAM).
6. Select Add > Add role assignment. Azure Data Catalog opens the Add role assignment page.
7. Assign your custom Azure AD application the role of Owner.

Admin Consent¶

Some custom applications require administrative permissions to operate within an Azure Active Directory tenant. Admin consent can be granted when creating a new custom OAuth application, by adding relevant permissions that are already marked with "Admin Consent Required". Admin consent is also required to use Client Credentials in the OAuth flow.

To grant admin consent:

1. Have an admin log in to portal.azure.com.
2. Navigate to App Registrations and find the custom OAuth application you created.
3. Under API Permissions, click Grant Consent.

This gives your application permissions on the tenant under which it was created.

Consent for Client Credentials¶

OAuth supports the use of client credentials to authenticate. In a client credentials OAuth flow, credentials are created for the authenticating application itself. The auth flow acts just like the usual auth flow except that there is no prompt for an associated user to provide credentials.

All tasks accepted by the application are executed outside of the context of a default user.

use them in a client OAuth flow. You must always create a custom OAuth application to use client credentials.

In portal.azure.com:

1. Create a custom OAuth application, as described above.
2. Navigate to App Registrations.
3. Find the application you just created, and open API Permissions.
4. Select the Microsoft Graph permissions. There are two distinct sets of permissions: Delegated and Application.
5. Under Application Permissions, select the permissions you require for your integration.

Important Notes¶

Configuration Files and Their Paths¶

• All references to adding configuration files and their paths refer to files and locations on the Harmony Agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.

Advanced Features¶

This section details a selection of advanced features of the Azure Data Catalog connector.

User Defined Views

The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Proxy

To configure the connector using Private Agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.

Query Processing

The connector offloads as much of the SELECT statement processing as possible to Azure Data Catalog and then processes the rest of the query in memory (client-side).

User Defined Views¶

The Azure Data Catalog connector allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

• Create a JSON-formatted configuration file defining the views you want.
• DDL statements.

Define Views Using a Configuration File¶

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM Tables WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Define Views Using DDL Statements¶

The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.

Create a View¶

To create a new view using DDL statements, provide the view name and query as follows:

CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;

If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews connection property.

Alter a View¶

To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:

ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

The view is then updated in the JSON configuration file.

Drop a View¶

To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.

DROP LOCAL VIEW [MyViewName]

This removes the view from the JSON configuration file. It can no longer be queried.

Schema for User Defined Views¶

User Defined Views are exposed in the UserViews schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName property.

Work with User Defined Views¶

For example, a SQL statement with a User Defined View called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

SSL Configuration¶

Customize the SSL Configuration¶

By default, the connector attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Data Model¶

Overview

This section shows the available API objects and provides more information on executing SQL to Azure Data Catalog APIs.

Key Features

• The connector models Azure Data Catalog entities like custom data sources, data assets, and data asset annotations as relational views, allowing you to write SQL to query Azure Data Catalog data.
• Live connectivity to these objects means any changes to your Azure Data Catalog account are immediately reflected when using the connector.

Views

Views describes the available views. Views are statically defined to model Custom Data Sources, Data Assets, Data Asset Annotations, and more.

Views¶

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

Azure Data Catalog Connector Views¶

ColumnDataProfiles¶

Get list of column data profiles.

Table Specific Information¶

Select¶

The connector will use the Azure Data Catalog API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: ItemId is required in order to query ColumnDataProfiles.

• ItemId supports the = operator.

For example:

SELECT * FROM ColumnDataProfiles WHERE ItemId = '8a2b7305-b474-45d6-9fba-562454045070'

Columns¶

CustomDataSourceProperties¶

Get Identity properties of Custom Data Sources.

Table Specific Information¶

Select¶

No filters are supported server side for this table. All criteria will be handled client side within the connector.

Columns¶

CustomDataSources¶

Retrieves list of custom data sources, which are registered with the catalog.

Table Specific Information¶

Select¶

No filters are supported server side for this table. All criteria will be handled client side within the connector.

Columns¶

Databases¶

Get list of databases.

Table Specific Information¶

Select¶

The connector will use the Azure Data Catalog API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• Name supports the '=, !=, <>, CONTAINS' operators.
• Timestamp supports the '=, <, <=, >, >=, CONTAINS' operators.
• LastRegisteredTime supports the '=, CONTAINS' operators.
• ObjectType supports the = operator.
• SourceType supports the = operator.
• FriendlyName supports the '=, CONTAINS' operators.
• Experts supports the '=, CONTAINS' operators.
• Description supports the '=, CONTAINS' operators.
• Tags supports the '=, !=, <>, CONTAINS' operators.
• HasTags supports the = operator.
• HasPreviews supports the = operator.
• HasDocumentation supports the = operator.
• HasTableDataProfiles supports the = operator.
• HasColumnsDataProfiles supports the = operator.
• HasDescription supports the = operator.
• View supports the = operator.
• Facets supports the = operator.

For example:

SELECT * FROM Databases WHERE HasDocumentation = false AND HasDescription = false AND HasTags = true;

SELECT * FROM Databases WHERE Timestamp > '2019-09-19T04:39:54.0083651Z'

SELECT * FROM Databases WHERE Tags = 'sales' OR Name = 'FactProductInventory'

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Descriptions¶

Get list of descriptions of databases, tables, and objects.

Table Specific Information¶

Select¶

The connector will use the Azure Data Catalog API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• Name supports the '=, !=, <>, CONTAINS' operators.
• Timestamp supports the '=, <, <=, >, >=, CONTAINS' operators.
• LastRegisteredTime supports the '=, CONTAINS' operators.
• ObjectType supports the = operator.
• SourceType supports the = operator.
• FriendlyName supports the '=, CONTAINS' operators.
• Experts supports the '=, CONTAINS' operators.
• Description supports the '=, CONTAINS' operators.
• Tags supports the '=, !=, <>, CONTAINS' operators.
• HasTags supports the = operator.
• HasPreviews supports the = operator.
• HasDocumentation supports the = operator.
• HasTableDataProfiles supports the = operator.
• HasColumnsDataProfiles supports the = operator.
• HasDescription supports the = operator.
• View supports the = operator.
• Facets supports the = operator.

For example:

SELECT * FROM Descriptions WHERE CONTAINS(Description, 'sakila') AND ObjectType = table;

SELECT * FROM Descriptions WHERE CONTAINS(Name, 'customer') AND HasTags = true;

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Experts¶

Get list of experts of databases, tables, and objects.

Table Specific Information¶

Select¶

The connector will use the Azure Data Catalog API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• Name supports the '=, !=, <>, CONTAINS' operators.
• Timestamp supports the '=, <, <=, >, >=, CONTAINS' operators.
• LastRegisteredTime supports the '=, CONTAINS' operators.
• ObjectType supports the = operator.
• SourceType supports the = operator.
• FriendlyName supports the '=, CONTAINS' operators.
• Experts supports the '=, CONTAINS' operators.
• Description supports the '=, CONTAINS' operators.
• Tags supports the '=, !=, <>, CONTAINS' operators.
• HasTags supports the = operator.
• HasPreviews supports the = operator.
• HasDocumentation supports the = operator.
• HasTableDataProfiles supports the = operator.
• HasColumnsDataProfiles supports the = operator.
• HasDescription supports the = operator.
• View supports the = operator.
• Facets supports the = operator.

For example:

SELECT * FROM Experts WHERE ObjectType = 'table' AND CONTAINS(Experts, 'support')

SELECT * FROM Experts WHERE Tags = 'orders' OR Name = 'orders' AND ObjectType = 'table';

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Objects¶

Get list datasource properties.

Table Specific Information¶

Select¶

The connector will use the Azure Data Catalog API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• Name supports the '=, !=, <>, CONTAINS' operators.
• Timestamp supports the '=, <, <=, >, >=, CONTAINS' operators.
• LastRegisteredTime supports the '=, CONTAINS' operators.
• ObjectType supports the = operator.
• SourceType supports the = operator.
• FriendlyName supports the '=, CONTAINS' operators.
• Experts supports the '=, CONTAINS' operators.
• Description supports the '=, CONTAINS' operators.
• Tags supports the '=, !=, <>, CONTAINS' operators.
• HasTags supports the = operator.
• HasPreviews supports the = operator.
• HasDocumentation supports the = operator.
• HasTableDataProfiles supports the = operator.
• HasColumnsDataProfiles supports the = operator.
• HasDescription supports the = operator.
• View supports the = operator.
• Facets supports the = operator.

For example:

SELECT * FROM Objects WHERE Tags <> 'sales';

SELECT * FROM Objects WHERE Name = 'sales' AND HasTags = true;

SELECT * FROM Objects WHERE CONTAINS(Tags, 'sales') AND CONTAINS(Tags, 'customer');

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

TableColumns¶

Get details of table schema.

Table Specific Information¶

Select¶

The connector will use the Azure Data Catalog API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• ItemId supports the = operator.

For example:

SELECT * FROM TableColumns WHERE ItemId = '8a2b7305-b474-45d6-9fba-57e954565070'

Columns¶

TableDataProfiles¶

Get list of table data profiles.

Table Specific Information¶

Select¶

The connector will use the Azure Data Catalog API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• Name supports the '=, !=, <>, CONTAINS' operators.
• Timestamp supports the '=, <, <=, >, >=, CONTAINS' operators.
• LastRegisteredTime supports the '=, CONTAINS' operators.
• ObjectType supports the = operator.
• SourceType supports the = operator.
• FriendlyName supports the '=, CONTAINS' operators.
• Experts supports the '=, CONTAINS' operators.
• Description supports the '=, CONTAINS' operators.
• Tags supports the '=, !=, <>, CONTAINS' operators.
• HasTags supports the = operator.
• HasPreviews supports the = operator.
• HasDocumentation supports the = operator.
• HasTableDataProfiles supports the = operator.
• HasColumnsDataProfiles supports the = operator.
• HasDescription supports the = operator.
• View supports the = operator.
• Facets supports the = operator.

For example:

SELECT * FROM TableDataProfiles WHERE NOT Tags = 'FactProductInventory'

SELECT * FROM TableDataProfiles WHERE Timestamp > '2019-09-20T04:39:54.0083651Z';

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Tables¶

Get list of tables in the data asset.

Table Specific Information¶

Select¶

The connector will use the Azure Data Catalog API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• Name supports the '=, !=, <>, CONTAINS' operators.
• Timestamp supports the '=, <, <=, >, >=, CONTAINS' operators.
• LastRegisteredTime supports the '=, CONTAINS' operators.
• ObjectType supports the = operator.
• SourceType supports the = operator.
• FriendlyName supports the '=, CONTAINS' operators.
• Experts supports the '=, CONTAINS' operators.
• Description supports the '=, CONTAINS' operators.
• Tags supports the '=, !=, <>, CONTAINS' operators.
• HasTags supports the = operator.
• HasPreviews supports the = operator.
• HasDocumentation supports the = operator.
• HasTableDataProfiles supports the = operator.
• HasColumnsDataProfiles supports the = operator.
• HasDescription supports the = operator.
• View supports the = operator.
• Facets supports the = operator.

For example:

SELECT * FROM Tables WHERE Tags = 'sales' OR Name = 'FactProductInventory';

SELECT * FROM Tables WHERE Tags != 'FactProductInventory' AND NOT Tags = 'sales';

SELECT * FROM Tables WHERE NOT Tags = 'FactProductInventory';

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Tags¶

Get list of tags of databases, tables, and objects.

Table Specific Information¶

Select¶

The connector will use the Azure Data Catalog API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• Name supports the '=, !=, <>, CONTAINS' operators.
• Timestamp supports the '=, <, <=, >, >=, CONTAINS' operators.
• LastRegisteredTime supports the '=, CONTAINS' operators.
• ObjectType supports the = operator.
• SourceType supports the = operator.
• FriendlyName supports the '=, CONTAINS' operators.
• Experts supports the '=, CONTAINS' operators.
• Description supports the '=, CONTAINS' operators.
• Tags supports the '=, !=, <>, CONTAINS' operators.
• HasTags supports the = operator.
• HasPreviews supports the = operator.
• HasDocumentation supports the = operator.
• HasTableDataProfiles supports the = operator.
• HasColumnsDataProfiles supports the = operator.
• HasDescription supports the = operator.
• View supports the = operator.
• Facets supports the = operator.

For example:

SELECT * FROM Tags WHERE HasTags = 'true' AND CONTAINS(Name, 'sales')

SELECT * FROM Tags WHERE FriendlyName <> 'sales';

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Stored Procedures¶

Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT operations with Azure Data Catalog.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Azure Data Catalog, along with an indication of whether the procedure succeeded or failed.

Azure Data Catalog Connector Stored Procedures¶

GetAdminConsentURL¶

Gets the admin consent URL that must be opened separately by an admin of a given domain to grant access to your application. Only needed when using custom OAuth credentials.

Input¶

Result Set Columns¶

GetOAuthAccessToken¶

Gets an authentication token from AzureDataCatalog.

Input¶

Result Set Columns¶

GetOAuthAuthorizationURL¶

Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the OAuthAccessToken from this URL.

Input¶

Result Set Columns¶

RefreshOAuthAccessToken¶

Refreshes the OAuth access token used for authentication with AzureDataCatalog.

Input¶

Result Set Columns¶

System Tables¶

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables¶

The following tables return database metadata for Azure Data Catalog:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables¶

The following tables return information about how to connect to and query the data source:

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.

Query Information Tables¶

The following table returns query statistics for data modification queries:

• sys_identity: Returns information about batch operations or single updates.

sys_catalogs¶

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns¶

sys_schemas¶

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas

Columns¶

sys_tables¶

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables

Columns¶

sys_tablecolumns¶

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Tables table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Tables'

Columns¶

sys_procedures¶

Lists the available stored procedures.

The following query retrieves the available stored procedures:

SELECT * FROM sys_procedures

Columns¶

sys_procedureparameters¶

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the SelectEntries stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='SelectEntries' AND Direction=1 OR Direction=2

Columns¶

sys_keycolumns¶

Describes the primary and foreign keys.

The following query retrieves the primary key for the Tables table:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Tables'

Columns¶

sys_foreignkeys¶

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columns¶

sys_primarykeys¶

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

SELECT * FROM sys_primarykeys

Columns¶

sys_indexes¶

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns¶

sys_connection_props¶

Returns information on the available connection properties and those set in the connection string.

When querying this table, the config connection string should be used:

jdbc:cdata:azuredatacatalog:config:

This connection string enables you to query this table without a valid connection.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns¶

sys_sqlinfo¶

Describes the SELECT query processing that the connector can offload to the data source.

Discovering the Data Source's SELECT Capabilities¶

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns¶

sys_identity¶

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

SELECT * FROM sys_identity

Columns¶

Advanced Configurations Properties¶

The advanced configurations properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure. Click the links for further details.

Authentication

Azure Authentication

OAuth

JWT OAuth

SSL

Schema

Miscellaneous

Authentication¶

This section provides a complete list of authentication properties you can configure.

AuthScheme¶

The type of authentication to use when connecting to Azure Data Catalog.

Possible Values¶

AzureAD, AzureMSI, AzureServicePrincipal, AzureServicePrincipalCert

Data Type¶

string

Default Value¶

AzureAD

Remarks¶

• AzureAD: Set this to perform Azure Active Directory OAuth authentication.
• AzureMSI: Set this to automatically obtain Managed Service Identity credentials when running on an Azure VM.
• AzureServicePrincipal: Set this to authenticate as an Azure Service Principal using a Client Secret.
• AzureServicePrincipalCert: Set this to authenticate as an Azure Service Principal using a Certificate.

CatalogName¶

The name of the catalog to connect to.

Data Type¶

string

Default Value¶

defaultcatalog

Remarks¶

If left blank, the default catalog will be used. To obtain a given CatalogName, navigate to the Azure Portal home page -> Data Catalog -> Catalog Name.

Azure Authentication¶

This section provides a complete list of Azure authentication properties you can configure.

AzureTenant¶

The Microsoft Online tenant being used to access data. If not specified, your default tenant is used.

Data Type¶

string

Default Value¶

""

Remarks¶

The Microsoft Online tenant being used to access data. For instance, contoso.onmicrosoft.com. Alternatively, specify the tenant Id. This value is the directory ID in the Azure Portal > Azure Active Directory > Properties.

Typically it is not necessary to specify the Tenant. This can be automatically determined by Microsoft when using the OAuthGrantType set to CODE (default). However, it may fail in the case that the user belongs to multiple tenants. For instance, if an Admin of domain A invites a user of domain B to be a guest user. The user will now belong to both tenants. It is a good practice to specify the Tenant, although in general things should normally work without having to specify it.

The AzureTenant is required when setting OAuthGrantType to CLIENT. When using client credentials, there is no user context. The credentials are taken from the context of the app itself. While Microsoft still allows client credentials to be obtained without specifying which Tenant, it has a much lower probability of picking the specific tenant you want to work with. For this reason, we require AzureTenant to be explicitly stated for all client credentials connections to ensure you get credentials that are applicable for the domain you intend to connect to.

AzureEnvironment¶

The Azure Environment to use when establishing a connection.

Possible Values¶

GLOBAL, CHINA, USGOVT, USGOVTDOD

Data Type¶

string

Default Value¶

GLOBAL

Remarks¶

In most cases, leaving the environment set to global will work. However, if your Azure Account has been added to a different environment, the AzureEnvironment may be used to specify which environment. The available values are GLOBAL, CHINA, USGOVT, USGOVTDOD.

OAuth¶

This section provides a complete list of OAuth properties you can configure.

InitiateOAuth¶

Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.

Possible Values¶

OFF, GETANDREFRESH, REFRESH

Data Type¶

string

Default Value¶

OFF

Remarks¶

The following options are available:

1. OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
2. GETANDREFRESH: Indicates that the entire OAuth Flow will be handled by the connector. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.
3. REFRESH: Indicates that the connector will only handle refreshing the OAuthAccessToken. The user will never be prompted by the connector to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.

OAuthClientId¶

The client ID assigned when you register your application with an OAuth authorization server.

Data Type¶

string

Default Value¶

""

Remarks¶

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

OAuthClientSecret¶

The client secret assigned when you register your application with an OAuth authorization server.

Data Type¶

string

Default Value¶

""

Remarks¶

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

OAuthAccessToken¶

The access token for connecting using OAuth.

Data Type¶

string

Default Value¶

""

Remarks¶

The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.

OAuthSettingsLocation¶

The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'.

Data Type¶

string

Default Value¶

%APPDATA%\AzureDataCatalog Data Provider\OAuthSettings.txt

Remarks¶

When InitiateOAuth is set to GETANDREFRESH or REFRESH, the connector saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and to allow the credentials to be shared across connections or processes.

Instead of specifying a file path, you can use memory storage. Memory locations are specified by using a value starting with 'memory://' followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory, and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again. You can retrieve OAuth property values with a query to the sys_connection_props system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.

The default location is "%APPDATA%\AzureDataCatalog Data Provider\OAuthSettings.txt" with %APPDATA% set to the user's configuration directory. The default values are

• Windows: "register://%DSN"
• Unix: "%AppData%..."
• Mac: "%AppData%..."

where DSN is the name of the current DSN used in the open connection.

The following table lists the value of %APPDATA% by OS:

CallbackURL¶

The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.

Data Type¶

string

Default Value¶

""

Remarks¶

During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.

OAuthVerifier¶

The verifier code returned from the OAuth authorization URL.

Data Type¶

string

Default Value¶

""

Remarks¶

The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.

Authentication on Headless Machines¶

See to obtain the OAuthVerifier value.

Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the connector exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified location. Set InitiateOAuth to GETANDREFRESH to automate the exchange.

Once the OAuth settings file has been generated, you can remove OAuthVerifier from the connection properties and connect with OAuthSettingsLocation set.

To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.

OAuthRefreshToken¶

The OAuth refresh token for the corresponding OAuth access token.

Data Type¶

string

Default Value¶

""

Remarks¶

The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.

OAuthExpiresIn¶

The lifetime in seconds of the OAuth AccessToken.

Data Type¶

string

Default Value¶

""

Remarks¶

Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.

OAuthTokenTimestamp¶

The Unix epoch timestamp in milliseconds when the current Access Token was created.

Data Type¶

string

Default Value¶

""

Remarks¶

Pair with OAuthExpiresIn to determine when the AccessToken will expire.

JWT OAuth¶

This section provides a complete list of JWT OAuth properties you can configure.

OAuthJWTCert¶

The JWT Certificate store.

Data Type¶

string

Default Value¶

""

Remarks¶

The name of the certificate store for the client certificate.

The OAuthJWTCertType field specifies the type of the certificate store specified by OAuthJWTCert. If the store is password protected, specify the password in OAuthJWTCertPassword.

OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject

field in order to specify client certificates. If OAuthJWTCert has a value, and OAuthJWTCertSubject is set, a search for a certificate is initiated. Please refer to the OAuthJWTCertSubject field for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

OAuthJWTCertType¶

The type of key store containing the JWT Certificate.

Data Type¶

string

Default Value¶

USER

Remarks¶

This property can take one of the following values:

OAuthJWTCertPassword¶

The password for the OAuth JWT certificate.

Data Type¶

string

Default Value¶

""

Remarks¶

If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.

OAuthJWTCertSubject¶

The subject of the OAuth JWT certificate.

Data Type¶

string

Default Value¶

*

Remarks¶

When loading a certificate the subject is used to locate the certificate in the store.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks the first certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@jitterbit.com". Common fields and their meanings are displayed below.

If a field value contains a comma it must be quoted.

SSL¶

This section provides a complete list of SSL properties you can configure.

SSLServerCert¶

The certificate to be accepted from the server when connecting using TLS/SSL.

Data Type¶

string

Default Value¶

""

Remarks¶

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

If not specified, any certificate trusted by the machine is accepted.

Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Schema¶

This section provides a complete list of schema properties you can configure.

Location¶

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Data Type¶

string

Default Value¶

%APPDATA%\AzureDataCatalog Data Provider\Schema

Remarks¶

The path to a directory which contains the schema files for the connector (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\AzureDataCatalog Data Provider\Schema" with %APPDATA% being set to the user's configuration directory:

BrowsableSchemas¶

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type¶

string

Default Value¶

""

Remarks¶

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Tables¶

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Data Type¶

string

Default Value¶

""

Remarks¶

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Views¶

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Data Type¶

string

Default Value¶

""

Remarks¶

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Miscellaneous¶

This section provides a complete list of miscellaneous properties you can configure.

MaxRows¶

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Data Type¶

int

Default Value¶

-1

Remarks¶

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Other¶

These hidden properties are used only in specific use cases.

Data Type¶

string

Default Value¶

""

Remarks¶

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting¶

Pagesize¶

The maximum number of results to return per page from Azure Data Catalog.

Data Type¶

int

Default Value¶

100

Remarks¶

The Pagesize property affects the maximum number of results to return per page from Azure Data Catalog. Setting a higher value may result in better performance at the cost of additional memory allocated per page consumed.

PseudoColumns¶

This property indicates whether or not to include pseudo columns as columns to the table.

Data Type¶

string

Default Value¶

""

Remarks¶

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

Timeout¶

The value in seconds until the timeout error is thrown, canceling the operation.

Data Type¶

int

Default Value¶

60

Remarks¶

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the connector throws an exception.

UserDefinedViews¶

A filepath pointing to the JSON configuration file containing your custom views.

Data Type¶

string

Default Value¶

""

Remarks¶

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM Tables WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json

Note that the specified path is not embedded in quotation marks.