注
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。 Databricks CLI は Public Preview です。
Databricks CLI の使用には、Databricks ライセンスおよび使用状況データのプロビジョニングを含むDatabricks のプライバシーに関する通知が適用されます。
Databricks コマンド ライン インターフェイス (Databricks CLI とも呼ばれます) は、ターミナル、コマンド プロンプト、または自動化スクリプトから Azure Databricks プラットフォームを自動化するための使いやすいインターフェイスを提供するユーティリティです。 「Databricks CLI とは」を参照してください。
この記事では、Databricks CLI をすばやくインストールして構成する方法について説明します。
ローカル コンピューターの要件を確認する
このチュートリアルでは、次のことを前提としています。
Linux または macOS の場合は、Homebrew がインストールされています。
注
Homebrew を使用できない場合は、他の方法で CLI をインストールする方法については、 Databricks CLI のインストールまたは更新を参照してください。
Windows の場合は、winget、Chocolatey、または Linux 用 Windows サブシステム (WSL) がインストールされています。 インストール手順については、オペレーティング システムのドキュメントを参照してください。
注
Chocolatey を使用した Databricks CLI のインストールは、試験段階です。
winget、Chocolatey、または WSL を使用できない場合は、他の方法で CLI をインストールする方法については、Databricks CLI のインストールまたは更新に関する記事を参照してください。
Databricks CLI をインストールする
まず、Databricks CLI をインストールします。
まだインストールされていない場合は、 Databricks CLI をインストールします。
Linux、macOS
Homebrew を使用し、次の 2 つのコマンドを実行して Databricks CLI をインストールします。
brew tap databricks/tap brew install databricksウィンドウズ
winget、Chocolatey または Linux 用 Windows サブシステム (WSL) を使用して、Databricks CLI をインストールできます。
winget、Chocolatey、WSL を使えない場合は、この手順をスキップし、代わりにコマンド プロンプトまたは PowerShell を使ってソースから Databricks CLI をインストールする必要があります。注
Chocolatey を使用した Databricks CLI のインストールは、試験段階です。
wingetを使用して Databricks CLI をインストールするには、次の 2 つのコマンドを実行し、コマンド プロンプトを再起動してください。winget search databricks winget install Databricks.DatabricksCLIChocolatey を使用して Databricks CLI をインストールするには、次のコマンドを実行します。
choco install databricks-cliWSL を使って Databricks CLI をインストールするには、次のようにします。
WSL を使用して
curlとzipをインストールします。 詳細については、オペレーティング システムのドキュメントを参照してください。WSL を使用して、次のコマンドを実行して Databricks CLI をインストールしてください。
curl -fsSL https://raw.githubusercontent.com/databricks/setup-cli/main/install.sh | sh
次のコマンドを実行して、Databricks CLI がインストールされていることを確認します。これにより、インストールされている Databricks CLI の現在のバージョンが表示されます。 このバージョンは 0.205.0 以降である必要があります。
databricks -v
ワークスペースへのアクセスを構成する
次に、Databricks ワークスペースへのアクセスを構成します。
注
このチュートリアルでは、OAuth ユーザー対マシン (U2M) 認証を使用して、Azure Databricks ユーザー アカウントを使用して CLI を認証します。 他の Databricks 認証の種類を使うように CLI を構成するには、「Databricks CLI の認証」を参照してください。
Databricks CLI を使用して、ターゲット アカウントまたはワークスペースごとに次のコマンドを実行し、OAuth トークン管理をローカルで開始してください。
アカウント レベルの操作の場合は、次のコマンドで、以下のプレースホルダーを置き換えます。
-
<account-console-url>を、お使いの Azure Databricks https://accounts.azuredatabricks.net に置き換えてください。 -
<account-id>を Azure Databricks アカウント ID に置き換えます。 「アカウント ID を特定する」を参照してください。
databricks auth login --host <account-console-url> --account-id <account-id>ワークスペース レベルの操作の場合は、次のコマンドで、
<workspace-url>を Azure Databricks のワークスペースごとの URL (https://adb-1234567890123456.7.azuredatabricks.netなど) に置き換えます。databricks auth login --host <workspace-url>-
Databricks CLI では、Azure Databricks 構成プロファイルとして入力した情報を保存するように求められます。
Enterキーを押して提案されたプロファイル名を受け入れるか、新規または既存のプロファイル名を入力します。 同じ名前の既存のプロファイルは、入力した情報で上書きされます。 プロファイルを使用すると、複数のアカウントまたはワークスペース間で認証コンテキストをすばやく切り替えることができます。既存のプロファイルの一覧を取得するには、別のターミナルまたはコマンド プロンプト内で、Databricks CLI を使用してコマンド
databricks auth profilesを実行します。 特定のプロファイルの既存の設定を表示するには、コマンドdatabricks auth env --profile <profile-name>を実行します。Web ブラウザー内で、画面の指示に従って Azure Databricks アカウントまたはワークスペースにログインしてください。
プロファイルの現在の OAuth トークン値とトークンの今後の有効期限のタイムスタンプを表示するには、次のいずれかのコマンドを実行します。
アカウント レベルの操作の場合は、次のコマンドを実行します。
databricks auth token -p <profile-name>databricks auth token --host <workspace-url> --account-id <account-id>databricks auth token --host <workspace-url> --account-id <account-id> -p <profile-name>
同じ
--host値と--account-id値を持つ複数のプロファイルがある場合は、Databricks CLI が正しく一致する OAuth トークン情報を見つけるのに役立つ--host、--account-id、および-pオプションを一緒に指定する必要があります。ワークスペース レベルの操作の場合は、次のコマンドを実行します。
databricks auth token -p <profile-name>databricks auth token --host <workspace-url>databricks auth token --host <workspace-url> -p <profile-name>
同じ
--host値を持つ複数のプロファイルがある場合は、Databricks CLI が正しく一致する OAuth トークン情報を見つけるのに役立つ--hostと-pオプションを一緒に指定することが必要になる場合があります。
次のステップ
- CLI の使用方法については、「Databricks CLI の基本的な使用方法」を参照してください。
- 使用可能な CLI コマンドの概要については、「Databricks CLI コマンド」を参照してください。
- CLI が実行されない場合、または予期しない結果が生成される場合は、「CLI のインストールを確認する」を参照してください。