environmentsコマンドグループ
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。Databricks CLI はパブリックプレビュー版です。
Databricks CLI使用には、使用状況データ プロビジョニングを含むDatabricksライセンスおよびDatabricksプライバシー通知が適用されます。
Databricks CLI内のenvironmentsコマンドグループを使用すると、環境リソースを管理できます。環境API 、サーバーレス ノートブックとジョブで使用される環境のバージョンと依存関係を定義するワークスペース レベルの基本環境を含む、さまざまなタイプの環境の管理機能を提供します。
Databricks環境 ワークスペースベース環境の作成
新しいワークスペースベース環境を作成します。これは、依存関係の解決を最適化するために、マテリアライズド環境を非同期的に生成する長時間実行処理です。
databricks environments create-workspace-base-environment DISPLAY_NAME [flags]
議論
DISPLAY_NAME
ワークスペースの基本環境を表す、人間が読みやすい表示名。
オプション
--base-environment-type BaseEnvironmentType
基本環境の種類（CPUまたはGPU）。サポートされている値: CPU 、 GPU
--filepath string
ワークスペース ファイルまたはUnity Catalogボリュームの環境 YAML ファイルへのパス。
--json JSON
インラインJSON構文、またはリクエストボディを含むJSONファイルへの@path。
--name string
ワークスペースの基本環境のリソース名。
--no-wait
DONE状態に到達するまで待たないでください。
--request-id string
このリクエストの一意の識別子。
--timeout duration
DONE状態に到達するまでの最大時間。
--workspace-base-environment-id string
ワークスペースの基本環境に使用するID。これはリソース名の最終構成要素となります。
例
次の例では、CPU ワークスペースの基本環境を作成します。
databricks environments create-workspace-base-environment "My Python Env" --base-environment-type CPU --filepath /Workspace/environments/env.yaml
Databricks環境のワークスペースベース環境の削除
ワークスペースの基本環境を削除します。ベース環境を削除すると、リンクされているノートブックやジョブに影響が出る可能性があります。この手術は元に戻すことはできません。
databricks environments delete-workspace-base-environment NAME [flags]
議論
NAME
必須。削除するワークスペースベース環境のリソース名。形式: workspace-base-environments/{workspace_base_environment} 。
オプション
例
次の例では、ワークスペースの基本環境を削除します。
databricks environments delete-workspace-base-environment workspace-base-environments/my-env-id
Databricks環境のデフォルトワークスペースベース環境を取得
デフォルトのワークスペース基本環境設定を取得します。CPU と GPU コンピュートの両方の現在の安全な基本環境設定を返します。
databricks environments get-default-workspace-base-environment NAME [flags]
議論
NAME
デフォルトのワークスペースベース環境の静的なリソース名。形式: default-workspace-base-environment 。
オプション
例
次の例では、デフォルトのワークスペースベース環境を取得します。
databricks environments get-default-workspace-base-environment default-workspace-base-environment
データブリックス環境のget-operation
長時間実行中の操作のステータスを取得します。クライアントはこの方法を使用して、操作結果をポーリングできます。
databricks environments get-operation NAME [flags]
議論
NAME
操作リソースの名前。
オプション
例
次の例は、長時間実行される操作のステータスを取得するものです。
databricks environments get-operation operations/1234567890
Databricks環境のワークスペースベース環境を取得
名前からワークスペースの基本環境を取得します。
databricks environments get-workspace-base-environment NAME [flags]
議論
NAME
必須。取得するワークスペースベース環境のリソース名。形式: workspace-base-environments/{workspace_base_environment} 。
オプション
例
次の例では、ワークスペースの基本環境を取得します。
databricks environments get-workspace-base-environment workspace-base-environments/my-env-id
Databricks環境一覧 - ワークスペースベース環境
ワークスペース内のすべてのワークスペース基本環境を一覧表示します。
databricks environments list-workspace-base-environments [flags]
議論
なし
オプション
--page-size int
1ページあたりに返される環境の最大数。
--page-token string
ページネーション用のページトークン。
例
次の例は、すべてのワークスペース基本環境を一覧表示したものです。
databricks environments list-workspace-base-environments
Databricks環境のワークスペースベース環境の更新
ワークスペースの基本環境のマテリアライズド環境を更新します。これは、マテリアライズド環境を非同期的に再生成する、長時間実行される処理です。既存の具体化環境は、有効期限が切れるまで利用可能です。
databricks environments refresh-workspace-base-environment NAME [flags]
議論
NAME
必須。更新するワークスペースのベース環境のリソース名。形式: workspace-base-environments/{workspace_base_environment} 。
オプション
--no-wait
DONE状態に到達するまで待たないでください。
--timeout duration
DONE状態に到達するまでの最大時間。
例
次の例は、ワークスペースの基本環境を更新するものです。
databricks environments refresh-workspace-base-environment workspace-base-environments/my-env-id
Databricks環境のデフォルトワークスペースベース環境の更新
デフォルトのワークスペース基本環境設定を更新します。指定されたベース環境を CPU および/または GPU コンピュートのワークスペースとして設定します。
databricks environments update-default-workspace-base-environment NAME UPDATE_MASK [flags]
議論
NAME
このシングルトンリソースのリソース名。形式: default-workspace-base-environment 。
UPDATE_MASK
更新するフィールドを指定するフィールドマスク。有効なフィールドパス: cpu_workspace_base_environment 、 gpu_workspace_base_environment 。すべてのフィールドを更新するには、 *を使用してください。
オプション
--cpu-workspace-base-environment string
CPUコンピュートのための安心ワークスペース基盤環境。
--gpu-workspace-base-environment string
安心ワークスペース GPUコンピュートの基盤環境。
--json JSON
インラインJSON構文、またはリクエストボディを含むJSONファイルへの@path。
--name string
このシングルトンリソースのリソース名。
例
次の例では、無事 CPU ワークスペースの基本環境を設定します。
databricks environments update-default-workspace-base-environment default-workspace-base-environment cpu_workspace_base_environment --cpu-workspace-base-environment workspace-base-environments/my-cpu-env
Databricks環境のワークスペースベース環境の更新
既存のワークスペースベース環境を更新します。これは、マテリアライズド環境を非同期的に再生成する、長時間実行される処理です。既存の具体化環境は、有効期限が切れるまで利用可能です。
databricks environments update-workspace-base-environment NAME DISPLAY_NAME [flags]
議論
NAME
ワークスペースの基本環境のリソース名。形式: workspace-base-environments/{workspace_base_environment} 。
DISPLAY_NAME
ワークスペースの基本環境を表す、人間が読みやすい表示名。
オプション
--base-environment-type BaseEnvironmentType
基本環境の種類（CPUまたはGPU）。サポートされている値: CPU 、 GPU
--filepath string
ワークスペース ファイルまたは環境 YAML ファイルへのUnity Catalogボリュームのパス。
--json JSON
インラインJSON構文、またはリクエストボディを含むJSONファイルへの@path。
--name string
ワークスペースの基本環境のリソース名。
--no-wait
DONE状態に到達するまで待たないでください。
--timeout duration
DONE状態に到達するまでの最大時間。
例
次の例は、ワークスペースの基本環境を更新するものです。
databricks environments update-workspace-base-environment workspace-base-environments/my-env-id "Updated Python Env" --filepath /Workspace/environments/updated-env.yaml
世界の国旗
--debug
デバッグログを有効にするかどうか。
-h または --help
Databricks CLI、関連するコマンドグループ、または関連するコマンドのヘルプを表示します。
--log-file string
出力ログを書き込むファイルを表す文字列。このフラグが指定されていない場合、デフォルトでは出力ログは標準エラー出力に書き込まれます。
--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
該当する場合、使用するバンドルターゲット