メインコンテンツまでスキップ

統合認証のための環境変数とフィールド

このリファレンスでは、 Databricks クライアント統合認証の環境変数と構成フィールドを一覧表示します。これらは、Databricks CLI、Terraform プロバイダー、Python、Java、Go 用の SDK 全体で一貫して機能します。

このリファレンスを使用して、認証を設定したり、認証の問題をトラブルシューティングしたりします。各エントリーには次のものが含まれます。

  • 環境変数: シェル環境で設定します。
  • .databrickscfgフィールド: これは構成プロファイルで使用します。
  • Terraformフィールド: これをTerraformプロバイダ・ブロックで構成します。Databricks Terraform プロバイダーのドキュメントの 「認証」 を参照してください。
  • Configフィールド: これは、Config API を使用してプログラムで SDK を構成する場合に使用します。

一般構成フィールド​

これらの変数は、 Databricksの基本的な接続とコンピュート設定を構成します。

一般的な名前

説明

環境変数

.databrickscfg フィールド、Terraformフィールド

Config フィールド

Databricksホスト

（文字列）DatabricksワークスペースエンドポイントまたはDatabricksアカウントエンドポイントのDatabricksホストURL。

DATABRICKS_HOST

host

host (Python)

setHost (Java)

Host (Go)

Databricksトークン

（文字列）Databricksの個人用アクセストークン。

DATABRICKS_TOKEN

token

token (Python)

setToken (Java)

Token (Go)

DatabricksアカウントID

（文字列）DatabricksアカウントエンドポイントのDatabricksアカウントID。Databricksホストもhttps://accounts.gcp.databricks.comに設定されている場合にのみ効果があります。

DATABRICKS_ACCOUNT_ID

account_id

account_id (Python)

setAccountID (Java)

AccountID (Go)

ClusterID

(文字列)使用するクラスターの ID

DATABRICKS_CLUSTER_ID

cluster_id

cluster_id

サーバーレスコンピュート

(文字列)サーバレスコンピュート自動有効化の設定です。 有効な値は autoです。

DATABRICKS_SERVERLESS_COMPUTE_ID

serverless_compute_id

serverless_compute_id

一般的な名前

説明

環境変数

.databrickscfg フィールド、Terraformフィールド

Config フィールド

クライアントID

(文字列) Databricks サービスプリンシパルのクライアント ID。

DATABRICKS_CLIENT_ID

client_id

client_id (Python)

setClientId (Java)

ClientId (Go)

クライアントのシークレット

(文字列) Databricks サービスプリンシパルのクライアントシークレット。

DATABRICKS_CLIENT_SECRET

client_secret

client_secret (Python)

setClientSecret (Java)

ClientSecret (Go)

Google Cloudサービスアカウント

(文字列)Google クラウドサービスアカウントのメールアドレス。

DATABRICKS_GOOGLE_SERVICE_ACCOUNT

google_service_acccount

GoogleServiceAccount (Go)

Google Cloudの認証情報

（文字列）Google Cloudサービス アカウントキーファイルへのローカルパス、またはJSON形式のサービスアカウントキーファイルの内容。

GOOGLE_CREDENTIALS

google_credentials

GoogleCredentials (Go)

.databrickscfg 固有のフィールド​

これらの環境変数またはフィールドを使用して、 .databrickscfgのデフォルト以外の設定を指定します。 Databricks 構成プロファイルも参照してください。

一般的な名前

説明

環境変数

Terraformフィールド

Config フィールド

.databrickscfg ファイルパス

（文字列）.databrickscfgファイルへのデフォルト以外のパス。

DATABRICKS_CONFIG_FILE

config_file

config_file (Python)

setConfigFile (Java)

ConfigFile (Go)

.databrickscfg デフォルトプロファイル

（文字列）使用するデフォルトの名前付きプロファイル（DEFAULT以外）。

DATABRICKS_CONFIG_PROFILE

profile

profile (Python)

setProfile (Java)

Profile (Go)

認証フィールド​

これらの環境変数またはフィールドを使用して、特定の種類の Databricks 認証を適用します。

一般的な名前

説明

環境変数

Terraformフィールド

Config フィールド

Databricks認証タイプ

(文字列)環境で複数の認証属性が使用可能な場合は、この引数で指定された認証タイプを使用します。「サポートされている認証タイプ」を参照してください。

DATABRICKS_AUTH_TYPE

auth_type

auth_type (Python)

setAuthType (Java)

AuthType (Go)

OIDC トークン環境変数

(文字列)IdP が発行した OIDC トークンを含む環境変数の名前。env-oidc認証タイプで使用します。デフォルトは DATABRICKS_OIDC_TOKENです。

DATABRICKS_OIDC_TOKEN_ENV

oidc_token_env

oidc_token_env (Python)

setOIDCTokenEnv (Java)

OIDCTokenEnv (Go)

OIDC トークン・ファイル・パス

(文字列)IdP が発行した OIDC トークンを含むローカルファイルへのパス。file-oidc認証タイプで使用します。

DATABRICKS_OIDC_TOKEN_FILEPATH

oidc_token_filepath

oidc_token_filepath (Python)

setOIDCTokenFilepath (Java)

OIDCTokenFilepath (Go)

サポートされている認証タイプ​

サポートされているDatabricks認証タイプのフィールド値は以下のとおりです。

に最終更新