砖CLI

需求

没有特殊要求在你安装砖CLI。砖砖CLI提供了作为一个独立的可执行macOS, Linux和Windows操作系统。

安装或更新CLI

本节描述如何安装或更新您的开发机砖CLI的可执行文件运行。

砖个人访问令牌认证

砖个人访问令牌身份验证使用砖砖个人访问令牌认证的目标实体,如砖用户帐户或砖服务主体。另请参阅砖个人访问令牌认证。

创建一个砖个人访问令牌,看到的砖个人访问令牌认证。

配置和使用砖个人访问令牌认证,执行以下操作:

1. 创建或确定一个砖配置概要文件在你使用以下字段.databrickscfg文件。如果你创建配置文件,将占位符替换为适当的值。

   (< some-unique-configuration-profile-name >)主机= < workspace-url >牌= < personal-access-token >

   请注意

   默认情况下,砖CLI的看起来.databrickscfg文件在你的~(你的用户家里)文件夹在Unix, Linux,或macOS,或你的% USERPROFILE %(你的用户家里)文件夹在Windows。如果.databrickscfg文件不存在在这个默认位置,手动创建这个文件。不要忘记点(。在文件名的开始。

2. 使用砖CLI的——简介或- p选择配置概要文件的名称,作为砖CLI命令调用的一部分,例如砖集群列表- p< configuration-profile-name >。

砖配置——主机< workspace-url >概要文件< some-unique-configuration-profile-name >

✔砖牌:

基本身份验证

基本身份验证使用砖目标砖用户帐户的用户名和密码进行身份验证。另请参阅基本身份验证。

配置和使用基本身份验证,请执行以下操作:

1. 创建或确定一个砖配置概要文件在你使用以下字段.databrickscfg文件。如果你创建配置文件,将占位符替换为适当的值。

   帐户级别的命令,在你设置以下值.databrickscfg文件:

   (< some-unique-configuration-profile-name >)主机= < account-console-url > account_id = <帐户id >用户名密码= <用户名> = <密码>

   对工作空间层命令,在你设置以下值.databrickscfg文件:

   (< some-unique-configuration-profile-name >)主机密码= < workspace-url >用户名= <用户名> = <密码>

   请注意

   默认情况下,砖CLI的看起来.databrickscfg文件在你的~(你的用户家里)文件夹在Unix, Linux,或macOS,或你的% USERPROFILE %(你的用户家里)文件夹在Windows。如果.databrickscfg文件不存在在这个默认位置,手动创建这个文件。不要忘记点(。在文件名的开始。

2. 使用砖CLI的——简介或- p选择配置概要文件的名称,作为砖CLI命令调用的一部分,例如砖账户组列表- p< configuration-profile-name >或砖集群列表- p< configuration-profile-name >。

   提示

   砖CLI 0.201.0及以上版本,你可以按下选项卡后——简介或- p显示现有可用的配置概要文件列表可供选择,而不是进入手动配置概要文件的名称。

OAuth机器对机器(M2M)身份验证

而不是与砖用的验证砖个人访问令牌认证,您可以使用OAuth身份验证。OAuth为令牌提供了更快的过期时间比砖个人访问令牌,并提供更好的服务器端会话失效和范围。因为OAuth访问令牌到期在不到一个小时,这样可以减少相关的风险与不小心检查令牌到源代码控制。另请参阅OAuth机器对机器(M2M)身份验证。

配置和使用OAuth M2M认证,执行以下操作:

1. 完成OAuth M2M身份验证设置说明。看到步骤1 - 3使用OAuth身份验证服务主体。

   重要的

   你只需要在前条的指示完成步骤1 - 3。

   第四步在那篇文章中包括手动创建OAuth访问令牌;然而,砖CLI自动创建并管理OAuth访问令牌代表你你的目标数据砖服务主体。第五步在那篇文章中使用旋度调用数据砖REST API,而不是使用砖CLI。

2. 创建或确定一个砖配置概要文件在你使用以下字段.databrickscfg文件。如果你创建配置文件,将占位符替换为适当的值。

   帐户级别的命令,在你设置以下值.databrickscfg文件:

   (< some-unique-configuration-profile-name >)主机= < account-console-url > account_id = <帐户id > client_id = < service-principal-client-id > client_secret = < service-principal-oauth-secret >

   对工作空间层命令,在你设置以下值.databrickscfg文件:

   (< some-unique-configuration-profile-name >)主机= < workspace-url > client_id = < service-principal-client-id > client_secret = < service-principal-oauth-secret >

   请注意

   默认情况下,砖CLI的看起来.databrickscfg文件在你的~(你的用户家里)文件夹在Unix, Linux,或macOS,或你的% USERPROFILE %(你的用户家里)文件夹在Windows。如果.databrickscfg文件不存在在这个默认位置,手动创建这个文件。不要忘记点(。在文件名的开始。

3. 使用砖CLI的——简介或- p选择配置概要文件的名称,作为砖CLI命令调用的一部分,例如砖账户组列表- p< configuration-profile-name >或砖集群列表- p< configuration-profile-name >。

   提示

   砖CLI 0.201.0及以上版本,你可以按下选项卡后——简介或- p显示现有可用的配置概要文件列表可供选择,而不是进入手动配置概要文件的名称。

OAuth user-to-machine (U2M)身份验证

而不是与砖用的验证令牌验证,您可以使用OAuth身份验证。OAuth为令牌提供了更快的过期时间比砖个人访问令牌,并提供更好的服务器端会话失效和范围。因为OAuth访问令牌到期在不到一个小时,这样可以减少相关的风险与不小心检查令牌到源代码控制。另请参阅OAuth user-to-machine (U2M)身份验证。

配置和使用OAuth U2M认证,执行以下操作:

1. 完成OAuth U2M身份验证设置说明。看到OAuth user-to-machine (U2M)身份验证。

2. 本地帐户级别的命令,启动OAuth令牌管理通过运行以下命令。占位符替换为适当的值。当出现提示时,屏幕上的指令完成。

   砖身份验证登录主机< account-console-url >——帐户id <帐户id >

   请注意

   砖CLI 0.201.0及以上版本,如果你不提供——主机选项,提示您在命令行。

   砖CLI 0.200.1及以上版本,之后运行身份验证登录命令,提示您保存帐户控制台URL和帐户ID作为砖配置概要文件。当出现提示时,输入一个新的或现有的配置文件的名称在你.databrickscfg文件。任何现有的配置文件中具有相同名称的.databrickscfg文件被覆盖。

3. 本地工作区级别的命令,启动OAuth令牌管理通过运行以下命令。占位符替换为适当的值。当出现提示时,屏幕上的指令完成。

   砖身份验证登录——主机< workspace-url >

   请注意

   砖CLI 0.201.0及以上版本,如果你不提供——主机选项,提示您在命令行。

   砖CLI 0.200.1及以上版本,之后运行身份验证登录命令,提示您保存工作区URL作为砖配置概要文件。当出现提示时,输入一个新的或现有的配置文件的名称在你.databrickscfg文件。任何现有的配置文件中具有相同名称的.databrickscfg文件被覆盖。

4. 创建或确定一个砖配置概要文件在你使用以下字段.databrickscfg文件。如果你创建配置文件,将占位符替换为适当的值。

   帐户级别的命令,在你设置以下值.databrickscfg文件:

   (< some-unique-configuration-profile-name >)主机= < account-console-url > account_id = <帐户id >

   对工作空间层命令,在你设置以下值.databrickscfg文件:

   (< some-unique-configuration-profile-name >)主机= < workspace-url >

   请注意

   默认情况下,砖CLI的看起来.databrickscfg文件在你的~(你的用户家里)文件夹在Unix, Linux,或macOS,或你的% USERPROFILE %(你的用户家里)文件夹在Windows。如果.databrickscfg文件不存在在这个默认位置,手动创建这个文件。不要忘记点(。在文件名的开始。

5. 使用砖CLI的——简介或- p选择配置概要文件的名称,作为砖CLI命令调用的一部分,例如砖账户组列表- p< configuration-profile-name >或砖集群列表- p< configuration-profile-name >。

   提示

   砖CLI 0.201.0及以上版本,你可以按下选项卡后——简介或- p显示现有可用的配置概要文件列表可供选择,而不是进入手动配置概要文件的名称。

得到的信息配置概要文件

添加多个配置概要文件.databrickscfg文件允许您快速运行命令跨各种工作区指定命令的目标配置概要文件的名称——简介或- p选择,对于那些支持这个选项的命令。如果你不指定——简介或- p选项支持这个选项的命令,该命令将使用默认的默认配置概要文件。

例如,您可以配置概要文件命名DEV引用一个砖工作区使用开发工作量和一个单独的配置概要文件命名刺激引用不同的砖工作区为生产工作负载使用。

默认情况下,砖CLI的查找.databrickscfg文件在你的~(你的用户家里)文件夹在Unix, Linux,或macOS,或你的% USERPROFILE %(你的用户家里)文件夹在Windows。您可以更改默认的路径.databrickscfg文件通过设置环境变量DATABRICKS_CONFIG_FILE。学习如何设置环境变量,看你的操作系统的文档。

现有的配置概要文件信息,运行身份验证env命令:

砖auth env - p < configuration-profile-name >#或:砖auth env -主机< account-console-url >#或:砖auth env -主机< workspace-url >

例如,在这里是配置概要文件的输出数据砖个人访问令牌的身份验证:

{“env”:{“DATABRICKS_AUTH_TYPE”:“拍”,“DATABRICKS_CONFIG_PROFILE”:“< configuration-profile-name >”,“DATABRICKS_HOST”:“< workspace-url >”,“DATABRICKS_TOKEN”:“<标记值>”}}

所有可用的概要信息,运行身份验证配置文件命令:

砖身份验证配置文件

输出(为了简洁起见,椭圆表示省略的内容):

{“配置文件”:({“名称”:“< configuration-profile-name >”,“主机”:“< workspace-url >”,“云”:“< cloud-id >”,“auth_type”:“< auth-type >”,“有效的”:真正的},{“…”:“…”}]}

的输出身份验证配置文件命令不显示任何访问令牌。显示一个访问令牌,跑前面身份验证env命令。

测试你的默认配置配置文件设置

检查你是否设置正确的身份验证,您可以运行一个命令,如以下,它列出了可用的砖的砖工作空间的运行时版本与你有关默认的概要文件。

以下称假设您没有任何特殊的环境变量设置,优先于你的设置默认的概要文件。有关更多信息,请参见身份验证的评价。

砖集群spark-versions

测试您的配置概要文件

检查你是否正确设置任何配置概要文件,您可以运行一个命令,如以下与你的工作空间层配置概要文件的名字。这个命令列出了可用的砖砖的运行时版本的工作区与指定的配置概要文件相关联,代表这里的占位符< configuration-profile-name >:

砖集群spark-versions - p < configuration-profile-name >

列出细节对于一个特定的配置文件,运行以下命令:

砖auth env - p < configuration-profile-name >

列出你所有的细节可用的配置文件,运行以下命令:

砖身份验证配置文件

身份验证的评价

每当砖CLI需要收集所需的设置与砖工作区或试图验证账户,它搜索这些设置在以下地点,按照以下顺序。

1. 为包命令,字段的值在一个项目的包设置文件。(包设置文件不支持直接的访问凭证价值。)

2. 环境变量的值,因为在本文和上市环境变量并为客户端统一身份验证领域。

3. 配置概要文件中的字段值.databrickscfg文件,如之前在本文中列出。

每当砖CLI发现所需的设置需要,它在其他地方停止搜索。例如:

• 砖CLI需要砖的个人访问令牌的价值。一个DATABRICKS_TOKEN环境变量设置,.databrickscfg文件还包含了多个个人访问令牌。在这个例子中,砖CLI使用的价值DATABRICKS_TOKEN环境变量,不搜索.databrickscfg文件。

• 的砖包部署- e发展命令需要砖的个人访问令牌的价值。一个DATABRICKS_TOKEN环境变量没有设置,.databrickscfg文件包含多个个人访问令牌。项目的文件包含一个包设置发展通过其环境声明引用配置文件配置概要文件命名DEV。在这个例子中,砖CLI的搜索.databrickscfg申请一个概要文件命名DEV和概要文件的使用的价值令牌字段。

• 的砖包运行- e发展hello-job命令需要砖的个人访问令牌的价值。一个DATABRICKS_TOKEN环境变量没有设置,.databrickscfg文件包含多个个人访问令牌。项目的文件包含一个包设置发展通过其环境声明引用主机领域特定的砖工作空间的URL。在这个例子中,砖CLI的搜索通过配置概要文件中.databrickscfg一个配置文件,其中包含的文件主机URL字段匹配的工作空间。砖CLI找到一个匹配主机概要文件的字段,然后使用令牌字段值。

CLI命令组列表

你使用的命令组列表——帮助或- h选择。例如:

砖- h

CLI命令列表

你的命令列表命令组使用——帮助或- h选择。例如,列出集群命令:

砖集群- h

显示CLI命令帮助

你显示一个命令使用的帮助——帮助或- h选择。例如,要显示的帮助集群列表命令:

砖集群列表- h

使用金桥解析CLI输出

一些砖CLI命令的输出响应格式化为JSON。在许多情况下,砖CLI格式JSON输出,这样更容易阅读。然而,有时它可能是有用的JSON解析的部分而不是清单整个响应。例如,列表的显示名称砖集群与指定集群ID,您可以使用实用程序金桥:

砖集群获得1234年567890 - abcde123|金桥- r .cluster_name

输出:

我的- 11.3 - lts -集群

你可以安装金桥例如在macOS使用自制程序酿造安装金桥或在Windows上使用巧克力色乔科省安装金桥。的更多信息金桥,请参阅金桥手册。

JSON字符串参数

的格式字符串参数在JSON处理不同的根据您的操作系统:

”{cluster_id”:“1234 - 567890 abcde123“}”

”(“20230323”、“阿姆斯特丹”)”

”{\“cluster_id \”, \“1234 - 567890 abcde123 \“}”

“(\“20230323 \”,\“阿姆斯特丹\]”