Compartilhar via

Perfis de configuração do Azure Databricks

Um perfil de configuração do Azure Databricks armazena as configurações de autenticação no .databrickscfg arquivo. Os perfis de configuração facilitam a alternância entre diferentes workspaces, ambientes ou métodos de autenticação sem alterar seu código.

Ferramentas, SDKs, scripts e aplicativos podem referenciar perfis de configuração para autenticar com o Azure Databricks. Todas as ferramentas e SDKs que implementam autenticação unificada oferecem suporte a perfis de configuração.

O que é um perfil de configuração?

Um perfil de configuração é uma seção nomeada no .databrickscfg arquivo que contém o seguinte:

  • Credenciais de autenticação, como tokens ou credenciais de identidade de serviço
  • O workspace ou a URL da conta do Azure Databricks
  • Configurações opcionais específicas para o método de autenticação

Crie vários perfis em um único .databrickscfg arquivo para gerenciar conexões com diferentes workspaces ou ambientes, como desenvolvimento, preparo e produção.

Criar um perfil de configuração

Crie um perfil de configuração usando a CLI do Databricks ou editando manualmente o .databrickscfg arquivo.

Criar um perfil com a CLI

A maneira mais fácil de criar um perfil de configuração para autenticação interativa de usuário é com a CLI do Databricks:

databricks auth login --host <workspace-url>

A CLI abre seu navegador da Web para concluir o fluxo de autenticação. Depois de entrar, a CLI salva as credenciais como um perfil de configuração.

Criar um perfil manualmente

Para criar um perfil de configuração manualmente:

  1. Crie um arquivo nomeado .databrickscfg no diretório inicial:

    • Unix, Linux, macOS:~/.databrickscfg
    • Windows: %USERPROFILE%\.databrickscfg

  2. Adicione um perfil com o seguinte formato:

    [<profile-name>]
<field-name> = <field-value>

    Substitua os espaços reservados:

    • <profile-name>: um nome exclusivo como DEFAULT, DEVELOPMENTou PRODUCTION
    • <field-name> e <field-value>: os campos de autenticação para seu método de autenticação

Por exemplo, para a autenticação M2M (máquina a máquina) do OAuth, o .databrickscfg arquivo tem esta aparência:

[DEFAULT]
host          = https://<workspace-url>
client_id     = <client-id>
client_secret = <client-secret>

Criar vários perfis

Defina vários perfis no mesmo .databrickscfg arquivo para gerenciar diferentes workspaces ou ambientes. Cada perfil deve ter um nome exclusivo.

[DEFAULT]
host          = https://production-workspace-url
client_id     = <production-client-id>
client_secret = <production-client-secret>

[DEVELOPMENT]
host          = https://dev-workspace-url
client_id     = <dev-client-id>
client_secret = <dev-client-secret>

[STAGING]
host          = https://staging-workspace-url
client_id     = <staging-client-id>
client_secret = <staging-client-secret>

Combinar tipos de autenticação

Defina vários métodos de autenticação em perfis separados em seu arquivo de configuração. Isso é útil quando você deseja usar credenciais diferentes para diferentes fluxos de trabalho ou ferramentas. Por exemplo, você pode usar a autenticação nativa de nuvem para uso interativo e credenciais OAuth para automação:

[DEFAULT]
host = https://<workspace-url>

[SERVICE_PRINCIPAL]
azure_workspace_resource_id = /subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/Microsoft.Databricks/workspaces/<workspace-name>
azure_tenant_id             = <tenant-id>
azure_client_id             = <client-id>
azure_client_secret         = <client-secret>

Para obter mais informações sobre os tipos de autenticação e seus campos necessários, consulte a autenticação unificada do Databricks.

Usar um perfil de configuração

Depois de criar um perfil de configuração, faça referência a ele em suas ferramentas e código. Se você não especificar um nome de perfil, as ferramentas e os SDKs do Azure Databricks usarão automaticamente o DEFAULT perfil.

Para usar um perfil diferente DEFAULT, especifique o nome do perfil:

Com a CLI do Databricks:

databricks workspace list --profile DEVELOPMENT

Com a variável de ambiente:

export DATABRICKS_CONFIG_PROFILE=DEVELOPMENT
databricks workspace list

Com o SDK do Python:

from databricks.sdk import WorkspaceClient

# Specify profile in code
w = WorkspaceClient(profile="DEVELOPMENT")

# Or use environment variable DATABRICKS_CONFIG_PROFILE

Práticas recomendadas

  • Utilize o perfil PADRÃO para seu espaço de trabalho mais comum para minimizar a necessidade de especificar nomes de perfil.
  • Use nomes de perfil descritivos como PRODUCTION, DEVELOPMENTou STAGING em vez de nomes genéricos.
  • Proteja seu .databrickscfg arquivo definindo permissões de arquivo restritas (legíveis somente pelo usuário).
  • Não se comprometa com .databrickscfg o controle de versão. Adicione-o ao arquivo .gitignore .
  • Use entidades de serviço para cargas de trabalho de produção em vez de tokens de acesso pessoal.
  • Altere as credenciais regularmente e atualize os seus perfis em conformidade.

Resolução de problemas

Se o perfil não puder ser encontrado, verifique o seguinte:

  • O .databrickscfg arquivo está no diretório base.
  • Você usa o nome exato do perfil.
  • O arquivo não é nomeado .databrickscfg.txt ou algo semelhante.

Se a autenticação falhar, verifique o seguinte:

  • Suas credenciais são atuais e não expiraram.
  • A host URL está correta.
  • Você tem as permissões necessárias para as operações que está tentando.

Teste seus perfis de configuração usando a CLI do Databricks:

# Inspect a specific profile
databricks auth env --profile DEVELOPMENT

# List all profiles
databricks auth profiles

Para obter mais informações, consulte Testar seus perfis de configuração.

Saiba Mais

  • Last updated on