Databricks クライアント統合認証

Databricks クライアント統合認証は、OAuth 認証の一部として Databricks への認証の設定と自動化を一元化します。 これにより、Databricks 認証を一度構成すると、認証構成をさらに変更することなく、その構成を複数の Databricks ツールや SDK で使用できます。

参加ツールとSDK

これに参加しているDatabricksツールとSDKには以下が含まれます。

• Databricks CLI の
• Databricks Terraform プロバイダー
• Databricks Connect
• Visual Studio Code の Databricks 拡張機能
• Databricks SDK for Python の場合
• Databricks SDK for Java の場合
• Databricks SDK for Go の場合

参加しているすべてのツールと SDK は、認証に特別な環境変数と Databricks 構成プロファイル を受け入れます。 Databricks Terraform プロバイダーと Python、Java、Go 用の Databricks SDK も、コード内の認証設定を直接構成できます。 詳細については、ツールまたは SDK のドキュメントについては、 ローカル開発ツール を参照してください。

クライアント統合認証のデフォルト方法

ツールやSDKDatabricksへのアクセスを承認する必要があるときは、デフォルトによって次の順序で次の種類の認証を試みます。ツールまたは SDK は、試行した認証の種類で成功すると、残りの認証の種類での認証の試行を停止します。 SDK に特定の認証の種類で認証を強制するには、 Config API の Databricks 認証の種類 フィールドを設定します。

1. Databricks個人用アクセストークン認証
2. Databricks リソースへの無人アクセスをサービスプリンシパルで承認する OAuth
3. OAuth を使用して、ユーザーアカウントで Databricks リソースへの対話型アクセスを承認します
4. Google Cloudの認証情報認証
5. Google Cloud ID認証

参加しているツールまたはSDKにより試行される認証タイプごとに、以下に示されるロケーションと順序でツールまたはSDKは認証資格情報を検索しようとします。ツールまたはSDKが使用可能な認証資格情報の検索に成功すると、ツールまたはSDKは残りのロケーションでの認証資格情報の検索を停止します。

1. 資格情報関連のConfig APIフィールド（SDKの場合）：Config フィールドを設定するには、SDKのリファレンスドキュメントを参照してください。
2. 資格情報関連の環境変数：
3. .databrickscfg ファイル内の DEFAULT 設定プロファイルの認証情報関連のフィールド。 設定プロファイルフィールドを設定するには、(/dev-tools/auth/config-profiles.md) を参照してください。
4. Google Cloud CLI によってキャッシュされる関連する認証認証情報。 Google Cloud ID 認証をご覧ください。

コードの移植性を最大限に高めるために、Databricks では、.databrickscfg ファイル内にカスタム構成プロファイルを作成し、ターゲットの Databricks 認証の種類に対して以下の必須フィールドをカスタム構成プロファイルに追加してから、DATABRICKS_CONFIG_PROFILE 環境変数をカスタム構成プロファイルの名前に設定することをお勧めします。

クライアント統合認証の環境変数とフィールド

以下の表は、Databricksクライアント統合認証でサポートされている環境変数とフィールドの名前と説明を示しています。表の説明は以下の通りです。

• 環境変数 は、該当する場合、環境変数の名前です。
• .databrickscfgフィールド (該当する場合) は、Databricks 構成プロファイル ファイルまたは Databricks Terraform 構成内のフィールドの名前です。.databrickscfgフィールドを設定するには、「Databricks 構成プロファイル」を参照してください。
• Terraformフィールド （該当する場合）は、Databricks Terraform設定内のフィールドの名前です。Databricks Terraformフィールドを設定するには、Databricks Terraformプロバイダーのドキュメントの「認証」を参照してください。
• Configフィールド は、指定されたSDKのConfig API内のフィールド名です。

一般的なホスト、トークン、およびアカウント ID の環境変数とフィールド

一般的な名前	説明	環境変数	.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)

Google Cloud 固有の環境変数とフィールド

一般的な名前	説明	環境変数	.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 Cloudサービスアカウントのメールアドレス。	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)

認証タイプフィールド

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

一般的な名前	説明	Terraformフィールド	Config フィールド
Databricks認証タイプ	（文字列）環境内で複数の認証属性が使用できる場合は、この引数で指定された認証タイプを使用します。	auth_type	auth_type (Python)、 setAuthType (Java)、 AuthType (Go)

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

• oauth-m2m:Databricks OAuth2.0 での M2M 認証に サービスプリンシパルを使用している場合は、この値を設定します。詳細については、「Databricksを使用してサービスプリンシパルを使用して リソースへの無人アクセスを承認OAuth する」を参照してください。

• pat: Databricks の個人用アクセス トークンを使用している場合は、この値を設定します。 詳細については、「 Databricks 個人用アクセス トークン認証」を参照してください。

• databricks-cli: OAuth 2.0 で Databricks CLI を使用している場合は、この値を設定します。 詳細については、「 OAuth を使用してユーザー アカウントで Databricks リソースへの対話型アクセスを承認する」を参照してください。

• google-id: Google ID を使用してアクセスを認証する場合は、この値を設定します。 詳細については、 Google Cloud ID 認証をご覧ください。