configure команда

The configure command within the Databricks CLI enables you to authenticate the Databricks CLI with Azure Databricks using Azure Databricks personal access tokens or Microsoft Entra ID (formerly Azure Active Directory) tokens.

Note that this article covers only Azure Databricks personal access token and Microsoft Entra ID token authentication for enabling the calling of workspace-level commands. Дополнительные параметры конфигурации проверки подлинности см. в разделе "Проверка подлинности" для интерфейса командной строки Databricks.

databricks configure

Настройте профиль в ~/.databrickscfg файле. A configuration profile is a collection of settings that contains authentication information such as an Azure Databricks workspace URL and an access token value.

Профиль конфигурации имеет программное имя, например DEFAULT, DEVили PROD. Добавление нескольких профилей в .databrickscfg файл позволяет быстро выполнять команды в различных рабочих областях, указав имя целевого профиля подключения в параметре команды --profile . Если параметр не указан --profile в команде, поддерживающей этот параметр, команда будет использовать DEFAULT профиль подключения по умолчанию.

Например, у вас может быть профиль подключения с именем DEV , ссылающийся на рабочую область Azure Databricks, используемую для рабочих нагрузок разработки, и отдельный профиль подключения с именем PROD профиля подключения, который ссылается на другую рабочую область Azure Databricks, используемую для рабочих нагрузок.

Чтобы получить сведения о существующих профилях конфигурации, используйте группуauth команд.

Вы можете изменить путь по умолчанию к .databrickscfg файлу, задав переменную DATABRICKS_CONFIG_FILEсреды.

Если эта команда вызывается в неинтерактивном режиме, он считывает маркер из stdin. Узел должен быть указан с флагом --host или переменной DATABRICKS_HOST среды.

databricks configure [flags]

Options

--configure-cluster

    Запросы на настройку кластера

--host string

    URL-адрес узла рабочей области Databricks

URL-адрес узла рабочей области — это URL-адрес для каждой рабочей области с форматом https://adb-<workspace-id>.<random-number>.azuredatabricks.net. To get the per-workspace URL, see Per-workspace URL.

--profile string

    Имя профиля подключения для настройки. (default "DEFAULT")

Global flags

Examples

В следующем примере настраивается проверка подлинности для профиля по умолчанию:

databricks configure

В следующем примере настраивается проверка подлинности для определенного профиля:

databricks configure --profile my-profile

В следующем примере настраивается проверка подлинности с определенным узлом:

databricks configure --host https://my-workspace.cloud.databricks.com

Следующий пример настраивает проверку подлинности с конфигурацией кластера:

databricks configure --configure-cluster

Global flags

--debug

  Следует ли включить ведение журнала отладки.

-h или --help

    Отобразить справку по интерфейсу командной строки Databricks, связанной группе команд или отдельной команде.

--log-file струна

    Строка, представляющая файл для записи журналов выходных данных. Если этот флаг не указан, по умолчанию используется запись журналов выходных данных в stderr.

--log-format формат

    Тип text формата журнала или json. Значение по умолчанию — text.

--log-level струна

    Строка, представляющая уровень формата журнала. Если не указано, уровень формата журнала отключен.

типа -o, --output

    Тип text выходных данных команды или json. Значение по умолчанию — text.

-p, --profile струна

    Имя профиля в ~/.databrickscfg файле, используемого для выполнения команды. Если этот флаг не указан, то если он существует, используется DEFAULT профиль.

--progress-format формат

    Формат для отображения журналов хода выполнения: default, appendinplace, илиjson

-t, --target струна

    Если применимо, целевой объект пакета для использования

Создайте профиль конфигурации.

Чтобы создать профиль конфигурации, выполните configure команду:

databricks configure --host <workspace-url>

Команда предлагает вам ввести ваш персональный токен доступа Azure Databricks или токен Microsoft Entra ID (ранее Azure Active Directory), который соответствует указанному :

✔ Databricks Token:

После ввода маркера доступа маркер доступа хранится в файле ~/.databrickscfg в Linux или macOS или %USERPROFILE%\.databrickscfg в Windows по умолчанию. Файл содержит запись профиля подключения по умолчанию с именем DEFAULT:

[DEFAULT]
host  = <workspace-url>
token = <access-token>

Чтобы использовать другое имя для профиля подключения вместо DEFAULT, добавьте --profile опцию в configure команду, например:

databricks configure --host <workspace-url> --profile <profile-name>

Все существующие сведения о узле и маркере в указанном профиле подключения перезаписываются с помощью новых сведений о узле и маркере.