Início Rápido: Executar um SDK do Dataverse para .NET solicitação em C#

Este início rápido mostra como usar o SDK do Microsoft Dataverse para .NET em um aplicativo de console C# mínimo. Conecte-se ao serviço Organização usando a ServiceClient classe e execute uma solicitação de serviço Web para verificar o acesso aos dados comerciais do seu ambiente.

Seu aplicativo chama o método IOrganizationService.Execute e passa uma instância da WhoAmIRequest classe. O resultado retornado do serviço Web é um valor WhoAmIResponse.UserId preenchido que é o identificador exclusivo da sua conta de usuário do sistema Dataverse.

Note

Este exemplo de início rápido não inclui tratamento de exceções para fins de brevidade. Este início rápido é um exemplo de código mínimo do que você precisa para se conectar e usar o SDK para .NET.

Você pode obter o exemplo de código completo do GitHub GetStarted. Consulte o LEIAME do programa para obter mais detalhes.

Pré-requisitos

  • Visual Studio (2026 ou posterior)
  • Conexão com a Internet
  • Credenciais de entrada para uma conta de usuário do sistema Dataverse para o ambiente de destino
  • Endereço de URL do ambiente do Dataverse com o qual você deseja se conectar
  • Noções básicas sobre a linguagem Visual C#

Leia as informações importantes a seguir sobre como usar uma cadeia de conexão ou autenticação de nome de usuário/senha no código do aplicativo.

Important

A Microsoft recomenda usar o fluxo de autenticação mais seguro disponível. O fluxo de autenticação descrito neste artigo requer um alto grau de confiança no aplicativo e traz riscos que não estão presentes em outros fluxos. Você só deve usar esse fluxo quando outros fluxos mais seguros, como identidades gerenciadas, não forem viáveis.

Criar um projeto de aplicativo de console .NET no Visual Studio

  1. Criar um novo projeto. Para este projeto, use Visual Studio 2026.

    Captura de tela de Visual Studio mostrando a opção de iniciar um novo projeto

  2. Escolha o modelo de projeto do aplicativo de console .NET.

    Captura de tela de Visual Studio mostrando o modelo de projeto do aplicativo de console .NET.

    Selecione Próximo.

  3. Defina o nome do projeto e o local.

    Captura de tela de Visual Studio mostrando o nome do .NET e a caixa de diálogo local.

    Selecione Próximo.

  4. Selecione .NET 10.0 (suporte a longo prazo) como a Estrutura.

    Captura de tela de Visual Studio mostrando a configuração de suporte das estruturas de .NET.

    Selecione Criar.

  5. No Gerenciador de Soluções, clique com o botão direito do mouse no projeto criado e selecione Gerenciar Pacotes NuGet... no menu de contexto.

    Captura de tela de Gerenciador de Soluções com Gerenciar Pacotes NuGet selecionados para o projeto.

  6. Procure a versão mais recente do pacote NuGet e instale-a Microsoft.PowerPlatform.Dataverse.Client .

    Captura de tela do NuGet Gerenciador de Pacotes mostrando o Microsoft. Pacote PowerPlatform.Dataverse.Client pronto para instalação.

Note

Você será solicitado a selecionar Aplicar a alterações de visualização e, em seguida, selecione Aceito na caixa de diálogo Aceitação da Licença .

Adicionar código para o SDK do Dataverse para solicitação de .NET

  1. Em Gerenciador de Soluções, clique Program.cs duas vezes para editar o arquivo. Substitua o conteúdo do arquivo pelo código a seguir.

    using Microsoft.Crm.Sdk.Messages;
    using Microsoft.PowerPlatform.Dataverse.Client;
    using Microsoft.Xrm.Sdk;
    
    /// <summary>
    /// Public client authentication followed by a web service request.
    /// Use of username and password for authentication.
    /// </summary>
    /// <remarks>This sample uses a standard app registration used for
    /// demonstrating SDK code samples.</remarks>
    class Program
    {
        // TODO Enter your Dataverse environment's URL and logon info.
        static string url = "https://myorg.crm.dynamics.com";
        static string userName = "someone@myorg.onmicrosoft.com";
        static string password = "password";
    
        // This service connection string uses the info provided above.
        // The standard AppId and RedirectUri are provided for sample code demonstration only.
        static string connectionString = $@"
        AuthType = OAuth;
        Url = {url};
        UserName = {userName};
        Password = {password};
        AppId = 51f81489-12ee-4a9e-aaae-a2591f45987d;
        RedirectUri = http://localhost;
        LoginPrompt=Auto;
        RequireNewInstance = True";
    
        static void Main()
        {
            // ServiceClient class implements IOrganizationService interface
            IOrganizationService service = new ServiceClient(connectionString);
    
            var response = (WhoAmIResponse)service.Execute(new WhoAmIRequest());
    
            Console.WriteLine($"User ID is {response.UserId}.");
    
    
            // Pause the console so it does not close.
            Console.WriteLine("Press the <Enter> key to exit.");
            Console.ReadLine();
        }
    }
    
  2. Altere os valores para o url, userNamee password conforme indicado pelo comentário de // TODO código.

    Note

    Você pode encontrar a URL do ambiente no aplicativo Web herdado em Recursos do Desenvolvedor de Personalização > de Configurações > ou em Power Apps Configurações (ícone de engrenagem) >Recursos do Desenvolvedor.

    Embora este exemplo de código coloque as informações de nome de usuário e senha no código para simplificar, outros exemplos de código usam a abordagem mais recomendada de solicitar essas informações ou armazená-la em um arquivo ou appsettings.json separadoApp.config.

    Você pode encontrar valores com suporte para AuthType listados em parâmetros de cadeia de conexão.

Executar o programa

Pressione F5 para executar o programa. O resultado deverá ser semelhante ao seguinte exemplo:

User ID is 00aa00aa-bb11-cc22-dd33-44ee44ee44ee
Press any key to exit.

Usar os métodos de interface IOrganizationService

O Dataverse.Client.ServiceClient que este programa usa implementa a Interface IOrganizationService, que inclui o método Execute.

Para entender melhor a IOrganizationService interface, experimente as seguintes etapas:

  1. Vá para o artigo de referência da classe WhoAmIRequest.

  2. Copie o método de exemplo desse artigo. Tem esta aparência:

    /// <summary>
    /// Outputs the data returned from the WhoAmI message
    /// </summary>
    /// <param name="service">Authenticated client implementing the IOrganizationService interface</param>
    static void WhoAmIExample(IOrganizationService service) {
    
       var response = (WhoAmIResponse)service.Execute(new WhoAmIRequest());
    
       Console.WriteLine($"OrganizationId:{response.OrganizationId}");
       Console.WriteLine($"BusinessUnitId:{response.BusinessUnitId}");
       Console.WriteLine($"UserId:{response.UserId}");
    
    }
    

    Observe que ele aceita uma IOrganizationService instância de serviço como o parâmetro.

  3. Cole este WhoAmIExample método abaixo do Main método em seu programa.

  4. Substitua o Main método em seu programa por este:

        static void Main()
     {
         //ServiceClient implements IOrganizationService interface
         IOrganizationService service = new ServiceClient(connectionString);
    
         WhoAmIExample(service: service);
    
         // Pause the console so it does not close.
         Console.WriteLine("Press the <Enter> key to exit.");
         Console.ReadLine();
     }
    
  5. Execute o exemplo novamente. Você deve ver algo como:

    OrganizationId:00aa00aa-bb11-cc22-dd33-44ee44ee44ee
    BusinessUnitId:11bb11bb-cc22-dd33-ee44-55ff55ff55ff
    UserId:22cc22cc-dd33-ee44-ff55-66aa66aa66aa
    Press the <Enter> key to exit.
    

Próximas Etapas 

Agora que você tem um programa de console simples que se conecta ao Dataverse, use este projeto para experimentar outros métodos e mensagens. Você pode usar esse projeto de aplicativo de console de Início Rápido para fazer testes ad hoc.

Experimente outros métodos de interface IOrganizationService

Dica

Na documentação, você pode encontrar vários métodos de exemplo como este WhoAmIExample que aceitam um IOrganizationService service parâmetro.

Experimente os exemplos para estes métodos IOrganizationService:

Experimente outras mensagens

Você pode encontrar outras mensagens que você pode invocar usando o método Execute nestes namespaces:

Saiba como trabalhar com dados de registro

Os artigos a seguir explicam como trabalhar com dados corporativos em tabelas do Dataverse:

Explorar nossos exemplos de código

Você pode encontrar o SDK para .NET código de exemplo em nosso repositório GitHub no PowerApps-Samples/dataverse/orgsvc.

Usar extensões do ServiceClient

Além de implementar a interface IOrganizationService, o ServiceClient oferece métodos de extensão além dos métodos principais definidos e IOrganizationService a capacidade de habilitar o registro em log com o ILogger. Saiba mais sobre como usar o ServiceClient