Connect action for Databricks

Th connect action enables you to establish a connection to a Databricks workspace using either OAuth2 or a Personal Access Token, and initializes a session (local, global, or variable) for executing subsequent Databricks operations within the automation.

Settings

  • In the Host URL field, enter the Databricks workspace URL.

    This is the base URL used to connect to your Databricks environment. For example, https://dbc-xxx.cloud.databricks.com

  • Select one of the following Authentication mode:
    • OAuth2 (Control Room managed): In the OAuth2 connection field, click Pick to choose from available Control Room-managed OAuth2 credentials.​
      Note: Ensure the OAuth2 connection is valid and active in the Control Room.​
      • Click the Provider type drop-down menu to select an available or custom provider.

        For information in creating a custom provider, see Control Room で OAuth 2.0 接続を構成します.

      • In the Connection name field, select the specific OAuth connection object Control Room admin for Microsoft Teams.

        This field is disabled until a Provider type is selected.

      • In the Token type field, select one of the following options depending on the token that will be used at run time.
        • Shared: for a global token.

          An access token of shared type is created when a connection is established to the Control Room. This access token is stored as a credential. When you run your automation, the access token is referenced in the automation using the enterprise application provider type set up in the Control Room.

        • User-specific: for a token that is specific to a user.
          If you select this option, ensure that you log in to your account to authenticate and generate a user-specific token. Perform the following steps to use this option:
          1. Log in to Control Room and navigate to My settings > OAuth connections in your profile.
          2. Under the OAuth connections tab, click Login to authenticate.
          3. Sign in and select Continue.
          4. Verify the services you have access to and click Continue.

            If the connection is succeeded, it will display the status as Active under the OAuth connections > Connections table.

    • Personal Access Token: Provide a Databricks Personal Access Token (PAT) used to authenticate and establish a connection to the Databricks workspace.

      Generate a new token and copy its value from Settings → > Developer > Access Tokens.

    • Select one of the following options to use personal access token.
      • Credential: Securely store and reference the token using Control Room credentials (recommended).
        • Click Choose to pick a credential.
        • Select available locker, credential, and attribute from the list and click Confirm.
      • Variable: Use a variable that contains the token value.
      • Insecure string: Enter the token directly (not recommended for production use).

        Click the Insert a value icon to select an existing variable.

  • In the Databricks session field, use one of the following tabs for creating a session:
    • Local session: to specify a session name that can be used only in the current automation.
    • Global session: to specify a session name that can be used across multiple automations, such as parent bots, child bots, and all other child bots of the parent bot.

      Recommendation: The parent and child bots should have the same package version.

    • Variable: to specify a Databricks session variable.

      Click the Create variable icon on the right to create a variable, then choose Databricks session as the Session type in the window that appears. See 変数の作成.