Databricks SDK for JavaScript
    Preparing search index...

    Interface Profile

    Holds configuration values resolved from a databrickscfg file and/or environment variables. All fields are optional; an absent field means the value was not configured.

    interface Profile {
        accountId?: string;
        authType?: string;
        clientId?: string;
        clientSecret?: Secret;
        databricksCliPath?: string;
        extra?: Record<string, string>;
        host?: string;
        name?: string;
        token?: Secret;
        workspaceId?: string;
    }
    Index

    Properties

    accountId? authType? clientId? clientSecret? databricksCliPath? extra? host? name? token? workspaceId?

    Properties

    accountId?: string

    Databricks Account ID for Accounts API.

    authType?: string

    Selects a specific auth method when multiple credentials are available.

    clientId?: string

    OAuth client ID for M2M authentication.

    clientSecret?: Secret

    OAuth client secret for M2M authentication.

    databricksCliPath?: string

    Path to the Databricks CLI binary (>= 0.100.0) for CLI-based auth.

    extra?: Record<string, string>

    INI keys not mapped to a known field. Only populated when loading from a config file; environment variables do not contribute to extra.

    host?: string

    Databricks workspace or Accounts API endpoint URL.

    name?: string

    Profile name (INI section name).

    token?: Secret

    Personal access token for PAT authentication.

    workspaceId?: string

    Databricks Workspace ID, used with unified hosts. Accepts either a classic numeric workspace ID or another workspace identifier format that the server understands.

    Settings

    Member Visibility

    On This Page

    Properties