注释
Databricks CLI 的使用须遵守 Databricks 许可和 Databricks 隐私声明,包括任何数据使用规定。
account workspaces
Databricks CLI 中的命令组包含用于管理帐户工作区的命令。 Databricks 工作区是用于访问所有 Databricks 资产的环境。 工作区将对象(笔记本、库和试验)组织到文件夹中,并提供对群集和作业等数据和计算资源的访问权限。 请参阅 “创建工作区”。
注释
如果帐户位于平台的 E2 版本或允许每个帐户多个工作区的选择自定义计划中,则这些命令可用。
databricks 帐户工作区创建
使用凭据配置和存储配置、可选网络配置(如果使用客户管理的VP)、可选的托管服务密钥配置(如果使用托管服务的客户管理的密钥)和可选的存储密钥配置(如果使用客户管理的密钥进行存储)。
重要
此作是异步的。 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、ENTERPRISEPREMIUM、STANDARD。 UNKNOWN
--no-wait
不要等待到达 RUNNING 状态。
--timeout duration
达到运行状态的最大时间(默认为 20m0s)。
--json JSON
包含请求正文的内联 JSON 字符串或 @path 到 JSON 文件
例子
以下示例使用 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]
Arguments
WORKSPACE_ID
工作区的唯一整数 ID。
选项
例子
以下示例按 ID 删除工作区:
databricks account workspaces delete 123456789
databricks 帐户工作区获取
获取信息,包括由 ID 指定的 Databricks 工作区的状态。 在响应中,字段 workspace_status 指示当前状态。 初始工作区创建(这是异步的),使用工作区 ID 发出重复 GET 请求并检查其状态。 当状态更改为 RUNNING 时,工作区将变为可用。
databricks account workspaces get WORKSPACE_ID [flags]
Arguments
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]
Arguments
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 NETWORK_ID,则将填充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、FAILEDNOT_PROVISIONED、PROVISIONING。 RUNNING
--update-mask string
字段掩码必须是单个字符串,多个字段用逗号分隔(无空格)。
--no-wait
不要等待到达 RUNNING 状态。
--timeout duration
达到运行状态的最大时间(默认为 20m0s)。
--json JSON
包含请求正文的内联 JSON 字符串或 @path 到 JSON 文件
例子
以下示例更新工作区名称:
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 字符串
如果适用,要使用的捆绑包目标