統合認証のための環境変数とフィールド
このリファレンスでは、 Databricks クライアント統合認証の環境変数と構成フィールドを一覧表示します。これらは、Databricks CLI、Terraform プロバイダー、Python、Java、Go 用の SDK 全体で一貫して機能します。
このリファレンスを使用して、認証を設定したり、認証の問題をトラブルシューティングしたりします。各エントリーには次のものが含まれます。
- 環境変数: シェル環境で設定します。
.databrickscfg
フィールド: これは構成プロファイルで使用します。- Terraformフィールド: これをTerraformプロバイダ・ブロックで構成します。Databricks Terraform プロバイダーのドキュメントの 「認証」 を参照してください。
Config
フィールド: これは、Config
API を使用してプログラムで SDK を構成する場合に使用します。
一般構成フィールド
これらの変数は、 Databricksの基本的な接続とコンピュート設定を構成します。
一般的な名前 | 説明 | 環境変数 |
|
|
---|---|---|---|---|
Databricksホスト | (文字列)DatabricksワークスペースエンドポイントまたはDatabricksアカウントエンドポイントのDatabricksホストURL。 |
|
|
|
Databricksトークン | (文字列)Databricksの個人用アクセストークン。 |
|
|
|
DatabricksアカウントID | (文字列)DatabricksアカウントエンドポイントのDatabricksアカウントID。Databricksホストも |
|
|
|
ClusterID | (文字列)使用するクラスターの ID |
|
|
|
サーバーレスコンピュート | (文字列)サーバレスコンピュート自動有効化の設定です。 有効な値は |
|
|
|
User フィールドとサービスプリンシパルフィールド
これらの変数は、ユーザー名とサービスプリンシパル Databricks 認証を設定します。
一般的な名前 | 説明 | 環境変数 |
|
|
---|---|---|---|---|
Databricksのユーザー名 | (文字列)Databricks ユーザーのユーザー名。 |
|
|
|
サービスプリンシパルのクライアントID | (文字列) Databricks サービスプリンシパルのクライアント ID。 |
|
|
|
サービスプリンシパルのシークレット | (文字列)サービスプリンシパルの秘密 Databricks 。 |
|
|
|
.databrickscfg 固有のフィールド
これらの環境変数またはフィールドを使用して、 .databrickscfg
のデフォルト以外の設定を指定します。 Databricks 構成プロファイルも参照してください。
一般的な名前 | 説明 | 環境変数 | Terraformフィールド |
|
---|---|---|---|---|
| (文字列) |
|
|
|
| (文字列)使用するデフォルトの名前付きプロファイル( |
|
|
|
認証フィールド
これらの環境変数またはフィールドを使用して、特定の種類の Databricks 認証を適用します。
一般的な名前 | 説明 | 環境変数 | Terraformフィールド |
|
---|---|---|---|---|
Databricks認証タイプ | (文字列)環境で複数の認証属性が使用可能な場合は、この引数で指定された認証タイプを使用します。「サポートされている認証タイプ」を参照してください。 |
|
|
|
OIDC トークン環境変数 | (文字列)IdP が発行した OIDC トークンを含む環境変数の名前。 |
|
|
|
OIDC トークン・ファイル・パス | (文字列)IdP が発行した OIDC トークンを含むローカルファイルへのパス。 |
|
|
|
サポートされている認証タイプ
サポートされているDatabricks認証タイプのフィールド値は以下のとおりです。
oauth-m2m
: OAuth 2.0 までのDatabricksサービスプリンシパルを使用したマシン間 (M2M) 認証に使用します。「サービスプリンシパルのDatabricksへのアクセスをOAuthで認証する」を参照してください。pat
: Databricks個人アクセストークンで認証する場合に使用します。個人アクセストークン認証Databricksを参照してください。databricks-cli
: Databricks CLI と OAuth 2.0 を使用して対話形式でサインインする場合に使用します。「 OAuth を使用して Databricks へのユーザー アクセスを承認する」を参照してください。oidc-token
: Databricks が IdP 発行の OIDC トークンを Databricks OAuth トークンと交換する ID プロバイダー (IdP) とのトークン フェデレーションに使用します。「 OAuth トークン フェデレーションを使用して Databricks へのアクセスを認証する」を参照してください。env-oidc
: IdP トークンが環境変数 (デフォルトはDATABRICKS_OIDC_TOKEN
) に格納されている場合に使用します。「 OAuth トークン フェデレーションを使用して Databricks へのアクセスを認証する」を参照してください。file-oidc
: IdP トークンがDATABRICKS_OIDC_TOKEN_FILEPATH
によって参照されるローカルファイルに保存されている場合に使用します。「 OAuth トークン フェデレーションを使用して Databricks へのアクセスを認証する」を参照してください。github-oidc
: GitHub Actions フェデレーション認証に使用し、GitHub は Databricks が Databricks OAuth トークンと交換する OIDC トークンを発行します。例については、「 CI/CD でのワークロード ID フェデレーションの有効化」を参照してください。