このリファレンスでは、 Databricks 統合認証の環境変数と構成フィールドの一覧を示します。 これらは、Python、Java、Go 用の Databricks CLI、Terraform プロバイダー、SDK 全体で一貫して動作します。
このリファレンスを使用して、認証を設定するか、認証の問題のトラブルシューティングを行います。 各エントリには次のものが含まれます。
- 環境変数: これをシェル環境で設定します。
-
.databrickscfgフィールド:構成プロファイルで使用します。 - Terraform フィールド: Terraform プロバイダー ブロックでこれを構成します。 Databricks Terraform プロバイダーのドキュメントの 認証 を参照してください。
-
Configフィールド:Configを使用して SDK をプログラムで構成する場合に使用しますAPI。
一般的な構成フィールド
これらの変数は、Databricks の基本的な接続とコンピューティング設定を構成します。
| 共通名 | Description | 環境変数 |
.databrickscfg フィールド、Terraform フィールド |
Config フィールド |
|---|---|---|---|---|
| Azure Databricks ホスト | (文字列) Azure Databricks ワークスペース エンドポイントまたは Azure Databricks アカウント エンドポイントの Azure Databricks ホスト URL。 | DATABRICKS_HOST |
host |
host (パイソン)setHost (Java)Host (行く) |
| Azure Databricks トークン | (文字列) Azure Databricks 個人用アクセス トークンまたは Microsoft Entra ID トークン。 | DATABRICKS_TOKEN |
token |
token (パイソン)setToken (Java)Token (行く) |
| Azure Databricks アカウント ID | (文字列) Azure Databricks アカウント エンドポイントの Azure Databricks アカウント ID。 Azure Databricks ホストも https://accounts.azuredatabricks.net に設定されている場合にのみ有効です。 |
DATABRICKS_ACCOUNT_ID |
account_id |
account_id (パイソン)setAccountID (Java)AccountID (行く) |
| クラスター ID | (文字列)使用するクラスターの ID | DATABRICKS_CLUSTER_ID |
cluster_id |
cluster_id |
| サーバーレス コンピューティング | (文字列)サーバーレス コンピューティングの自動有効化設定。 有効な値は auto です。 |
DATABRICKS_SERVERLESS_COMPUTE_ID |
serverless_compute_id |
serverless_compute_id |
| 共通名 | Description | 環境変数 |
.databrickscfg フィールド、Terraform フィールド |
Config フィールド |
|---|---|---|---|---|
| Azure クライアント ID | (文字列)Microsoft Entra ID サービス プリンシパルのアプリケーション ID。 Azure マネージド ID 認証と Microsoft Entra ID サービス プリンシパル認証を使います。 | ARM_CLIENT_ID |
azure_client_id |
azure_client_id (パイソン)setAzureClientID (Java)AzureClientID (行く) |
| Azure クライアント シークレット | (文字列)Microsoft Entra ID サービス プリンシパルのクライアント シークレット。 Microsoft Entra ID サービス プリンシパル認証を使います。 | ARM_CLIENT_SECRET |
azure_client_secret |
azure_client_secret (パイソン)setAzureClientSecret (Java)AzureClientSecret (行く) |
| クライアントID | (文字列) Azure Databricks マネージド サービス プリンシパルまたは Microsoft Entra ID マネージド サービス プリンシパルのクライアント ID。 OAuth M2M 認証で使います。 | DATABRICKS_CLIENT_ID |
client_id |
client_id (パイソン)setClientId (Java)ClientId (行く) |
| クライアント シークレット | (文字列) Azure Databricks マネージド サービス プリンシパルまたは Microsoft Entra ID マネージド サービス プリンシパルのクライアント シークレット。 OAuth M2M 認証で使います。 | DATABRICKS_CLIENT_SECRET |
client_secret |
client_secret (パイソン)setClientSecret (Java)ClientSecret (行く) |
| Azure 環境 | (文字列) Azure 環境の種類。 既定値は PUBLIC です。 |
ARM_ENVIRONMENT |
azure_environment |
azure_environment (パイソン)setAzureEnvironment (Java)AzureEnvironment (行く) |
| Azure テナント ID | (文字列)Microsoft Entra ID サービス プリンシパルのテナント ID。 | ARM_TENANT_ID |
azure_tenant_id |
azure_tenant_id (パイソン)setAzureTenantID (Java)AzureTenantID (行く) |
| Azure use MSI (Azure で MSI を使用する) | (ブール値) サービス プリンシパルに Azure マネージド サービス ID パスワードレス認証フローを使用する場合は True。 Azure リソース ID も設定する必要があります。 | ARM_USE_MSI |
azure_use_msi |
AzureUseMSI (行く) |
| Azure リソース ID | (文字列) Azure Databricks ワークスペースの Azure Resource Manager ID。 | DATABRICKS_AZURE_RESOURCE_ID |
azure_workspace_resource_id |
azure_workspace_resource_id (パイソン)setAzureResourceID (Java)AzureResourceID (行く) |
.databrickscfg 固有のフィールド
これらの環境変数またはフィールドを使用して、既定以外の .databrickscfg の設定を指定します。 「Azure Databricks 構成プロファイル」も参照してください。
| 共通名 | Description | 環境変数 | Terraform フィールド |
Config フィールド |
|---|---|---|---|---|
.databrickscfg ファイル パス |
(文字列) .databrickscfg ファイルへの既定以外のパス。 |
DATABRICKS_CONFIG_FILE |
config_file |
config_file (パイソン)setConfigFile (Java)ConfigFile (行く) |
.databrickscfg の既定のプロファイル |
(文字列) 使用する既定の名前付きプロファイル (DEFAULT 以外)。 |
DATABRICKS_CONFIG_PROFILE |
profile |
profile (パイソン)setProfile (Java)Profile (行く) |
認証フィールド
これらの環境変数またはフィールドを使用して、特定の種類の Databricks 認証を適用します。
| 共通名 | Description | 環境変数 | Terraform フィールド |
Config フィールド |
|---|---|---|---|---|
| Databricks 認証の種類 | (文字列) 環境内で複数の認証属性を使用できる場合は、この引数で指定された認証の種類を使用します。 サポートされている認証の種類を参照してください。 | DATABRICKS_AUTH_TYPE |
auth_type |
auth_type (パイソン)setAuthType (Java)AuthType (行く) |
| OIDC トークン環境変数 | (文字列)IdP で発行された OIDC トークンを含む環境変数の名前。 認証の種類 env-oidc 使用されます。 既定値は DATABRICKS_OIDC_TOKEN です。 |
DATABRICKS_OIDC_TOKEN_ENV |
oidc_token_env |
oidc_token_env (パイソン)setOIDCTokenEnv (Java)OIDCTokenEnv (行く) |
| OIDC トークン ファイルのパス | (文字列)IdP で発行された OIDC トークンを含むローカル ファイルへのパス。 認証の種類 file-oidc 使用されます。 |
DATABRICKS_OIDC_TOKEN_FILEPATH |
oidc_token_filepath |
oidc_token_filepath (パイソン)setOIDCTokenFilepath (Java)OIDCTokenFilepath (行く) |
サポートされている認証の種類
サポートされている Databricks 認証の種類のフィールド値には、次のものがあります。
-
oauth-m2m: OAuth 2.0 を介した Databricks サービス プリンシパルによるマシン間 (M2M) 認証の場合。 OAuth を使用した Azure Databricks へのサービス プリンシパル アクセスの承認に関するページを参照してください。 -
pat: Databricks 個人用アクセス トークンを使用した認証用。 「Azure Databricks の個人用アクセス トークン (レガシ) を使用した認証」を参照してください。 -
databricks-cli: OAuth 2.0 を使用して Databricks CLI で対話型サインインを行う場合。 OAuth を使用した Azure Databricks へのユーザー アクセスの承認に関するページを参照してください。 -
oidc-token: Id プロバイダー (IdP) とのトークンフェデレーションの場合、Databricks は IdP で発行された OIDC トークンを Databricks OAuth トークンと交換します。 ID プロバイダー トークンを使用した認証を参照してください。 -
env-oidc: IdP トークンが環境変数 (DATABRICKS_OIDC_TOKEN) に格納されている場合のフェデレーションの場合。 ID プロバイダー トークンを使用した認証を参照してください。 -
file-oidc: IdP トークンがローカル ファイル (DATABRICKS_OIDC_TOKEN_FILEPATH) に格納されるときのフェデレーションの場合。 ID プロバイダー トークンを使用した認証を参照してください。 -
github-oidc: OIDC トークンを使用した GitHub Actions フェデレーション認証の場合。 GitHub Actions のワークロード ID フェデレーションを有効にするを参照してください。 -
azure-devops-oidc: OIDC トークンを使用した Azure DevOps フェデレーション認証の場合。 「Azure DevOps Pipelines のワークロード ID フェデレーションを有効にする」を参照してください。
-
azure-msi: Azure マネージド サービス ID (MSI) を使用した認証用。 「Azure マネージド ID を使用した認証」を参照してください。 -
azure-client-secret: クライアント シークレットを使用した Azure サービス プリンシパルによる認証用。 「Microsoft Entra サービス プリンシパルを使用した認証」を参照してください。