Catalog Source Configuration > Microsoft Azure Synapse Script > Before you begin
  

Before you begin

Before you can extract catalog source metadata, complete prerequisite tasks.
Perform the following prerequisite tasks:

Verify permissions

To extract Microsoft Azure Synapse Script metadata, you need account access and permissions to the Microsoft Azure Synapse Script catalog source and the Microsoft Azure Synapse source system.
Verify that the Metadata Command Center administrator has the following permissions:

Create a connection

Before you configure the Microsoft Azure Synapse Script catalog source, create a connection object in Administrator.
    1In Administrator, select Connections.
    2Click New Connection.
    3Enter properties specific to the connection:
    Property
    Description
    Connection Name
    Name of the connection.
    Each connection name must be unique within the organization. Connection names can contain alphanumeric characters, spaces, and the following special characters: _ . + -,
    Maximum length is 255 characters.
    Description
    Description of the connection. Maximum length is 4000 characters.
    Type
    Microsoft Azure Synapse SQL
    Runtime Environment
    The name of the runtime environment where you want to run tasks.
    Azure DW JDBC URL
    The Microsoft Azure Synapse SQL JDBC connection string.
    Use the following string to connect to Microsoft Azure Synapse SQL:
    jdbc:sqlserver://<Server>.database.windows.net:1433; database=<Database>
    You can include an authentication parameter in the connection string to specify the authentication type. You can configure the following authentication types to connect to Microsoft Azure Synapse SQL:
    • - Microsoft SQL Server
    • - Azure Active Directory
    • - Managed Identity
    • - Service Principal
    If you don't include an authentication parameter in the connection string, the Secure Agent uses Microsoft SQL Server authentication as the authentication type.
    Connection string format for Microsoft SQL Server authentication
    jdbc:sqlserver://<Server>.database.windows.net:1433; database=<Database>
    Connection string format for Azure Active Directory (AAD) authentication
    jdbc:sqlserver://<Server>.database.windows.net:1433; database=<Database>;encrypt=true;trustServerCertificate=false; hostNameInCertificate=*.database.windows.net;loginTimeout=30; Authentication=ActiveDirectoryPassword;
    Connection string format for Service Principal authentication
    jdbc:sqlserver://<Server>.database.windows.net:1433; database=<Database>;encrypt=true;trustServerCertificate=false; hostNameInCertificate=*.database.windows.net;loginTimeout=30; Authentication= ActiveDirectoryServicePrincipal;
    Connection string format for Managed Identity authentication
    jdbc:sqlserver://<Server>.database.windows.net:1433; database=<Database>;Authentication=ActiveDirectoryMsi;
    Azure DW JDBC Username
    User name to connect to the Microsoft Azure Synapse SQL account.
    • - For AAD authentication, provide your AAD user name.
    • - For Microsoft SQL server authentication, provide your SQL auth user name.
    • - For service principal authentication, provide the application ID or client ID for your application registered in Azure Active Directory.
    This property doesn't apply to Managed Identity authentication.
    Azure DW JDBC Password
    Password to connect to the Microsoft Azure Synapse SQL account.
    • - For AAD authentication, provide the password of the AAD user.
    • - For Microsoft SQL server authentication, provide the password of SQL auth user.
    • - For service principal authentication, provide the client secret for your application registered in the Azure Active Directory.
    This property doesn't apply to Managed Identity authentication.
    Azure DW Client ID
    Required if you want to use the user-assigned managed identity for Managed Identity Authentication to connect to Microsoft Azure Synapse SQL.
    The client ID of the user-assigned managed identity.
    If you use system-assigned managed identity, leave the field empty.
    Azure DW Schema Name
    Name of the schema in Microsoft Azure Synapse SQL.
    4You can select Microsoft Azure Blob Storage or Microsoft Azure Data Lake Storage Gen2 as the Azure storage type to stage the data files. Default is Azure Blob. Select your preferred storage type and then configure the storage-specific parameters.
    When you select Microsoft Azure Blob as the storage type, you can configure Shared Key Authentication as the authentication type to stage the files.
    The following table describes the authentication type that you can configure for Microsoft Azure Blob storage:
    Property
    Description
    Authentication Type
    Authentication type to connect to Microsoft Azure Blob storage to stage the files.
    You can configure Shared Key Authentication as the authentication type to stage the files.
    Shared Key Authentication uses the storage account name and account key to connect to Microsoft Azure Blob storage.
    The following table describes the basic connection properties for shared key authentication:
    Property
    Description
    Azure Blob Account Name
    Name of the Microsoft Azure Blob Storage account to stage the files.
    Azure Blob Account Key
    The Microsoft Azure Blob Storage access key to stage the files.
    Container Name
    The name of the container in the Azure Blob Storage account.
    5 When you select Microsoft Azure Blob as the storage type, you can configure Shared Key Authentication as the authentication type to stage the files.
    The following table describes the authentication type that you can configure for Microsoft Azure Blob storage:
    Property
    Description
    Authentication Type
    Authentication type to connect to Azure storage to stage the files.
    Select one of the following options:
    • - Shared Key Authentication
    • - Service Principal Authentication
    • - Managed Identity Authentication
    For more information on how to configure the authentication types, see Setting up authentication to connect to Microsoft Azure Synapse SQL.
    Shared Key Authentication uses the storage account name and account key to connect to Microsoft Azure Data Lake Storage Gen2.
    The following table describes the basic connection properties for shared key authentication:
    Property
    Description
    ADLS Gen2 Storage Account Name
    Name of the Microsoft Azure Data Lake Storage Gen2 account to stage the files.
    ADLS Gen2 Account Key
    The Microsoft Azure Data Lake Storage Gen2 access key to stage the files.
    File System Name
    The name of the file system in the Microsoft Azure Data Lake Storage Gen2 account.
    Service Principal Authentication uses the account name, client ID, client secret, and tenant ID to connect to Microsoft Azure Data Lake Storage Gen2.
    The following table describes the basic connection properties for service principal authentication:
    Property
    Description
    ADLS Gen2 Storage Account Name
    Name of the Microsoft Azure Data Lake Storage Gen2 account to stage the files.
    Client ID
    The client ID of your application.
    Enter the application ID or client ID for your application registered in the Azure Active Directory.
    Client Secret
    The client secret for your application.
    Tenant ID
    The directory ID or tenant ID for your application.
    File System Name
    The name of the file system in the Microsoft Azure Data Lake Storage Gen2 account.
    Select Managed Identity Authentication to authenticate using system-assigned or user-assigned identities that are assigned to applications in Azure to access Azure resources in Microsoft Azure Data Lake Storage Gen2.
    The following table describes the basic connection properties for managed identity authentication:
    Property
    Description
    ADLS Gen2 Storage Account Name
    Name of the Microsoft Azure Data Lake Storage Gen2 account to stage the files.
    Client ID
    The client ID of your application.
    Enter the client ID for the user-assigned managed identity. If the managed identity is system-assigned, leave the field empty.
    File System Name
    The name of the file system in the Microsoft Azure Data Lake Storage Gen2 account.
    6Click Test Connection.