`auth` группа команд

Note

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

Группа auth команд в интерфейсе командной строки Databricks содержит связанные с проверкой подлинности команды, включая следующие:

Список всех доступных профилей конфигурации проверки подлинности.
Получение сведений об отдельном профиле конфигурации проверки подлинности.
Используйте проверку подлинности OAuth на компьютере (U2M) для проверки подлинности интерфейса командной строки Databricks с помощью учетных записей и рабочих областей Azure Databricks.
Выйдите из профиля, очищая кэшированные маркеры OAuth и при необходимости удаляя запись профиля.
Получение сведений о любых маркерах доступа OAuth, которые, возможно, кэшировали интерфейс командной строки Databricks.
Получение сведений о конфигурации, используемой интерфейсом командной строки Databricks для проверки подлинности.

Tip

Чтобы получить сведения о текущем пользователе Интерфейса командной строки Databricks, выполните команду databricks current-user me.

описание проверки подлинности databricks

Описывает конфигурацию, используемую интерфейсом командной строки Databricks для проверки подлинности, включая учетные данные и источник этих учетных данных. Если параметры не указаны, auth describe команда следует приоритету метода проверки подлинности.

databricks auth describe [flags]

Опции

--sensitive

Включение конфиденциальных полей, таких как пароли и маркеры, в выходные данные

Глобальные флаги

Примеры

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

databricks auth describe

Host: https://<workspace-instance-name>
User: <user-name>@<domain>
Authenticated with: <authentication-type>
-----
Current configuration:
  ✓ host: https://<workspace-instance-name> (from <path>/<to>/.databrickscfg config file)
  ✓ profile: default
  ✓ auth_type: <authentication-type> (from <path>/<to>/.databrickscfg config file)

Чтобы указать, что используется определенная рабочая область Azure Databricks, укажите --host параметр вместе с URL-адресом рабочей области.

databricks auth describe --host https://<workspace-instance-name>

Host: https://<workspace-instance-name>
User: <user-name>@<domain>
Authenticated with: <authentication-type>
-----
Current configuration:
  ✓ host: https://<workspace-instance-name> (from --host flag)
  ✓ profile: default
  ✓ auth_type: <authentication-type>

Чтобы указать, что используется определенная учетная запись Azure Databricks, укажите --host параметр вместе с URL-адресом https://accounts.azuredatabricks.netконсоли учетной записи Azure Databricks.

databricks auth describe --host <account-console-url>

Host: <account-console-url>
User: <user-name>@<domain>
AccountId: <account-id>
Authenticated with: <authentication-type>
-----
Current configuration:
  ✓ host: <account-console-url> (from --host flag)
  ✓ account_id: <account-id>
  ✓ profile: default
  ✓ auth_type: <authentication-type>

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

databricks auth describe -p TEST

Host: https://<workspace-instance-name>
User: <user-name>@<domain>
Authenticated with: <authentication-type>
-----
Current configuration:
  ✓ host: https://<workspace-instance-name> (from <path>/<to>/.databrickscfg config file)
  ✓ token: ******** (from <path>/<to>/.databrickscfg config file)
  ✓ profile: TEST (from --profile flag)
  ✓ auth_type: <authentication-type>

Чтобы включить конфиденциальную информацию в выходные данные (например, личные маркеры доступа Azure Databricks и секреты клиента), укажите --sensitive параметр:

databricks auth describe --sensitive

Host: https://<workspace-instance-name>
User: <user-name>@<domain>
Authenticated with: pat
-----
Current configuration:
  ✓ host: https://<workspace-instance-name> (from <path>/<to>/.databrickscfg config file)
  ✓ token: <token-value> (from <path>/<to>/.databrickscfg config file)
  ✓ profile: <profile-name>
  ✓ auth_type: pat

databricks auth env

Предупреждение

Эта команда отключена.

Получение сведений о существующем профиле конфигурации с помощью имени профиля или URL-адреса консоли учетной записи Azure Databricks или URL-адреса рабочей области Azure Databricks.

databricks auth env [flags]

Tip

Вы можете нажать Tab после --profile или -p, чтобы отобразить список существующих доступных профилей конфигурации для выбора, а не вводить имя профиля конфигурации вручную.

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

Опции

--host string

Имя узла для получения проверки подлинности для

Note

Если несколько профилей --host совпадают со значением, отображается сообщение об ошибке, указывающее, что он не может найти один соответствующий профиль. Например, у вас может быть один профиль, имеющий только значение узла и другой профиль, имеющий то же значение узла, но и значение маркера. В этом случае интерфейс командной строки Databricks не выбирает профиль и останавливается. Чтобы помочь Databricks CLI выбрать нужный профиль, попробуйте указать другое --host значение. Для --host значений, которые являются URL-адресами консоли учетной записи, попробуйте указать --account-id значение вместо --host значения.

--profile string

Профиль для получения проверки подлинности для

Глобальные флаги

Примеры

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

databricks auth env

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

databricks auth env --host https://my-workspace.cloud.databricks.com

Выходные данные профиля, настроенного с помощью проверки подлинности маркера доступа Azure Databricks, могут быть следующими:

{
  "env": {
    "DATABRICKS_AUTH_TYPE": "pat",
    "DATABRICKS_CONFIG_PROFILE": "TEST",
    "DATABRICKS_HOST": "https://my-workspace.cloud.databricks.com",
    "DATABRICKS_TOKEN": "<token-value>"
  }
}

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

databricks auth env --profile my-test-environment

Войдите в рабочую область Databricks или учетную запись и сохраните конфигурацию проверки подлинности в профиле ( ~/.databrickscfg по умолчанию). Затем профиль можно использовать для проверки подлинности других команд интерфейса командной строки Databricks с помощью флага --profile . Профиль также можно использовать для проверки подлинности других средств Databricks, поддерживающих единую проверку подлинности Databricks, включая Пакеты SDK Databricks Python, Java и Go.

databricks auth login HOST [flags]

Для этой команды требуется URL-адрес узла Databricks (использование --host или как позиционный аргумент или неявно вывод из указанного имени профиля) и имя профиля (с помощью --profile). Если эти значения не указаны, вам будет предложено ввести значения во время выполнения.

Хотя эта команда всегда регистрирует вас в указанном узле, поведение зависит от существующих профилей, заданных в файле конфигурации (по ~/.databrickscfg умолчанию):

Если профиль с указанным именем существует и указывает узел, вы войдете в узел, указанный профилем. Профиль будет обновлен, чтобы использовать databricks-cli в качестве типа проверки подлинности, если это не так раньше.
Если профиль с указанным именем существует, но не указывает узел, вам будет предложено указать узел. Профиль будет обновлен для использования указанного узла. Тип проверки подлинности будет обновлен до databricks-cli, если это не так раньше.
Если профиль с указанным именем существует и указывает узел, но вы указываете узел с помощью --host (или в качестве HOST позиционного arg), профиль будет обновлен, чтобы использовать только что указанный узел. Тип проверки подлинности будет обновлен до databricks-cli, если это не так раньше.
Если профиль с указанным именем не существует, новый профиль будет создан с указанным узлом. Тип проверки подлинности будет иметь значение databricks-cli.

Аргументы

HOST

URL-адрес узла Databricks (необязательно)

Опции

--configure-cluster

Запросы на настройку кластера (классические вычисления)

--configure-serverless

Запросы на настройку бессерверных вычислений

--timeout duration

Время ожидания для выполнения задачи входа в браузере (по умолчанию 1h0m0s)

Глобальные флаги

Примеры

В следующем примере выполняется вход в рабочую область Databricks:

databricks auth login

В следующем примере выполняется вход в определенную рабочую область Databricks:

databricks auth login https://my-workspace.cloud.databricks.com

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

databricks auth login --profile my-profile --configure-cluster

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

databricks auth login --timeout 30m

выход из системы проверки подлинности databricks

Выход из профиля Azure Databricks путем очистки кэшированных маркеров OAuth. Вам потребуется выполнить databricks auth login повторную проверку подлинности. Профиль остается в файле конфигурации (~/.databrickscfg по умолчанию), если вы также не указали --delete.

databricks auth logout [PROFILE] [flags]

Это поведение применяется только к профилям, созданным с databricks auth login помощью (auth_type задано значение databricks-cli). Профили, использующие другие методы проверки подлинности, такие как личные маркеры доступа или учетные данные компьютера и компьютерные учетные данные, не хранят кэшированные маркеры OAuth, поэтому ничего не нужно очищать. Если несколько профилей используют один и тот же кэшированный маркер, выход из одного из них не влияет на другие.

Поведение команды:

Если указать профиль (в качестве аргумента PROFILE или с --profile), команда выходит из этого профиля. Вы также можете указать URL-адрес узла, который команда разрешает в соответствующий профиль. В интерактивном терминале он запрашивает подтверждение, если вы также не указали --auto-approve.
Если пропустить профиль в интерактивном терминале, команда отображает средство выбора профилей с возможностью поиска. Вы можете выполнять поиск по имени профиля, узлу или идентификатору учетной записи. После выбора профиля команда запрашивает подтверждение, если вы также не указали --auto-approve.
Если пропустить профиль в неинтерактивной среде, команда завершается ошибкой и запрашивает указать профиль.
В неинтерактивной среде укажите профиль вместе с --auto-approve пропуском подтверждения.

Аргументы

PROFILE

Имя профиля или URL-адрес узла для выхода (необязательно). Аргумент сначала сопоставляется с существующими именами профилей. Если профиль не совпадает, а аргумент выглядит как URL-адрес узла, команда разрешает его профилям, настроенным для этого узла. Если несколько профилей соответствуют узлу, командная строка выбирает одну (или ошибки в неинтерактивном режиме).

Опции

--delete

Также удалите профиль из файла конфигурации (~/.databrickscfg по умолчанию)

--auto-approve

Пропустить запрос подтверждения

Глобальные флаги

Примеры

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

databricks auth logout my-profile

В следующем примере выйдите из профиля, связанного с URL-адресом узла:

databricks auth logout https://my-workspace.cloud.databricks.com

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

databricks auth logout --profile my-profile --delete

В следующем примере выполняется выход без запроса подтверждения, подходящего для CI/CD:

databricks auth logout my-profile --auto-approve

Профили проверки подлинности databricks

Список всех доступных профилей конфигурации (по ~/.databrickscfg умолчанию) и проверьте, являются ли они допустимыми профилями.

databricks auth profiles [flags]

Эта команда выводит профили в следующем формате:

Name            Host                Valid
DEFAULT         https://<host-url>  YES
<profile-name>  https://<host-url>  NO

Чтобы определить, является ли каждый профиль допустимым, интерфейс командной строки Databricks перечисляет рабочие области для каждого профиля уровня учетной записи и запускает текущую команду пользователя для каждого профиля уровня рабочей области. Если команда выполнена успешно, отображается объект YES ; в противном случае NO отображается.

Выходные данные auth profiles команды не отображают маркеры доступа. Сведения о отображении маркера доступа см. в разделе databricks auth env.

По умолчанию профили конфигурации хранятся в файле ~/.databrickscfg в Linux или macOS или %USERPROFILE%\.databrickscfg в Windows. Путь по умолчанию к этому файлу можно изменить, задав переменную DATABRICKS_CONFIG_FILEсреды.

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

Опции

--skip-validate

Пропустить проверку профилей

Глобальные флаги

Примеры

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

databricks auth profiles

В следующем примере перечислены профили без проверки их.

databricks auth profiles --skip-validate

параметр проверки подлинности databricks

Задайте именованный профиль в качестве значения по умолчанию ~/.databrickscfg. Выбранное имя профиля хранится в [__settings__] разделе в файле конфигурации под ключом default_profile . Используется databricks auth profiles для просмотра профиля, используемого в настоящее время по умолчанию.

databricks auth switch [flags]

Опции

Глобальные флаги

Примеры

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

databricks auth switch

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

databricks auth switch --profile my-profile

маркер проверки подлинности databricks

Получите маркер проверки подлинности из локального кэша.~/.databricks/token-cache.json Обновите маркер доступа, если срок действия истек или близок к истечению срока действия. Эта команда работает только с проверкой подлинности U2M (с помощью databricks auth login команды). Проверка подлинности M2M с использованием идентификатора клиента и секрета не поддерживается.

databricks auth token [HOST_OR_PROFILE] [flags]

Сведения о настройке и настройке проверки подлинности OAuth U2M см. в разделе проверки подлинности OAuth (U2M).

Аргументы

HOST_OR_PROFILE

URL-адрес узла Databricks или имя профиля (необязательно)

Опции

--account-id string

Идентификатор учетной записи Databricks

--force-refresh

Принудительное обновление маркера, даже если кэшированный маркер по-прежнему действителен.

--timeout duration

Время ожидания для получения маркера. (по умолчанию 1h0m0s)

Глобальные флаги

Примеры

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

databricks auth token

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

databricks auth token https://my-workspace.cloud.databricks.com

Выходные данные могут быть следующими:

{
  "access_token": "<token-value>",
  "token_type": "Bearer",
  "expiry": "<token-expiration-date-time>"
}

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

databricks auth token --timeout 30m

Глобальные флаги

--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 струна

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

Обратная связь

Были ли сведения на этой странице полезными?

Last updated on 2026-05-21

auth группа команд

описание проверки подлинности databricks

Опции

Примеры

databricks auth env

Опции

Примеры

вход в систему databricks auth

Аргументы

Опции

Примеры

выход из системы проверки подлинности databricks

Аргументы

Опции

Примеры

Профили проверки подлинности databricks

Опции

Примеры

параметр проверки подлинности databricks

Опции

Примеры

маркер проверки подлинности databricks

Аргументы

Опции

Примеры

Глобальные флаги

Обратная связь

Дополнительные ресурсы

`auth` группа команд