
## Crawl Microsoft Azure Synapse Analytics

URL: https://docs.atlan.com/apps/connectors/data-warehouses/microsoft-azure-synapse-analytics/how-tos/crawl-microsoft-azure-synapse-analytics

> Extract metadata from Microsoft Azure Synapse Analytics to catalog databases, schemas, tables, and views. Discover and govern your cloud data warehouse assets after configuring permissions.

Extract metadata from your [Microsoft Azure Synapse Analytics](https://docs.atlan.com/llms/connectors/microsoft-azure-synapse-analytics/set-up-microsoft-azure-synapse-analytics/llms.txt) instance into Atlan to catalog databases, schemas, tables, and views. After configuring the necessary permissions, you can establish a connection and crawl to extract lineage and column-level details.

To crawl metadata from Microsoft Azure Synapse Ana

lytics, review the [order of operations](https://docs.atlan.com/llms/catalog/connector-capabilities/order-workflows/llms.txt) and then complete the following steps.

## Select the source

To select Microsoft Azure Synapse Analytics as your source:

1. In your Atlan workspace, click **Connectors** in the left sidebar.
 * If you are using the **Old UI (Classic)**, click **New Workflow** in the top navigation.

2. Click **Marketplace**.

3. Search for **Synapse Assets** and select it.

4. Click **Install**.

5. Once installation completes, click **Setup Workflow** on the same tile.

## Provide your credentials

Choose your authentication method:

- In **Basic** authentication, you will need a [username](https://docs.atlan.com/llms/connectors/microsoft-azure-synapse-analytics/set-up-microsoft-azure-synapse-analytics/llms.txt), [password](https://docs.atlan.com/llms/connectors/microsoft-azure-synapse-analytics/set-up-microsoft-azure-synapse-analytics/llms.txt), and database name. 
- In **Service principal** authentication, you will need a [client ID, client secret, tenant ID](https://docs.atlan.com/llms/connectors/microsoft-azure-synapse-analytics/set-up-microsoft-azure-synapse-analytics/llms.txt), and database name.

### Basic authentication

To enter your Microsoft Azure Synapse Analytics credentials:

1. For _Host_, enter the [server name of your SQL pool](https://docs.atlan.com/llms/connectors/microsoft-azure-synapse-analytics/set-up-microsoft-azure-synapse-analytics/llms.txt).

2. For _Port_, enter the port number where your SQL pool is available.

3. For _Username_, enter the [username you created](https://docs.atlan.com/llms/connectors/microsoft-azure-synapse-analytics/set-up-microsoft-azure-synapse-analytics/llms.txt) when setting up user permissions.

4. For _Password_, enter the [password you created](https://docs.atlan.com/llms/connectors/microsoft-azure-synapse-analytics/set-up-microsoft-azure-synapse-analytics/llms.txt) when setting up user permissions.

5. For _Database_, enter the name of the database you want to crawl.

6. Click the **Test Authentication** button to confirm connectivity to Microsoft Azure Synapse Analytics.

7. Once authentication is successful, navigate to the bottom of the screen and click **Next**.

### Service principal authentication

:::info **Did you know?** 
 For service principal authentication, Atlan fetches Synapse pipeline metadata from the [Azure Synapse Analytics REST API](https://learn.microsoft.com/en-us/rest/api/synapse/) to generate lineage. Refer to [What lineage does Atlan extract from Microsoft Azure Synapse Analytics?](https://docs.atlan.com/llms/connectors/microsoft-azure-synapse-analytics/what-lineage-does-atlan-extract-from-microsoft-azure-synapse-analytics/llms.txt) to learn more.

:::

To enter your Microsoft Azure Synapse Analytics credentials:

1. For _Host_, enter the [server name of your SQL pool](https://docs.atlan.com/llms/connectors/microsoft-azure-synapse-analytics/set-up-microsoft-azure-synapse-analytics/llms.txt).

2. For _Port_, enter the port number where your SQL pool is available.

3. For _Client ID_, enter the [application (client) ID you copied](https://docs.atlan.com/llms/connectors/microsoft-azure-synapse-analytics/set-up-microsoft-azure-synapse-analytics/llms.txt) for your service principal.

4. For _Client Secret_, enter the [client secret you copied](https://docs.atlan.com/llms/connectors/microsoft-azure-synapse-analytics/set-up-microsoft-azure-synapse-analytics/llms.txt) for your service principal.

5. For _Tenant ID_, enter the [directory (tenant) ID you copied](https://docs.atlan.com/llms/connectors/microsoft-azure-synapse-analytics/set-up-microsoft-azure-synapse-analytics/llms.txt) for your service principal.

6. For _Database_, enter the name of the database you want to crawl.

7. Click the **Test Authentication** button to confirm connectivity to Microsoft Azure Synapse Analytics.

8. Once authentication is successful, navigate to the bottom of the screen and click **Next**.

## Configure the connection

To complete the Microsoft Azure Synapse Analytics connection configuration:

1. Provide a _Connection Name_ that represents your source environment. For example, you might use values like `production`,`development`,`gold`, or `analytics`.

2. (Optional) To change the users who are able to manage this connection, change the users or groups listed under _Connection Admins_.

 :::warning

 If you do not specify any user or group, no one will be able to manage the connection - not even admins.

 :::

3. Navigate to the bottom of the screen and click **Next** to proceed.

## Configure the crawler

Before running the Microsoft Azure Synapse Analytics crawler, you can further configure it.

On the _Metadata_ page, you can override the defaults for any of these options:

- To select the assets you want to exclude from crawling, click **Exclude Metadata**. (This will default to no assets if none are specified.)
- To select the assets you want to include in crawling, click **Include Metadata**. (This will default to all assets, if none are specified.)
- To have the crawler ignore tables and views based on a naming convention, specify a regular expression in the _Exclude regex for tables & views_ field.
- For _Advanced Config_, keep _Default_ for the default configuration or click **Custom** to configure the crawler:
 - For _Use JDBC Internal Methods_, click **True** to enable JDBC internal methods for data extraction or click **False** to disable it.

:::info **Did you know?** 
 If an asset appears in both the include and exclude filters, the exclude filter takes precedence.

:::

## Run the crawler

To run the Microsoft Azure Synapse Analytics crawler, after completing the steps above:

1. To check for any [permissions or other configuration issues](https://docs.atlan.com/llms/connectors/microsoft-azure-synapse-analytics/preflight-checks-for-microsoft-azure-synapse-analytics/llms.txt) before running the crawler, click **Preflight checks**.

2. You can either:
 - To run the crawler once immediately, at the bottom of the screen, click the **Run** button.
 - To schedule the crawler to run hourly, daily, weekly, or monthly, at the bottom of the screen, click the **Schedule Run** button.

Once the crawler has completed running, you will see the assets on Atlan's asset page! 🎉

---
