Partilhar 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 espaços de trabalho, ambientes ou métodos de autenticação sem alterar o código.

Ferramentas, SDKs, scripts e aplicativos podem fazer referência a perfis de configuração para autenticação com o Azure Databricks. Todas as ferramentas e SDKs que implementam a autenticação unificada suportam perfis de configuração.

O que é um perfil de configuração?

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

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

Crie vários perfis em um único .databrickscfg arquivo para gerenciar conexões com diferentes espaços de trabalho ou ambientes, como desenvolvimento, preparação 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 do usuário é com a CLI do Databricks:

databricks auth login --host <workspace-url>

A CLI abre o 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 em seu diretório pessoal:

    • Unix, Linux, macOS:~/.databrickscfg
    • Windows:%USERPROFILE%\.databrickscfg
  2. Adicione um perfil com o seguinte formato:

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

    Substitua os marcadores:

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

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

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

Crie vários perfis

Defina vários perfis no mesmo .databrickscfg arquivo para gerenciar diferentes espaços de trabalho 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 dentro do seu arquivo de configuração. Isso é útil quando você deseja usar credenciais diferentes para fluxos de trabalho ou ferramentas diferentes. Por exemplo, você pode usar a autenticação nativa da 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 tipos de autenticação e seus campos obrigatórios, consulte Autenticação unificada 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 SDKs do Azure Databricks usarão automaticamente o DEFAULT perfil.

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

Utilizando a CLI do Databricks:

databricks workspace list --profile DEVELOPMENT

Com ambiente variável:

export DATABRICKS_CONFIG_PROFILE=DEVELOPMENT
databricks workspace list

Com o Python SDK:

from databricks.sdk import WorkspaceClient

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

# Or use environment variable DATABRICKS_CONFIG_PROFILE

Melhores práticas

  • Use o perfil DEFAULT 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 o seu .databrickscfg ficheiro definindo permissões de ficheiro restritas (legíveis apenas pelo utilizador).
  • Não se comprometa com .databrickscfg o controle de versão. Adicione-o ao seu .gitignore ficheiro.
  • Use entidades de serviço para cargas de trabalho de produção em vez de tokens de acesso pessoal.
  • Alterne as credenciais regularmente e atualize seus perfis de acordo.

Solução de problemas

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

  • O .databrickscfg arquivo está em seu diretório inicial.
  • Você usa o nome exato do perfil.
  • O arquivo não tem nome .databrickscfg.txt ou algo semelhante.

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

  • Suas credenciais estão atualizadas e não expiraram.
  • O host URL está correto.
  • 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.

Mais informações