Microsoft SQL Server

Create an integration to manage access to a Microsoft SQL Server database

Microsoft SQL Server is a reliable and secure relational database management system. It can be used as the main data store for various applications, websites, and products.

Microsoft enables developers to create cloud-hosted SQL Server databases.

Through this integration, Apono helps you securely manage access to your Microsoft SQL Server database.



Prerequisites

ItemDescription
Apono ConnectorOn-prem connection serving as a bridge between a Microsoft SQL Server database instance and Apono:
Microsoft SQL Server InfoInformation for the database instance to be integrated:
  • Hostname
  • Port number


Create a Microsoft SQL Server user

You must create a user in your Microsoft SQL Server instance for the Apono connector.

Use the following steps to create a user and grant it permissions to your databases:

  1. In your preferred client tool, create a new user. Be sure to set a strong password for the user.

    ⚠️

    The password must be a minimum of 8 characters and include characters from at least three of these four categories:

    • Uppercase letters
    • Lowercase letters
    • Digits (0-9)
    • Symbols
    CREATE LOGIN apono_connector WITH PASSWORD = 'password';
    

  2. Expose databases to the user. This allows Apono to view database names without accessing the contents of each database.

    GRANT VIEW ANY DATABASE TO apono_connector;
    

  1. Grant the ALTER ANY LOGIN database permissions to the user in all the databases.
    USER master GRANT ALTER ANY LOGIN TO apono_connector;
    

  1. Grant the user only one of the following permissions. The chosen permission defines the highest level of permissions to provision with Apono.
    Expand each of the following options to reveal the SQL command:

    READ_ONLY: Allows Apono to read data from databases
    USE master GRANT SELECT, TO apono_connector;
    

    READ_WRITE: Allows Apono to read and modify data
    USE master GRANT DELETE,INSERT,SELECT,UPDATE TO apono_connector;
    
    

    ADMIN: Allows Apono administrative-level access, including the ability to execute and drop tables
    USE master GRANT CONTROL SERVER TO apono_connector;
    
    


  1. (MSSQL 2019+) Grant the user the authority to perform tasks and access server-level features. This enables Apono to create, alter, and drop roles. However, this role does not inherently grant specific database access permissions.
    GRANT ROLE_ADMIN on *.* to 'apono_connector';
    

  1. Using the credentials from step 1, create a secret for the database instance:

You can now integrate Microsoft SQL Server.



Integrate Microsoft SQL Server

Follow these steps to complete the integration:

  1. On the Catalog tab, click Microsoft SQL Server. The Connect Microsoft SQL Server page appears.
  2. From the dropdown menu, select a connector.

    💡

    If the desired connector is not listed, click + Add new connector and follow the instructions for creating a connector (AWS, Azure, GCP, Kubernetes).


  1. Under Select resource types, select one or multiple resource types for Apono to discover in all instances of the environment.
  2. Click Next. The Complete setup page appears.
  3. Enter a unique, alphanumeric, user-friendly Integration Name. This name is used to identify this integration when constructing an Access Flow.
  4. Enter the Hostname of the Microsoft SQL Server instance to connect.
  5. (Optional) Enter the Port value for the database. By default, Apono sets this value to 1433.
  6. (Optional) In the Credentials rotation period (in days) field, enter the number of days after which the database credentials must be rotated.
  7. Under Secret Store, associate the secret:
  8. Click Connect.

Now that you have completed this integration, you can create access flows that grant permission to your Microsoft SQL Server database.