Унифицированная проверка подлинности клиента Databricks
Унифицированные проверки подлинности клиента Databricks централизованно настраивают и автоматизовать проверку подлинности в Azure Databricks. Он позволяет настроить проверку подлинности Databricks один раз, а затем использовать эту конфигурацию в нескольких средствах Databricks и пакетах SDK без дальнейших изменений конфигурации проверки подлинности.
Участвующие средства и пакеты SDK
К участию в средствах Databricks и пакетах SDK относятся:
- Интерфейс командной строки Databricks
- Поставщик Databricks Terraform
- Databricks Connect
- Расширение Databricks для Visual Studio Code
- Пакет SDK Databricks для Python
- Пакет SDK Databricks для Java
- Пакет SDK Databricks для Go
Все участвующие средства и пакеты SDK принимают специальные переменные среды и профили конфигурации Azure Databricks для проверки подлинности. Поставщик Databricks Terraform и пакеты SDK Databricks для Python, Java и Go также принимают прямую конфигурацию параметров проверки подлинности в коде. Дополнительные сведения см. в Средства разработчика документации по инструменту или пакету SDK.
Методы по умолчанию для единой проверки подлинности клиента
Каждый раз, когда средство или пакет SDK должны пройти проверку подлинности в Azure Databricks, он пытается выполнить следующие типы проверки подлинности в следующем порядке по умолчанию. Когда средство или пакет SDK успешно выполняет проверку подлинности с типом проверки подлинности, он перестает выполнять проверку подлинности с помощью оставшихся типов проверки подлинности. Чтобы принудить SDK к аутентификации с использованием определенного типа, задайте поле типа проверки подлинности Config
API Databricks.
- Проверка подлинности с помощью личных маркеров доступа Azure Databricks
- Проверка подлинности доступа к Azure Databricks с помощью субъекта-службы с помощью OAuth (OAuth M2M)
- Проверка подлинности доступа к Azure Databricks с помощью учетной записи пользователя с помощью OAuth (OAuth U2M)
- Проверка подлинности управляемых удостоверений Azure
- Проверка подлинности субъекта-службы MS Entra
- Проверка подлинности Azure CLI
Для каждого типа проверки подлинности, который пытается участвующий инструмент или пакет SDK, средство или пакет SDK пытается найти учетные данные проверки подлинности в следующих расположениях в следующем порядке. Когда средство или пакет SDK успешно находит учетные данные проверки подлинности, которые можно использовать, средство или пакет SDK перестает пытаться находить учетные данные проверки подлинности в оставшихся местах.
- Поля API, связанные с
Config
учетными данными (для пакетов SDK). Сведения о настройке полейConfig
см. в справочной документации по пакету SDK. - Переменные среды, связанные с учетными данными.
- Поля, связанные с учетными данными, в профиле конфигурации в
DEFAULT
.databrickscfg
файле. Сведения о настройке полей профиля конфигурации см. в разделе (/dev-tools/auth/config-profiles.md). - Все связанные учетные данные проверки подлинности, кэшированные Azure CLI. См . проверку подлинности Azure CLI.
Чтобы обеспечить максимальную переносимость кода, Databricks рекомендует создать настраиваемый профиль конфигурации в файле .databrickscfg
, добавьте приведенные ниже поля для целевого типа проверки подлинности Databricks в настраиваемый профиль конфигурации, а затем задайте переменную среды DATABRICKS_CONFIG_PROFILE
имя пользовательского профиля конфигурации.
Переменные среды и поля для единой проверки подлинности клиента
В следующих таблицах перечислены имена и описания поддерживаемых переменных среды и полей для унифицированной проверки подлинности клиента Databricks. В следующих таблицах:
- переменная среды, где применимо, — это имя переменной среды.
-
.databrickscfg
поле, где применимо, — это имя поля в файле профилей конфигурации Azure Databricks или конфигурации Databricks Terraform. Чтобы настроить поля.databrickscfg
, см. профили конфигурации Azure Databricks . - Поле Terraform, если применимо, — это название поля в конфигурации Databricks Terraform. Информацию о настройке полей Databricks Terraform см. в разделе Проверка подлинности документации по поставщику Databricks Terraform.
-
Config
поле — это имя поля вConfig
API для указанного пакета SDK.
Общие переменные среды среды узла, маркера и идентификатора учетной записи
Общее имя | Description | Переменная среды |
.databrickscfg поле Terraform |
ПолеConfig |
---|---|---|---|---|
Узел Azure Databricks | (Строка) URL-адрес узла Azure Databricks для конечной точки рабочей области Azure Databricks или конечной точки учетных записей Azure Databricks. | DATABRICKS_HOST |
host |
host (Python),setHost (Java),Host (Go) |
Токен Azure Databricks | (Строка) Личный маркер доступа Azure Databricks или маркер идентификатора Microsoft Entra. | DATABRICKS_TOKEN |
token |
token (Python),setToken (Java),Token (Go) |
Идентификатор учетной записи Azure Databricks | (Строка) Идентификатор учетной записи Azure Databricks для конечной точки учетной записи Azure Databricks. Действует только в том случае, если для узла Azure Databricks также задано значениеhttps://accounts.azuredatabricks.net . |
DATABRICKS_ACCOUNT_ID |
account_id |
account_id (Python),setAccountID (Java),AccountID (Go) |
Переменные и поля среды, относящиеся к Azure
Общее имя | Description | Переменная среды |
.databrickscfg поле Terraform |
ПолеConfig |
---|---|---|---|---|
Идентификатор клиента Azure | (Строка) Идентификатор приложения субъекта-службы Microsoft Entra ID. Используйте проверку подлинности управляемых удостоверений Azure и проверку подлинности субъекта-службы Идентификатора Microsoft Entra. | ARM_CLIENT_ID |
azure_client_id |
azure_client_id (Python),setAzureClientID (Java),AzureClientID (Go) |
Секрет клиента Azure | (Строка) Секрет клиента субъекта-службы Microsoft Entra ID. Используйте проверку подлинности субъекта-службы Microsoft Entra ID. | ARM_CLIENT_SECRET |
azure_client_secret |
azure_client_secret (Python),setAzureClientSecret (Java),AzureClientSecret (Go) |
Client ID | (Строка) Идентификатор клиента управляемого субъекта-службы Azure Databricks или управляемого субъекта-службы Microsoft Entra ID. Используйте проверку подлинности OAuth M2M. | DATABRICKS_CLIENT_ID |
client_id |
client_id (Python),setClientId (Java),ClientId (Go) |
Секрет клиента | (Строка) Секрет клиента управляемого субъекта-службы Azure Databricks или управляемого субъекта-службы Идентификатора Microsoft Entra. Используйте проверку подлинности OAuth M2M. | DATABRICKS_CLIENT_SECRET |
client_secret |
client_secret (Python),setClientSecret (Java),ClientSecret (Go) |
Среда Azure | (Строка) Тип среды Azure. По умолчанию — PUBLIC . |
ARM_ENVIRONMENT |
azure_environment |
azure_environment (Python),setAzureEnvironment (Java),AzureEnvironment (Go) |
Идентификатор клиента Azure | (Строка) Идентификатор клиента субъекта-службы Microsoft Entra ID. | ARM_TENANT_ID |
azure_tenant_id |
azure_tenant_id (Python),setAzureTenantID (Java),AzureTenantID (Go) |
Использование MSI в Azure | (Логический) True, чтобы использовать поток проверки подлинности без пароля управляемого удостоверения службы Azure для субъектов-служб. Требуется также задать идентификатор ресурса Azure. | ARM_USE_MSI |
azure_use_msi |
AzureUseMSI (Go) |
Идентификатор ресурса Azure | (Строка) Идентификатор Azure Resource Manager для рабочей области Azure Databricks. | DATABRICKS_AZURE_RESOURCE_ID |
azure_workspace_resource_id |
azure_workspace_resource_id (Python),setAzureResourceID (Java),AzureResourceID (Go) |
специфичные для .databrickscfg переменные среды и поля
Используйте эти переменные среды или поля для указания параметров, отличных .databrickscfg
от по умолчанию. См. также профили конфигурации Azure Databricks.
Общее имя | Description | Переменная среды | Поле Terraform | ПолеConfig |
---|---|---|---|---|
.databrickscfg Путь к файлу |
(Строка) Путь, отличный от по умолчанию, к Файл .databrickscfg . |
DATABRICKS_CONFIG_FILE |
config_file |
config_file (Python),setConfigFile (Java),ConfigFile (Go) |
.databrickscfg Профиль по умолчанию |
(Строка) Используемый по умолчанию именованный профиль, отличный от DEFAULT . |
DATABRICKS_CONFIG_PROFILE |
profile |
profile (Python),setProfile (Java),Profile (Go) |
Поле типа проверки подлинности
Используйте эту переменную среды или поле для принудительного использования пакета SDK для использования определенного типа проверки подлинности Databricks.
Общее имя | Description | Поле Terraform | ПолеConfig |
---|---|---|---|
Тип проверки подлинности Databricks | (Строка) Если в среде доступны несколько атрибутов проверки подлинности, используйте тип проверки подлинности, указанный этим аргументом. | auth_type |
auth_type (Python),setAuthType (Java),AuthType (Go) |
Поддерживаются значения полей типа проверки подлинности Databricks:
oauth-m2m
: Задайте это значение, если вы используете учетную запись службы Databricks для аутентификации M2M с OAuth 2.0. Дополнительные сведения см. в статье "Проверка подлинности доступа к Azure Databricks с помощью субъекта-службы с помощью OAuth (OAuth M2M)".pat
: задайте это значение, если вы используете личные токены доступа Databricks. Дополнительные сведения см. в статье Azure Databricks с проверкой подлинности с личным маркером доступа.databricks-cli
: задайте это значение, если вы используете интерфейс командной строки Databricks с OAuth 2.0. Дополнительные сведения см. в статье "Аутентификация доступа к Azure Databricks" с учетной записью пользователя с помощью OAuth (OAuth U2M).azure-msi
. Задайте это значение, если используется управляемое удостоверение службы Azure (MSI). Дополнительные сведения см. в разделе проверки подлинности управляемых удостоверений Azure.azure-client-secret
. Задайте это значение, если вы используете сервисный принципал Azure с клиентскими секретами. Дополнительные сведения см. в разделе проверки подлинности субъекта-службы MS Entra.