注
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。 Databricks CLI は パブリック プレビュー段階です。
Databricks CLI の使用には、Databricks ライセンスおよび使用状況データのプロビジョニングを含むDatabricks のプライバシーに関する通知が適用されます。
Databricks CLI 内の account workspaces コマンド グループには、アカウントのワークスペースを管理するためのコマンドが含まれています。 Databricks ワークスペースは、すべての Databricks 資産にアクセスするための環境です。 ワークスペースは、オブジェクト (ノートブック、ライブラリ、実験) をフォルダーに整理し、クラスターやジョブなどのデータと計算リソースへのアクセスを提供します。
「ワークスペースの作成」を参照してください。
注
これらのコマンドは、アカウントが E2 バージョンのプラットフォーム上にある場合、またはアカウントごとに複数のワークスペースを許可する選択されたカスタム プランにある場合に使用できます。
databricks アカウント ワークスペースの作成
資格情報構成とストレージ構成、オプションのネットワーク構成 (カスタマー マネージド VPC を使用する場合)、オプションのマネージド サービス キー構成 (マネージド サービスにカスタマー マネージド キーを使用する場合)、およびオプションのストレージ キー構成 (ストレージにカスタマー マネージド キーを使用する場合) を使用して、新しいワークスペースを作成します。
Important
この操作は非同期です。 HTTP 状態コード 200 の応答は、要求が受け入れられ、進行中であることを意味しますが、ワークスペースが正常にデプロイされ、実行されていることを意味するものではありません。 通常、初期ワークスペースの状態はプロビジョニングです。 応答のワークスペース ID (workspace_id) フィールドを使用して新しいワークスペースを識別し、ワークスペース ID で GET 要求を繰り返し行い、その状態を確認します。 状態が RUNNING に変わると、ワークスペースが使用可能になります。
databricks account workspaces create [flags]
オプション
--workspace-name string
人間が判読できるワークスペースの名前。
--deployment-name string
デプロイ名は、ワークスペースのサブドメインの一部を定義します。
--aws-region string
ワークスペースの AWS リージョン。
--cloud string
クラウド名。
--location string
Google アカウント内のワークスペース データ プレーンの Google Cloud リージョン (たとえば、 us-east4)。
--credentials-id string
ワークスペースの資格情報構成オブジェクトの ID。
--storage-configuration-id string
ワークスペースのストレージ構成オブジェクトの ID。
--network-id string
ワークスペースのネットワーク構成オブジェクトの ID。
--managed-services-customer-managed-key-id string
ワークスペースのマネージド サービス暗号化キー構成オブジェクトの ID。
--storage-customer-managed-key-id string
ワークスペースのストレージ暗号化キー構成オブジェクトの ID。
--private-access-settings-id string
ワークスペースのプライベート アクセス設定オブジェクトの ID。
--network-connectivity-config-id string
ネットワーク接続構成のオブジェクト ID。
--compute-mode CustomerFacingComputeMode
コンピューティング モードが SERVERLESS の場合は、サーバーレス ワークスペースが作成されます。 サポートされる値: HYBRID、SERVERLESS。
--pricing-tier PricingTier
ワークスペースの価格レベル。 サポートされる値: COMMUNITY_EDITION、 DEDICATED、 ENTERPRISE、 PREMIUM、 STANDARD、 UNKNOWN。
--no-wait
RUNNING 状態になるまで待つ必要はありません。
--timeout duration
RUNNING 状態に達するまでの最大時間 (既定値は 20m0)。
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path
例示
次の例では、JSON を使用してワークスペースを作成します。
databricks account workspaces create --json '{"workspace_name": "my-workspace", "deployment_name": "my-workspace-deployment", "aws_region": "us-west-2", "credentials_id": "cred-abc123", "storage_configuration_id": "storage-xyz789"}'
次の例では、JSON ファイルを使用してワークスペースを作成します。
databricks account workspaces create --json @workspace.json
次の例では、コマンド ライン フラグを使用してワークスペースを作成します。
databricks account workspaces create --workspace-name "my-workspace" --deployment-name "my-workspace-deployment" --aws-region "us-west-2" --credentials-id "cred-abc123" --storage-configuration-id "storage-xyz789"
databricks アカウント ワークスペースの削除
ID で指定された Databricks ワークスペースを削除します。
databricks account workspaces delete WORKSPACE_ID [flags]
論争
WORKSPACE_ID
ワークスペースの一意の整数 ID。
オプション
例示
次の例では、ID でワークスペースを削除します。
databricks account workspaces delete 123456789
databricks アカウント ワークスペースが取得する
ID で指定された Databricks ワークスペースの状態を含む情報を取得します。 応答では、 workspace_status フィールドは現在の状態を示します。 最初のワークスペースの作成 (非同期) が完了したら、ワークスペース ID を使用して GET 要求を繰り返し実行し、その状態を確認します。 状態が RUNNING に変わると、ワークスペースが使用可能になります。
databricks account workspaces get WORKSPACE_ID [flags]
論争
WORKSPACE_ID
ワークスペースの一意の整数 ID。
オプション
例示
次の例では、ID でワークスペースを取得します。
databricks account workspaces get 123456789
databricks アカウントワークスペースの一覧
アカウントの Databricks ワークスペースを一覧表示します。
databricks account workspaces list [flags]
オプション
例示
次の例では、すべてのワークスペースを一覧表示します。
databricks account workspaces list
databricks アカウント ワークスペースの更新
ワークスペース構成を更新します。
databricks account workspaces update WORKSPACE_ID [flags]
論争
WORKSPACE_ID
ワークスペースの一意の整数 ID。
オプション
--workspace-name string
人間が判読できるワークスペースの名前。
--deployment-name string
ワークスペースのデプロイ名。
--aws-region string
ワークスペースの AWS リージョン。
--cloud string
クラウド名。
--location string
Google アカウント内のワークスペース データ プレーンの Google Cloud リージョン (たとえば、 us-east4)。
--credentials-id string
ワークスペースの資格情報構成オブジェクトの ID。
--storage-configuration-id string
ワークスペースのストレージ構成オブジェクトの ID。
--network-id string
このワークスペースが BYO VPC の場合、network_idが設定されます。
--managed-services-customer-managed-key-id string
マネージド サービスを暗号化するためのキー構成の ID。
--storage-customer-managed-key-id string
ワークスペース ストレージを暗号化するためのキー構成の ID。
--private-access-settings-id string
ワークスペースのプライベート アクセス設定オブジェクトの ID。
--network-connectivity-config-id string
ネットワーク接続構成のオブジェクト ID。
--expected-workspace-status WorkspaceStatus
クライアントが想定しているワークスペースの状態を示すために使用されるクライアント所有フィールド。 サポートされる値: BANNED、 CANCELLING、 FAILED、 NOT_PROVISIONED、 PROVISIONING、 RUNNING。
--update-mask string
フィールド マスクは 1 つの文字列で、複数のフィールドをコンマで区切る必要があります (スペースなし)。
--no-wait
RUNNING 状態になるまで待つ必要はありません。
--timeout duration
RUNNING 状態に達するまでの最大時間 (既定値は 20m0)。
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path
例示
次の例では、ワークスペース名を更新します。
databricks account workspaces update 123456789 --workspace-name "updated-workspace-name"
次の例では、JSON を使用してワークスペースを更新します。
databricks account workspaces update 123456789 --json '{"workspace_name": "updated-workspace-name", "credentials_id": "cred-new123"}'
次の例では、JSON ファイルを使用してワークスペースを更新します。
databricks account workspaces update 123456789 --json @update-workspace.json
グローバル フラグ
--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 形式
進行状況ログを表示する形式: default、 append、 inplace、または json
-t, --target 文字列
該当する場合は、使用するバンドル ターゲット