Create a SQL Server connection

You're viewing Apigee X documentation.
View Apigee Edge documentation.

The SQL Server connector lets you perform insert, delete, update, and read operations on a SQL Server database.

Before you begin

Before creating a SQL Server Connection, perform the following tasks:

  • In your Google Cloud project:
    • Grant the following roles to the service account that you want to use to create the connection:
      • roles/secretmanager.secretAccessor
      • roles/secretmanager.viewer
    • Enable the following services:
      • apigee.googleapis.com (Apigee API)
      • secretmanager.googleapis.com (Secret Manager API)
      • connectors.googleapis.com (Connector Platform API)

    If these services or permissions have not been enabled for your project previously, you are prompted to enable them when creating the connection in the Create Connection page.

Create a connection

  1. In the Cloud console, go to the Apigee > Connectors page and then select or create a Google Cloud project.

    Go to the Connections page

  2. Click + CREATE NEW to open the Create Connection page.
  3. Configure the connection:
    1. In the Create Connection section, complete the following:
      • Connector: Select SQL Server from the drop down list of available Connectors.
      • Connector version: Select the Connector version from the drop down list of available versions.
      • In the Connection Name field, enter a name for the Connection instance.

        Connection names must meet the following criteria:

        • Connection names can use letters, numbers, or hyphens.
        • Letters must be lower-case.
        • Connection names must begin with a letter and end with a letter or number.
        • Connection names cannot exceed 63 characters.
      • Optionally, enter a Description for the connection instance.
      • Service Account: Select a service account that has the required roles.
      • Port: The port of the MS SQL Server.
      • Server: The name of the server running SQL Server.
      • ApplicationIntent: The application intent connection string property expresses the client application's request to be directed either to a read-write or read-only version of an availability group database. To use read-only routing, a client must use an application intent of read-only in the connection string when connecting to the availability group listener. Without the read-only application intent, connections to the availability group listener are directed to the database on the primary replica.
      • ApplicationName: The application name connection string property expresses the client application's name.
      • Database: The name of the SQL Server database.
      • Domain: The name of the domain for a Windows (NTLM) security login.
      • Encrypt: This field sets whether SSL is enabled.
      • IntegratedSecurity: Whether or not to authenticate with Windows Integrated Security.
      • NTLMVersion: The NTLM version.
      • Optionally, click + ADD LABEL to add a label to the Connection in the form of a key/value pair.
      • Click NEXT.
    2. Location: Choose the location for the connection.
      • Select a location where Apigee is available from the Region drop-down list.

        Supported regions for connectors include:

        • asia-east1
        • asia-northeast1
        • asia-south1
        • asia-southeast1
        • australia-southeast1
        • europe-west1
        • europe-west2
        • europe-west3
        • europe-west4
        • europe-west6
        • northamerica-northeast1
        • southamerica-east1
        • us-central1
        • us-east1
        • us-east4
        • us-west1
        • us-west2
      • Click NEXT.
    3. Authentication: Authentication types supported by the SQL Server connection:
      • Username and password

      Enter the details based on the authentication you want to use.

      • Username and password
        • Username: Username for connector
        • Password: Secret Manager Secret containing the password associated with the connector.
    4. Click NEXT.
    5. Review: Review your connection and authentication details.
  4. Click Create.

Create a Connectors task

After you create a SQL Server connection, it becomes available in Apigee integrations. You can then use the connection to configure the Connectors tasks in your integrations. For more information, see Configure the Connectors task.