Como começar

Este artigo descreve como configurar seu ambiente de Python para acessar o Dataverse por meio do SDK do Dataverse para Python. Em seguida, ele mostra alguns exemplos de codificação simples para você começar.

Pré-requisitos

  • Acesso de leitura/gravação a um ambiente do Dataverse. Você pode usar um ambiente de avaliação.
  • Autenticação OAuth configurada para seu aplicativo.
  • Um ambiente do Python 3.10+ ativado.
  • Pandas versão 2.0.0+.
  • Acesso à rede a pypi.org para obter os pacotes do SDK.

Instalar o SDK e as dependências

Em uma janela de terminal, execute o comando a seguir. Esse comando instala a versão estável mais recente do SDK de um pacote de pypi.org .

pip install PowerPlatform-Dataverse-Client

Execute o comando a seguir para instalar o SDK da origem do GitHub do projeto em vez do pacote. Instale o cliente a partir do pacote PyPi ou do código-fonte, mas não os dois.

git clone <https://github.com/microsoft/PowerPlatform-DataverseClient-Python.git>
cd PowerPlatform-DataverseClient-Python
pip install -e .

Instalar o Claude Skill globalmente

Para melhorar a experiência de desenvolvimento em Python, você pode instalar opcionalmente duas Claude Skills ao instalar o SDK a partir de um pacote.

pip install PowerPlatform-Dataverse-Client && dataverse-install-claude-skill

Importante

As habilidades são carregadas automaticamente ao instalar a partir do código-fonte.

As duas habilidades são descritas na lista a seguir:

  • dataverse-sdk-use: aplique as práticas recomendadas para usar o SDK em seus aplicativos.
  • dataverse-sdk-dev: forneça diretrizes para desenvolver e contribuir com o próprio SDK.

As habilidades funcionam tanto com a CLI do Claude Code quanto com a extensão do Visual Studio Code. Depois de instalado, Claude usa automaticamente a habilidade apropriada ao trabalhar com operações do Dataverse. Para obter mais informações sobre Claude Skill, consulte Habilidades do Agente. Depois de instalar, você pode encontrar as definições de habilidades nos arquivos .claude/skills/dataverse-sdk-use/SKILL.md e .claude/skills/dataverse-sdk-dev/SKILL.md no seu computador de desenvolvimento.

Conectar-se ao Dataverse

O SDK client requer qualquer implementação Azure Identity TokenCredential para autenticação OAuth com o Dataverse.

Este exemplo de código importa o cliente Dataverse e os tipos do Azure Identity e estabelece uma conexão com um ambiente do Dataverse. Certifique-se de alterar myorg na URL pelo nome correto do seu ambiente.

from azure.identity import (
    InteractiveBrowserCredential, 
    ClientSecretCredential,
    CertificateCredential,
    AzureCliCredential
)
from PowerPlatform.Dataverse.client import DataverseClient

# Development options
credential = InteractiveBrowserCredential()  # Browser authentication
# credential = AzureCliCredential()          # If logged in via 'az login'

# Production options  
# credential = ClientSecretCredential(tenant_id, client_id, client_secret)
# credential = CertificateCredential(tenant_id, client_id, cert_path)

client = DataverseClient("https://myorg.crm.dynamics.com", credential)

Você pode personalizar a conexão usando configurações opcionais de HTTP ajustável para lidar com tempos limite de conexão, novas tentativas e muito mais. Acesse essas configurações por meio da classe DataverseConfig .

Agora que você tem uma conexão de cliente estabelecida com um ambiente do Dataverse, pode começar a usar o SDK para trabalhar com dados corporativos, metadados de tabela e muito mais. O próximo artigo aborda alguns exemplos dessas operações.

Para obter mais informações, consulte Usar o OAuth com o Dataverse.

Namespaces

O pacote PowerPlatform.Dataverse.operations contém módulos que organizam operações do SDK em grupos lógicos, conforme descrito na tabela a seguir.

Nome Description
client.records Criar, atualizar, excluir e obter registros (consultas simples ou paginadas)
client.query Operações de consulta e pesquisa
client.tables Gerenciamento de metadados de tabela e coluna
client.files Operações de upload de arquivo
client.dataframe Suporte ao DataFrame do Pandas
client.batch Operações em lote

Para obter exemplos de como usar essas operações, consulte os artigos Consulta de dados e Trabalhando com dados.

Próximas etapas

  • Last updated on