Skip to content
dbx tools

Variable: DatabricksOptionsSchema

const DatabricksOptionsSchema: ZodObject<{ accessToken: ZodOptional<ZodString>; accountId: ZodOptional<ZodString>; appName: ZodOptional<ZodString>; appPort: ZodOptional<ZodCoercedNumber<number>>; authType: ZodOptional<ZodString>; clientId: ZodOptional<ZodString>; clientSecret: ZodOptional<ZodString>; configFile: ZodOptional<ZodString>; groupId: ZodOptional<ZodString>; host: ZodOptional<ZodString>; lakebaseEndpoint: ZodOptional<ZodString>; profile: ZodOptional<ZodString>; workspaceId: ZodOptional<ZodString>; }, $strict>

DatabricksOptions fields

Section titled “DatabricksOptions fields”

Common Databricks CLI, SDK, Apps, and Lakebase options.

  • profile (optional): Databricks CLI profile.
  • host (optional): Databricks host.
  • accountId (optional): Databricks account ID.
  • workspaceId (optional): Databricks workspace ID.
  • configFile (optional): Databricks CLI config file.
  • clientId (optional): Databricks OAuth client ID.
  • clientSecret (optional): Databricks OAuth client secret.
  • accessToken (optional): Databricks access token.
  • groupId (optional): Databricks group ID.
  • authType (optional): Databricks authentication type.
  • appName (optional): Databricks App name.
  • appPort (optional): Databricks App port.
  • lakebaseEndpoint (optional): Lakebase endpoint.