auth
コマンド グループ
注
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。 Databricks CLI は パブリック プレビュー段階です。
Databricks CLI 使用には、 Databricks ライセンス および Databricks プライバシー通知(使用データのプロビジョニングを含む)が適用されます。
Databricks CLI 内の auth
コマンド グループを使用すると、次のことができます。
使用可能な認証構成プロファイルを一覧表示します。
個々の認証構成プロファイルに関する情報を取得します。
OAuth ユーザー間 (U2M) 認証を使用して、Databricks アカウントとワークスペースで Databricks CLI を認証します。
Databricks CLI がキャッシュした可能性のある OAuth アクセストークンに関する情報を取得します。
Databricks CLI が認証に使用している構成の詳細を取得します。
auth
コマンドを実行するには、コマンドを databricks auth
に追加します。auth
コマンドのヘルプを表示するには、 databricks auth -h
を実行します。
構成プロファイルの一覧表示
使用可能なすべての構成プロファイルのリストを取得し、それらが有効かどうかを確認するには、次のように auth profiles
コマンドを実行します。
databricks auth profiles
出力(省略記号は簡潔にするために省略されたコンテンツを表します):
Name Host Valid
DEFAULT https://<host-url> YES
<profile-name> https://<host-url> NO
各プロファイルが有効かどうかを判断するために、Databricks CLI では、アカウント レベルのプロファイルごとに list workspaces コマンドを実行し、ワークスペース レベルのプロファイルごとに get current user コマンドを実行します。 コマンドが成功すると、 YES
が表示されます。それ以外の場合は、 NO
が表示されます。
auth profiles
コマンドの出力には、アクセストークンは表示されません。アクセストークンを表示するには、「 構成プロファイルに関する情報を取得する」を参照してください。
構成プロファイルは、Linux または macOS ではファイル ~/.databrickscfg
に保存され、Windows ではデフォルトで %USERPROFILE%\.databrickscfg
に保存されます。 このファイルのデフォルトパスを変更するには、環境変数を DATABRICKS_CONFIG_FILE
に設定します。 環境変数の設定方法については、オペレーティング システムのマニュアルを参照してください。
構成プロファイルを作成するには、 configure コマンド グループを参照してください。
構成プロファイルに関する情報を取得する
既存の構成プロファイルに関する情報を取得するには、次のように、 <profile-name>
はプロファイルの名前を表し、 <account-or-workspace-url>
は Databricks アカウント コンソール URL または Databricks ワークスペース URL を表す auth env
コマンドを実行します。
databricks auth env --profile <profile-name>
# Or:
databricks auth env --host <account-or-workspace-url>
ヒント
構成プロファイル名を手動で入力する代わりに、--profile
または-p
の後に Tab
を押すと、既存の使用可能な構成プロファイルの一覧が表示され、そこから選択できます。
たとえば、Databricks アクセストークン認証で構成されたプロファイルの出力を次に示します。
{
"env": {
"DATABRICKS_AUTH_TYPE": "pat",
"DATABRICKS_CONFIG_PROFILE": "<profile-name>",
"DATABRICKS_HOST": "<workspace-url>",
"DATABRICKS_TOKEN": "<token-value>"
}
}
注
複数のプロファイルが --host
値と一致する場合は、一致するプロファイルが 1 つも見つからないことを示すエラーが表示されます。 例えば、ホスト値のみを持つプロファイルと、同じホスト値であるがトークン値も持つ別のプロファイルがあるとします。 この場合、Databricks CLI はプロファイルを選択せず、停止します。 Databricks CLI で目的のプロファイルを選択できるようにするには、別の --host
値を指定してみてください。 アカウントコンソールの URL である --host
値の場合は、 --host
値ではなく --account-id
値を指定してみてください。
設定プロファイルを作成するには、 configure コマンド グループを参照してください。
OAuth を使用した認証
アクセストークンと構成プロファイル を使用してDatabricksOAuth で認証する代わりに、 ユーザー対マシン (U2M) 認証を使用できます。OAuth は、 Databricks personal アクセストークンよりも短い有効期限をトークンに提供し、サーバー側のセッションの無効化とスコープを改善します。 OAuth アクセス トークンは 1 時間以内に期限切れになるため、誤ってトークンをソース コントロールにチェックインするリスクが軽減されます。「OAuth (OAuth U2M) を使用してユーザーアカウントで Databricks へのアクセスを認証する」を参照してください。
OAuth U2M 認証を構成および設定するには、「 OAuth ユーザー対マシン (U2M) 認証」を参照してください。
OAuth アクセストークンの詳細を取得する
Databricks CLI が以前に Databricks ワークスペース用に生成したキャッシュされた OAuth アクセストークンに関する情報を表示する場合は、次のように auth token
コマンドを実行します ( <workspace-url>
は Databricks ワークスペースの URL を表します)。
databricks auth token <workspace-url>
アウトプット:
{
"access_token": "<token-value>",
"token_type": "Bearer",
"expiry": "<token-expiration-date-time>"
}
認証の詳細を取得する
Databricks CLI が認証に使用している構成の詳細を取得するには、 auth describe
コマンドを実行します。
オプションが指定されていない場合、 auth describe
コマンドは 、クライアント統合認証のデフォルトの方法に従います。
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)
特定の 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>
特定の Databricks アカウントに関する情報が使用されるように指定するには、Databricks アカウント コンソール URL ( https://accounts.gcp.databricks.com ) とともに--host
オプションを指定します。
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>
特定の Databricks 構成プロファイルに関する情報が使用されるように指定するには、プロファイルの名前とともに-p
または--profile
オプションを指定します。
databricks auth describe -p <profile-name>
アウトプット:
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: <profile-name> (from --profile flag)
✓ auth_type: <authentication-type>
出力に機密情報 ( 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