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

Статья
10/29/2024

Примечание.

Эта информация относится к Интерфейсу командной строки Databricks версии 0.205 и выше. Интерфейс командной строки Databricks находится в общедоступной предварительной версии.

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

Группа auth команд в интерфейсе командной строки Databricks позволяет:

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

Команды выполняются auth путем добавления их в databricks auth. Чтобы отобразить справку по команде auth , выполните команду databricks auth -h.

Список профилей конфигурации

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

databricks auth profiles

Выходные данные (многоточие представляют опущенное содержимое для краткости):

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

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

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

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

Сведения о создании профилей конфигурации см. в разделе "Настройка группы команд".

Получение сведений о профиле конфигурации

Чтобы получить сведения о существующем профиле конфигурации, выполните auth env команду, где <profile-name> представляет имя профиля и <account-or-workspace-url> представляет URL-адрес консоли учетной записи Azure Databricks или URL-адрес рабочей области Azure Databricks, как показано ниже.

databricks auth env --profile <profile-name>

# Or:
databricks auth env --host <account-or-workspace-url>

Совет

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

Например, ниже приведены выходные данные для профиля, настроенного с проверкой подлинности маркера доступа Azure Databricks:

{
  "env": {
    "DATABRICKS_AUTH_TYPE": "pat",
    "DATABRICKS_CONFIG_PROFILE": "<profile-name>",
    "DATABRICKS_HOST": "<workspace-url>",
    "DATABRICKS_TOKEN": "<token-value>"
  }
}

Примечание.

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

Сведения о создании профиля конфигурации см. в разделе "Настройка группы команд".

Проверка подлинности с помощью OAuth

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

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

Получение сведений о маркере доступа OAuth

Если вы хотите просмотреть сведения о кэшированном маркере доступа OAuth, созданном ранее для рабочей области Azure Databricks, выполните auth token команду, где <workspace-url> представляет URL-адрес рабочей области Azure Databricks, как показано ниже.

databricks auth token <workspace-url>

Выходные данные:

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

Получение сведений о проверке подлинности

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

Если параметры не указаны, auth describe команда следует методам по умолчанию для единой проверки подлинности клиента.

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 <profile-name>

Выходные данные:

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: <profile-name> (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

Поделиться через

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

Список профилей конфигурации

Получение сведений о профиле конфигурации

Проверка подлинности с помощью OAuth

Получение сведений о маркере доступа OAuth

Получение сведений о проверке подлинности

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

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

Поделиться через

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

Список профилей конфигурации

Получение сведений о профиле конфигурации

Проверка подлинности с помощью OAuth

Получение сведений о маркере доступа OAuth

Получение сведений о проверке подлинности

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

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

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