apps コマンド グループ
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。Databricks CLI は パブリック プレビュー段階です。
Databricks CLI 使用には、使用状況データを含む Databricks ライセンス および Databricks プライバシー通知が適用されます。
Databricks CLI 内の apps コマンド グループを使用すると、アプリを管理できます。アプリは、顧客の Databricks インスタンスで直接実行され、データと統合し、Databricks サービスを使用および拡張し、ユーザーがシングル サインオンを通じて対話できるようにします。「 Databricks アプリ」を参照してください。
databricks apps create
新しいアプリを作成します。
databricks apps create NAME [flags]
引数
NAME
アプリの名前。名前には、小文字の英数字とハイフンのみを含める必要があります。ワークスペース内で一意である必要があります。
オプション
--budget-policy-id string
アプリの予算ポリシー ID。
--description string
アプリの説明。
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
--no-compute
true の場合、アプリは作成後に起動されません。
--no-wait
ACTIVE 状態になるのを待たないでください。
--timeout duration
ACTIVE状態に達するまでの最大時間(デフォルトは20m0s)。
例
次の例では、基本的なアプリを作成します。
databricks apps create my-analytics-app --description "Analytics dashboard app"
次の例では、アプリを起動せずに作成します。
databricks apps create my-data-app --description "Data processing app" --no-compute
次の例では、カスタム タイムアウトを持つアプリを作成します。
databricks apps create my-ml-app --description "Machine learning app" --timeout 30m
databricks apps delete
アプリを削除します。
databricks apps delete NAME [flags]
引数
NAME
アプリの名前。
オプション
例
次の例では、アプリを削除します。
databricks apps delete my-analytics-app
databricks apps deploy
指定された名前でアプリのアプリ展開を作成します。
databricks apps deploy APP_NAME [flags]
引数
APP_NAME
アプリの名前。
オプション
--deployment-id string
デプロイの一意の ID。
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
--mode AppDeploymentMode
デプロイメントがソース・コードを管理するモード。サポートされている値: AUTO_SYNC、 SNAPSHOT。
--no-wait
SUCCEEDED状態になるまで待たないでください。
--source-code-path string
アプリのデプロイの作成に使用されるソースコードのワークスペースファイルシステムパス。
--timeout duration
SUCCEEDED 状態に達するまでの最大時間 (デフォルト 20m0s)。
例
次の例では、自動同期モードでデプロイを作成します。
databricks apps deploy my-analytics-app --source-code-path /Workspace/Users/someone@example.com/my-app --mode AUTO_SYNC
次の例では、スナップショット モードでデプロイを作成します。
databricks apps deploy my-data-app --source-code-path /Workspace/Users/someone@example.com/data-app --mode SNAPSHOT
次の例では、カスタムデプロイ ID を使用してデプロイを作成します。
databricks apps deploy my-ml-app --deployment-id "v1.2.3" --source-code-path /Workspace/Users/someone@example.com/ml-app
databricks apps get
指定された名前でアプリの情報を取得します。
databricks apps get NAME [flags]
引数
NAME
アプリの名前。
オプション
例
次の例では、アプリ情報を取得します。
databricks apps get my-analytics-app
次の例では、アプリ情報を JSON 形式で取得します。
databricks apps get my-data-app --output json
次の例では、特定のプロファイルを使用してアプリ情報を取得します。
databricks apps get my-ml-app --profile production
databricks apps get-deployment
指定された名前とデプロイ ID を使用して、アプリのデプロイに関する情報を取得します。
databricks apps get-deployment APP_NAME DEPLOYMENT_ID [flags]
引数
APP_NAME
アプリの名前。
DEPLOYMENT_ID
デプロイの一意の ID。
オプション
例
次の例では、デプロイ情報を取得します。
databricks apps get-deployment my-analytics-app v1.0.0
次の例では、デプロイ情報を JSON 形式で取得します。
databricks apps get-deployment my-data-app v2.1.0 --output json
次の例では、特定のプロファイルを使用してデプロイ情報を取得します。
databricks apps get-deployment my-ml-app latest --profile production
databricks apps list
ワークスペース内のすべてのアプリを一覧表示します。
databricks apps list [flags]
引数
なし
オプション
--page-size int
返されるアイテムの上限。
--page-token string
アプリの次のページに移動するページネーショントークン。
例
次の例は、すべてのアプリを一覧表示します。
databricks apps list
次の例は、特定のページ サイズのアプリを一覧表示します。
databricks apps list --page-size 10
次の例は、ページネーションを含むアプリを一覧表示します。
databricks apps list --page-token "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
databricks apps list-deployments
指定された名前でアプリのすべてのアプリ展開を一覧表示します。
databricks apps list-deployments APP_NAME [flags]
引数
APP_NAME
アプリの名前。
オプション
--page-size int
返されるアイテムの上限。
--page-token string
アプリの次のページに移動するページネーショントークン。
例
次の例は、アプリのすべてのデプロイを一覧表示します。
databricks apps list-deployments my-analytics-app
次の例は、特定のページサイズのデプロイメントをリストします。
databricks apps list-deployments my-data-app --page-size 10
databricks apps run-local
アプリをローカルで起動します。
databricks apps run-local [flags]
引数
なし
オプション
--app-port int
アプリを実行するポート (デフォルト 8000)。
--debug
デバッグモードを有効にします。
--debug-port string
デバッガーを実行するポート。
--entry-point string
アプリの構成 (.yml ファイル) を使用してカスタム エントリ ポイントを指定します。デフォルトは app.ymlです。
--env strings
環境変数を設定します。
--port int
アプリ プロキシを実行するポート (デフォルト 8001)。
--prepare-environment
アプリを実行するための環境を準備します。uv をインストールする必要があります。
例
次の例は、 アプリをローカルに実行します デフォルト設定:
databricks apps run-local
次の例では、特定のポートでアプリをローカルに実行します。
databricks apps run-local --app-port 9000 --port 9001
databricks apps start
ワークスペースでアプリの最後のアクティブなデプロイを開始します。
databricks apps start NAME [flags]
引数
NAME
アプリの名前。
オプション
--no-wait
ACTIVE 状態になるのを待たないでください。
--timeout duration
ACTIVE状態に達するまでの最大時間(デフォルトは20m0s)。
例
次の例では、アプリを起動します。
databricks apps start my-analytics-app
次の例では、待機せずにアプリを起動します。
databricks apps start my-data-app --no-wait
次の例では、カスタム タイムアウトでアプリを起動します。
databricks apps start my-ml-app --timeout 30m
databricks apps stop
ワークスペースでのアプリのアクティブなデプロイを停止します。
databricks apps stop NAME [flags]
引数
NAME
アプリの名前。
オプション
--no-wait
STOPPED 状態に達するのを待たないでください。
--timeout duration
STOPPED 状態に達するまでの最大時間 (デフォルトは 20 分 0 秒)。
例
次の例では、アプリを停止します。
databricks apps stop my-analytics-app
次の例では、待機せずにアプリを停止します。
databricks apps stop my-data-app --no-wait
次の例では、カスタム タイムアウトでアプリを停止します。
databricks apps stop my-ml-app --timeout 30m
databricks apps update
指定した名前でアプリを更新します。
databricks apps update NAME [flags]
引数
NAME
アプリの名前。名前には、小文字の英数字とハイフンのみを含める必要があります。ワークスペース内で一意である必要があります。
オプション
--budget-policy-id string
アプリの予算ポリシー ID。
--description string
アプリの説明。
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
例
次の例では、アプリの説明を更新します。
databricks apps update my-analytics-app --description "Updated analytics dashboard"
Databricks アプリ get-permission-levels
アプリの権限レベルを取得します。
databricks apps get-permission-levels APP_NAME [flags]
引数
APP_NAME
アクセス許可を取得または管理するアプリ。
オプション
例
次の例では、アプリのアクセス許可レベルを取得します。
databricks apps get-permission-levels my-analytics-app
databricks apps get-permissions
アプリのアクセス許可を取得します。アプリは、ルート オブジェクトからアクセス許可を継承できます。
databricks apps get-permissions APP_NAME [flags]
引数
APP_NAME
アクセス許可を取得または管理するアプリ。
オプション
例
次の例では、アプリのアクセス許可を取得します。
databricks apps get-permissions my-analytics-app
次の例では、特定のプロファイルを使用してアクセス許可を取得します。
databricks apps get-permissions my-ml-app --profile production
databricks apps set-permissions
アプリの権限を設定します。
オブジェクトに対する権限を設定し、既存の権限が存在する場合は置き換えます。指定されていない場合は、すべての直接アクセス許可を削除します。オブジェクトは、ルート オブジェクトからアクセス許可を継承できます。
databricks apps set-permissions APP_NAME [flags]
引数
APP_NAME
アクセス許可を取得または管理するアプリ。
オプション
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
例
次の例では、JSON 設定を使用してアクセス許可を設定します。
databricks apps set-permissions my-analytics-app --json '{"access_control_list": [{"user_name": "someone@example.com", "permission_level": "CAN_USE"}]}'
databricks apps update-permissions
アプリのアクセス許可を更新します。アプリは、ルート オブジェクトからアクセス許可を継承できます。
databricks apps update-permissions APP_NAME [flags]
引数
APP_NAME
アクセス許可を取得または管理するアプリ。
オプション
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
例
次の例では、JSON 設定を使用して権限を更新します。
databricks apps update-permissions my-analytics-app --json '{"access_control_list": [{"user_name": "someone@example.com", "permission_level": "CAN_MANAGE"}]}'
グローバルフラグ
--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
該当する場合は、使用するバンドル・ターゲット