auth コマンド グループ

注記

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

Databricks CLI 使用には、使用状況データを含む Databricks ライセンス および Databricks プライバシー通知が適用されます。

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

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

ヒント

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

databricks auth describe

Databricks CLI が認証に使用している構成 (資格情報とその資格情報のソースなど) について説明します。オプションが指定されていない場合、 auth describe コマンドは 、クライアント統合認証のデフォルト方式に従います。

databricks auth describe [flags]

オプション

--sensitive

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

グローバルフラグ

例

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

Bash

databricks auth describe

Output

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)

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

Bash

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

Output

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>

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

Bash

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

Output

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>

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

Bash

databricks auth describe -p TEST

Output

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>

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

Bash

databricks auth describe --sensitive

Output

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 auth env

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

databricks auth env [flags]

ヒント

構成プロファイル名を手動で入力する代わりに、--profileまたは-pの後にTabを押すと、選択可能な既存の構成プロファイルのリストが表示されます。

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

オプション

--host string

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

注記

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

--profile string

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

グローバルフラグ

例

次の例では、デフォルトの認証環境を取得します。

Bash

databricks auth env

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

Bash

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

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

JSON

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

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

Bash

databricks auth env --profile my-test-environment

databricks auth login

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

databricks auth login HOST [flags]

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

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

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

引数

HOST

Databricks ホスト URL (省略可能)

オプション

--configure-cluster

クラスターを設定するプロンプト

--timeout duration

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

グローバルフラグ

例

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

Bash

databricks auth login

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

Bash

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

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

Bash

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

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

Bash

databricks auth login --timeout 30m

databricks auth profiles

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

databricks auth profiles [flags]

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

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

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

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

デフォルトでは、構成プロファイルは、Linux または macOS ではファイル ~/.databrickscfg 、Windows では %USERPROFILE%\.databrickscfg に保存されます。このファイルのデフォルトパスは、環境変数 DATABRICKS_CONFIG_FILEを設定することで変更できます。

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

オプション

--skip-validate

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

グローバルフラグ

例

次の例は、すべての認証プロファイルをリストします。

Bash

databricks auth profiles

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

Bash

databricks auth profiles --skip-validate

databricks auth token

~/.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)

グローバルフラグ

例

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

Bash

databricks auth token

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

Bash

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

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

JSON

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

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

Bash

databricks auth token --timeout 30m

グローバルフラグ

--debug

デバッグログを有効にするかどうか。

-h または --help

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

--log-file string

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

--log-format format

ログ・フォーマット・タイプ ( text または json) 。デフォルト値は textです。

--log-level string

ログ形式レベルを表す文字列。指定しない場合、ログ・フォーマット・レベルは使用不可になります。

-o, --output タイプ

コマンド出力タイプ text または json。デフォルト値は textです。

-p, --profile string

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

--progress-format format

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

-t, --target string

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