`auth` コマンドグループ

Note

この情報は、Databricks CLI バージョン 0.205 以降に適用されます。 Databricks CLI はパブリックプレビュー段階です。

Databricks CLI の使用には、Databricks ライセンスおよび使用状況データのプロビジョニングを含むDatabricks のプライバシーに関する通知が適用されます。

auth 内のコマンドグループには、次のような認証関連のコマンドが含まれています。

使用可能な認証構成プロファイルを一覧表示します。
個々の認証構成プロファイルに関する情報を取得します。
OAuth ユーザー対マシン (U2M) 認証を使用して、Azure Databricks アカウントとワークスペースで Databricks CLI を認証します。
Databricks CLI がキャッシュした可能性のある OAuth アクセストークンに関する情報を取得します。
Databricks CLI が認証に使用している構成の詳細を取得します。

Tip

現在の Databricks CLI ユーザーに関する情報を取得するには、 databricks current-user me実行します。

databricks 認証の説明

資格情報と資格情報のソースなど、Databricks CLI が認証に使用する構成について説明します。オプションが指定されていない場合、 auth describe コマンドは認証方法の優先順位に従います。

databricks auth describe [flags]

オプション

--sensitive

パスワードやトークンなどの機密性の高いフィールドを出力に含める

グローバルフラグ

例示

次の例では、現在の認証構成について説明します。

databricks auth describe

Host: https://<workspace-instance-name>
User: <user-name>@<domain>
Authenticated with: <authentication-type>
-----
Current configuration:
  ✓ host: https://<workspace-instance-name> (from <path>/<to>/.databrickscfg config file)
  ✓ profile: default
  ✓ auth_type: <authentication-type> (from <path>/<to>/.databrickscfg config file)

特定の Azure Databricks ワークスペースに関する情報を使用するように指定するには、ワークスペースの URL と共に --host オプションを指定します。

databricks auth describe --host https://<workspace-instance-name>

Host: https://<workspace-instance-name>
User: <user-name>@<domain>
Authenticated with: <authentication-type>
-----
Current configuration:
  ✓ host: https://<workspace-instance-name> (from --host flag)
  ✓ profile: default
  ✓ auth_type: <authentication-type>

特定の Azure Databricks アカウントに関する情報を使用するように指定するには、Azure Databricks アカウントコンソール URL --host と共に https://accounts.azuredatabricks.net オプションを指定します。

databricks auth describe --host <account-console-url>

Host: <account-console-url>
User: <user-name>@<domain>
AccountId: <account-id>
Authenticated with: <authentication-type>
-----
Current configuration:
  ✓ host: <account-console-url> (from --host flag)
  ✓ account_id: <account-id>
  ✓ profile: default
  ✓ auth_type: <authentication-type>

特定の Azure Databricks 構成プロファイルに関する情報を使用するように指定するには、プロファイルの名前と共に -p または --profile オプションを指定します。

databricks auth describe -p TEST

Host: https://<workspace-instance-name>
User: <user-name>@<domain>
Authenticated with: <authentication-type>
-----
Current configuration:
  ✓ host: https://<workspace-instance-name> (from <path>/<to>/.databrickscfg config file)
  ✓ token: ******** (from <path>/<to>/.databrickscfg config file)
  ✓ profile: TEST (from --profile flag)
  ✓ auth_type: <authentication-type>

出力に機密情報 (Azure Databricks 個人用アクセストークンやクライアントシークレットなど) を含めるには、 --sensitive オプションを指定します。

databricks auth describe --sensitive

Host: https://<workspace-instance-name>
User: <user-name>@<domain>
Authenticated with: pat
-----
Current configuration:
  ✓ host: https://<workspace-instance-name> (from <path>/<to>/.databrickscfg config file)
  ✓ token: <token-value> (from <path>/<to>/.databrickscfg config file)
  ✓ profile: <profile-name>
  ✓ auth_type: pat

databricks 認証環境

プロファイルの名前、Azure Databricks アカウントコンソール URL、または Azure Databricks ワークスペース URL を使用して、既存の構成プロファイルに関する情報を取得します。

databricks auth env [flags]

Tip

構成プロファイル名を手動で入力する代わりに、Tab または --profile の後に -p を押して、選択できる既存の構成プロファイルの一覧を表示することができます。

構成プロファイルを作成するには、 configure コマンドを参照してください。

オプション

--host string

認証環境を取得するホスト名

Note

--host 値に一致するプロファイルが複数ある場合は、一致するプロファイルが 1 つも見つからないというエラーが表示されます。たとえば、ホスト値のみを持つプロファイルと、同じホスト値だけでなくトークン値を持つ別のプロファイルがあるとします。この場合、Databricks CLI はプロファイルを選択せず、停止します。 Databricks CLI で目的のプロファイルを選択できるようにするには、別の --host 値を指定してみてください。アカウントコンソールの URL である --host 値の場合は、--account-id 値の代わりに --host 値を指定してみてください。

--profile string

認証環境を取得するプロファイル

グローバルフラグ

例示

次の例では、既定の認証環境を取得します。

databricks auth env

次の例では、特定のホストの認証環境を取得します。

databricks auth env --host https://my-workspace.cloud.databricks.com

Azure Databricks アクセストークン認証で構成されているプロファイルの出力は、次のようになります。

{
  "env": {
    "DATABRICKS_AUTH_TYPE": "pat",
    "DATABRICKS_CONFIG_PROFILE": "TEST",
    "DATABRICKS_HOST": "https://my-workspace.cloud.databricks.com",
    "DATABRICKS_TOKEN": "<token-value>"
  }
}

次の例では、特定のプロファイルの認証環境を取得します。

databricks auth env --profile my-test-environment

Databricks ワークスペースまたはアカウントにログインし、認証構成をプロファイルに保存します (既定では ~/.databrickscfg )。その後、プロファイルを使用して、 --profile フラグを使用して他の Databricks CLI コマンドを認証できます。このプロファイルを使用して、Databricks Python、Java、Go SDK など、Databricks 統合認証をサポートする他の Databricks ツールを認証することもできます。

databricks auth login HOST [flags]

このコマンドでは、Databricks ホスト URL ( --host を使用するか、位置引数として使用するか、指定したプロファイル名から暗黙的に推論) とプロファイル名 ( --profile を使用) を指定する必要があります。これらの値を指定しない場合は、実行時に値の入力を求められます。

このコマンドは常に指定されたホストにログインしますが、動作は構成ファイルに設定した既存のプロファイルによって異なります (既定では ~/.databrickscfg )。

指定した名前のプロファイルが存在し、ホストを指定している場合は、プロファイルで指定されたホストにログインします。プロファイルは、認証の種類として "databricks-cli" を使用するように更新されます (以前はそうではなかった場合)。
指定した名前のプロファイルが存在するが、ホストを指定していない場合は、ホストを指定するように求められます。プロファイルは、指定されたホストを使用するように更新されます。以前はそうではなかった場合、認証の種類は "databricks-cli" に更新されます。
指定した名前のプロファイルが存在し、ホストを指定しているが、 --host を使用してホストを指定した場合 (または HOST 位置指定引数として)、新しく指定されたホストを使用するようにプロファイルが更新されます。以前はそうではなかった場合、認証の種類は "databricks-cli" に更新されます。
指定した名前のプロファイルが存在しない場合は、指定したホストで新しいプロファイルが作成されます。認証の種類は "databricks-cli" に設定されます。

論争

HOST

Databricks ホスト URL (省略可能)

オプション

--configure-cluster

クラスターを構成するためのプロンプト (クラシックコンピューティング)

--configure-serverless

サーバーレスコンピューティングを構成するためのプロンプト

--timeout duration

ブラウザーでログインチャレンジを完了するためのタイムアウト (既定値は 1h0m0s)

グローバルフラグ

例示

次の例では、Databricks ワークスペースにログインします。

databricks auth login

次の例では、特定の Databricks ワークスペースにログインします。

databricks auth login https://my-workspace.cloud.databricks.com

次の例では、特定のプロファイルでログインし、クラスター設定を構成します。

databricks auth login --profile my-profile --configure-cluster

次の例では、ログインプロセスのカスタムタイムアウトを設定します。

databricks auth login --timeout 30m

databricks 認証プロファイル

使用可能なすべての構成プロファイル (既定では ~/.databrickscfg ) を一覧表示し、有効なプロファイルであるかどうかを確認します。

databricks auth profiles [flags]

このコマンドは、プロファイルを次の形式で出力します。

Name            Host                Valid
DEFAULT         https://<host-url>  YES
<profile-name>  https://<host-url>  NO

各プロファイルが有効かどうかを判断するために、Databricks CLI はアカウントレベルのプロファイルごとにワークスペースを一覧表示し、ワークスペースレベルのプロファイルごとに現在のユーザーの取得コマンドを実行します。コマンドが成功すると YES が表示され、それ以外の場合は NO が表示されます。

auth profiles コマンドの出力には、アクセストークンは表示されません。アクセストークンを表示するには、 databricks 認証環境を参照してください。

既定では、構成プロファイルは、Linux または macOS 上のファイル ~/.databrickscfg 、または Windows 上の %USERPROFILE%\.databrickscfg に格納されます。環境変数 DATABRICKS_CONFIG_FILE を設定することによって、このファイルの既定のパスを変更できます。

構成プロファイルを作成するには、 configure コマンドを参照してください。

オプション

--skip-validate

プロファイルの検証をスキップするかどうか

グローバルフラグ

例示

次の例では、すべての認証プロファイルを一覧表示します。

databricks auth profiles

次の例では、プロファイルを検証せずに一覧表示します。

databricks auth profiles --skip-validate

databricks 認証トークン

~/.databricks/token-cache.jsonのローカルキャッシュから認証トークンを取得します。有効期限が切れている場合は、アクセストークンを更新します。このコマンドは U2M 認証でのみ機能します ( databricks auth login コマンドを使用)。クライアント ID とシークレットを使用した M2M 認証はサポートされていません。

databricks auth token [HOST] [flags]

OAuth U2M 認証を構成して設定するには、 OAuth ユーザーからマシンへの認証 (U2M) を参照してください。

論争

HOST

Databricks ホスト URL (省略可能)

オプション

--account-id string

Databricks アカウント ID

--timeout duration

トークンを取得するためのタイムアウト。 (既定値は 1h0m0s)

グローバルフラグ

例示

次の例では、認証トークンを取得します。

databricks auth token

次の例では、特定のホストの認証トークンを取得します。

databricks auth token https://my-workspace.cloud.databricks.com

出力は次のようになります。

{
  "access_token": "<token-value>",
  "token_type": "Bearer",
  "expiry": "<token-expiration-date-time>"
}

次の例では、トークン取得のカスタムタイムアウトを設定します。

databricks auth token --timeout 30m

グローバルフラグ

--debug

デバッグログを有効にするかどうかを指定します。

-h または --help

Databricks CLI、または関連コマンドグループ、または関連コマンドのヘルプの表示。

--log-file 文字列

出力ログを書き込むファイルを表す文字列。このフラグが指定されていない場合、既定では stderr に出力ログが書き込まれます。

--log-format 形式

ログ形式の種類、 text 、または json。既定値は text です。

--log-level 文字列

ログ形式レベルを表す文字列。指定しない場合、ログ形式レベルは無効になります。

-o, --output 型

コマンド出力の種類( text または json)。既定値は text です。

-p, --profile 文字列

コマンドの実行に使用する ~/.databrickscfg ファイル内のプロファイルの名前。このフラグが指定されていない場合は、存在する場合は、 DEFAULT という名前のプロファイルが使用されます。

--progress-format 形式

進行状況ログを表示する形式: default、 append、 inplace、または json

-t, --target 文字列

該当する場合は、使用するバンドルターゲット

フィードバック

このページはお役に立ちましたか?

Last updated on 2025-10-24

次の方法で共有

auth コマンド グループ

databricks 認証の説明

オプション

例示

databricks 認証環境

オプション

例示

databricks 認証ログイン

論争

オプション

例示

databricks 認証プロファイル

オプション

例示

databricks 認証トークン

論争

オプション

例示

グローバル フラグ

フィードバック

その他のリソース

`auth` コマンドグループ

グローバルフラグ