account workspacesコマンドグループ
Databricks CLI使用には、使用状況データ プロビジョニングを含むDatabricksライセンスおよびDatabricksプライバシー通知が適用されます。
Databricks CLI内のaccount workspacesコマンド グループには、アカウントのワークスペースを管理するコマンドが含まれています。 Databricks ワークスペースは、すべての Databricks アセットにアクセスするための環境です。ワークスペースは、オブジェクト (ノートブック、ライブラリ、エクスペリメント) をフォルダーに整理し、データやクラスターやジョブなどの計算リソースへのアクセスを提供します。 「ワークスペースを作成する」を参照してください。
これらのコマンドは、アカウントがプラットフォームの E2 バージョンにある場合、またはアカウントごとに複数のワークスペースを許可する特定のカスタム プランにある場合に使用できます。
databricks アカウント ワークスペース create
資格情報構成とストレージ構成、オプションのネットワーク構成 (カスタマー管理VPCを使用する場合)、オプションのマネージドサービス キー構成 (マネージドサービスにカスタマー管理のキーを使用する場合)、およびオプションのストレージ キー構成 (ストレージにカスタマー管理のキーを使用する場合) を使用して、新しいワークスペースを作成します。
この操作は非同期です。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 クラウド リージョン (例: 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
コンピュートモードがサーバレスの場合、サーバレスワークスペースが作成されます。 サポートされている値: HYBRID 、 SERVERLESS 。
--pricing-tier PricingTier
ワークスペースの価格帯。サポートされている値: COMMUNITY_EDITION 、 DEDICATED 、 ENTERPRISE 、 PREMIUM 、 STANDARD 、 UNKNOWN 。
--no-wait
RUNNING 状態になるまで待たないでください。
--timeout duration
RUNNING 状態に到達するまでの最大時間 (デフォルトは 20 分 0 秒)。
--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 アカウント ワークスペース get
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 クラウド リージョン (例: 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
フィールド マスクは単一の文字列で、複数のフィールドはコンマ (スペースなし) で区切る必要があります。
--no-wait
RUNNING 状態になるまで待たないでください。
--timeout duration
RUNNING 状態に到達するまでの最大時間 (デフォルトは 20 分 0 秒)。
--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 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
該当する場合、使用するバンドルターゲット