environments コマンド グループ

Note

この情報は、Databricks CLI バージョン 0.205 以降に適用されます。 Databricks CLI は パブリック プレビュー段階です

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

Databricks CLI 内の environments コマンド グループを使用すると、環境リソースを管理できます。 Environments API には、サーバーレス ノートブックとジョブで使用する環境のバージョンと依存関係を定義するワークスペース レベルの基本環境など、さまざまな種類の環境に対する管理機能が用意されています。

databricks 環境 create-workspace-base-environment

新しいワークスペース基本環境を作成します。 これは、依存関係の解決を最適化するために具体化された環境を非同期的に生成する実行時間の長い操作です。

databricks environments create-workspace-base-environment DISPLAY_NAME [flags]

引数

DISPLAY_NAME

    ワークスペースの基本環境の人間が判読できる表示名。

オプション

--base-environment-type BaseEnvironmentType

    基本環境 (CPU または GPU) の種類。 サポートされる値: CPUGPU

--filepath string

    ワークスペース ファイルまたは Unity カタログ ボリュームは、環境 YAML ファイルへのパスです。

--json JSON

    要求本文を含む JSON ファイルへのインライン JSON 文字列または @path 。

--name string

    ワークスペースの基本環境のリソース名。

--no-wait

     DONE状態になるまで待つ必要はありません。

--request-id string

    この要求の一意識別子。

--timeout duration

     DONE状態に達するまでの最大時間。

--workspace-base-environment-id string

    ワークスペースの基本環境に使用する ID。リソース名の最後のコンポーネントになります。

グローバル フラグ

Examples

次の例では、CPU ワークスペースの基本環境を作成します。

databricks environments create-workspace-base-environment "My Python Env" --base-environment-type CPU --filepath /Workspace/environments/env.yaml

databricks 環境 delete-workspace-base-environment

ワークスペースの基本環境を削除します。 基本環境を削除すると、リンクされたノートブックとジョブに影響する可能性があります。 この操作は元に戻すことができません。

databricks environments delete-workspace-base-environment NAME [flags]

引数

NAME

    必須。 削除するワークスペース基本環境のリソース名。 形式: workspace-base-environments/{workspace_base_environment}.

オプション

グローバル フラグ

Examples

次の例では、ワークスペースの基本環境を削除します。

databricks environments delete-workspace-base-environment workspace-base-environments/my-env-id

databricks 環境 get-default-workspace-base-environment

既定のワークスペース基本環境構成を取得します。 CPU コンピューティングと GPU コンピューティングの両方の現在の既定の基本環境設定を返します。

databricks environments get-default-workspace-base-environment NAME [flags]

引数

NAME

    既定のワークスペース基本環境の静的リソース名。 形式: default-workspace-base-environment.

オプション

グローバル フラグ

Examples

次の例では、既定のワークスペース基本環境を取得します。

databricks environments get-default-workspace-base-environment default-workspace-base-environment

databricks 環境の get-operation

実行時間の長い操作の状態を取得します。 クライアントは、このメソッドを使用して操作結果をポーリングできます。

databricks environments get-operation NAME [flags]

引数

NAME

    操作リソースの名前。

オプション

グローバル フラグ

Examples

次の例では、実行時間の長い操作の状態を取得します。

databricks environments get-operation operations/1234567890

databricks 環境 get-workspace-base-environment

ワークスペースの基本環境を名前で取得します。

databricks environments get-workspace-base-environment NAME [flags]

引数

NAME

    必須。 取得するワークスペース基本環境のリソース名。 形式: workspace-base-environments/{workspace_base_environment}.

オプション

グローバル フラグ

Examples

次の例では、ワークスペースの基本環境を取得します。

databricks environments get-workspace-base-environment workspace-base-environments/my-env-id

databricks 環境 list-workspace-base-environments

ワークスペース内のすべてのワークスペース基本環境を一覧表示します。

databricks environments list-workspace-base-environments [flags]

引数

なし

オプション

--page-size int

    ページごとに返される環境の最大数。

--page-token string

    改ページのページ トークン。

グローバル フラグ

Examples

次の例では、すべてのワークスペース基本環境の一覧を示します。

databricks environments list-workspace-base-environments

databricks 環境 refresh-workspace-base-environment

ワークスペースの基本環境の具体化された環境を更新します。 これは、具体化された環境を非同期的に再生成する実行時間の長い操作です。 既存の具体化された環境は、有効期限が切れるまで使用できます。

databricks environments refresh-workspace-base-environment NAME [flags]

引数

NAME

    必須。 更新するワークスペース基本環境のリソース名。 形式: workspace-base-environments/{workspace_base_environment}.

オプション

--no-wait

     DONE状態になるまで待つ必要はありません。

--timeout duration

     DONE状態に達するまでの最大時間。

グローバル フラグ

Examples

次の例では、ワークスペースの基本環境を更新します。

databricks environments refresh-workspace-base-environment workspace-base-environments/my-env-id

databricks 環境 update-default-workspace-base-environment

既定のワークスペース基本環境構成を更新します。 指定した基本環境を、CPU または GPU コンピューティングのワークスペースの既定値として設定します。

databricks environments update-default-workspace-base-environment NAME UPDATE_MASK [flags]

引数

NAME

    このシングルトン リソースのリソース名。 形式: default-workspace-base-environment.

UPDATE_MASK

    更新するフィールドを指定するフィールド マスク。 有効なフィールド パス: cpu_workspace_base_environmentgpu_workspace_base_environment*を使用して、すべてのフィールドを更新します。

オプション

--cpu-workspace-base-environment string

    CPU コンピューティングの既定のワークスペース基本環境。

--gpu-workspace-base-environment string

    GPU コンピューティングの既定のワークスペース基本環境。

--json JSON

    要求本文を含む JSON ファイルへのインライン JSON 文字列または @path 。

--name string

    このシングルトン リソースのリソース名。

グローバル フラグ

Examples

次の例では、既定の 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 環境 update-workspace-base-environment

既存のワークスペース基本環境を更新します。 これは、具体化された環境を非同期的に再生成する実行時間の長い操作です。 既存の具体化された環境は、有効期限が切れるまで使用できます。

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) の種類。 サポートされる値: CPUGPU

--filepath string

    ワークスペース ファイルまたは Unity カタログ ボリュームの環境 YAML ファイルへのパス。

--json JSON

    要求本文を含む JSON ファイルへのインライン JSON 文字列または @path 。

--name string

    ワークスペースの基本環境のリソース名。

--no-wait

     DONE状態になるまで待つ必要はありません。

--timeout duration

     DONE状態に達するまでの最大時間。

グローバル フラグ

Examples

次の例では、ワークスペースの基本環境を更新します。

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 文字列

    出力ログを書き込むファイルを表す文字列。 このフラグが指定されていない場合、既定では stderr に出力ログが書き込まれます。

--log-format 形式

    ログ形式の種類、 text 、または json。 既定値は text です。

--log-level 文字列

    ログ形式レベルを表す文字列。 指定しない場合、ログ形式レベルは無効になります。

-o, --output

    コマンド出力の種類( text または json)。 既定値は text です。

-p, --profile 文字列

    コマンドの実行に使用する ~/.databrickscfg ファイル内のプロファイルの名前。 このフラグが指定されていない場合は、存在する場合は、 DEFAULT という名前のプロファイルが使用されます。

--progress-format 形式

    進行状況ログを表示する形式: defaultappendinplace、または json

-t, --target 文字列

    該当する場合は、使用するバンドル ターゲット