`auth` コマンドグループ

[アーティクル]
10/30/2024

Note

この情報は、Databricks CLI バージョン 0.205 以降に適用されます。 Databricks CLI は Public Preview です。

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

Databricks CLI 内の auth コマンドグループを使用すると、次のことが可能になります。

使用可能な認証構成プロファイルを一覧表示します。
個々の認証構成プロファイルに関する情報を取得します。
OAuth ユーザー対マシン (U2M) 認証を使用して、Azure 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 を設定することによって、このファイルの既定のパスを変更できます。環境変数の設定方法については、お使いのオペレーティングシステムのドキュメントを参照してください。

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

構成プロファイルに関する情報を取得する

既存の構成プロファイルに関する情報を取得するには、auth env コマンドを実行します。ここで <profile-name> はプロファイルの名前、<account-or-workspace-url> は Azure Databricks アカウントコンソール URL または Azure Databricks ワークスペース URL を表します。

databricks auth env --profile <profile-name>

# Or:
databricks auth env --host <account-or-workspace-url>

ヒント

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

例として、Azure Databricks アクセストークン認証で構成されたプロファイルの出力は次のとおりです。

{
  "env": {
    "DATABRICKS_AUTH_TYPE": "pat",
    "DATABRICKS_CONFIG_PROFILE": "<profile-name>",
    "DATABRICKS_HOST": "<workspace-url>",
    "DATABRICKS_TOKEN": "<token-value>"
  }
}

Note

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

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

OAuth での認証

アクセストークンと構成プロファイルを使用して Azure Databricks で認証する代わりに、OAuth ユーザー対マシン (U2M) 認証を使用することができます。 OAuth は、Azure Databricks 個人用アクセストークンよりも有効期限が短いトークンを提供し、サーバー側のセッションの無効化とスコープ設定を強化します。 OAuth アクセストークンは 1 時間以内に期限切れになるため、誤ってトークンをソース管理に確認することに関連するリスクが軽減されます。「OAuth (OAuth U2M)を使用してユーザーアカウントを使用して Azure Databricks へのアクセスを認証する」を参照してください。

OAuth U2M 認証を構成および設定するには、「OAuth ユーザー対マシン (U2M) 認証」をご参照ください。

OAuth アクセストークンの詳細を取得する

Databricks CLI が以前に Azure Databricks ワークスペース用に生成し、キャッシュされた OAuth アクセストークンに関する情報を表示する場合は、次のように auth token コマンドを実行します。<workspace-url> は Azure 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)

特定の 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 https://accounts.azuredatabricks.net と共に --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>

特定の Azure 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>

出力に機密情報 (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

次の方法で共有

`auth` コマンドグループ

構成プロファイルを一覧表示する

構成プロファイルに関する情報を取得する

OAuth での認証

OAuth アクセストークンの詳細を取得する

認証の詳細を取得する

フィードバック

その他のリソース

次の方法で共有

auth コマンド グループ

構成プロファイルを一覧表示する

構成プロファイルに関する情報を取得する

OAuth での認証

OAuth アクセス トークンの詳細を取得する

認証の詳細を取得する

フィードバック

その他のリソース

`auth` コマンドグループ

OAuth アクセストークンの詳細を取得する