Exercício - Criar aplicativo .NET e SDK de referência

Concluído

Como a primeira etapa para criar o aplicativo do seu projeto, você precisa criar um projeto .NET. Lembre-se de que o projeto .NET deve usar o SDK do Microsoft.Azure.Cosmos para se conectar à conta que você já criou. Neste momento, existem três requisitos fundamentais:

  • Criar um projeto .NET
  • Adicionar uma referência de pacote ao SDK
  • Conectar-se usando as classes de cliente

Illustration of icons of an Azure Cosmos DB account and .NET application.

Depois de concluir este exercício, você terá um aplicativo .NET simples que se conecta com êxito à sua API para conta NoSQL, mas ainda não executa nenhuma operação.

Criar um projeto de console .NET

A CLI do .NET cria e gerencia projetos .NET dentro de um diretório especificado. Aqui, você usa a CLI para criar um novo aplicativo de console e adicionar uma referência de pacote ao SDK.

  1. Crie um novo aplicativo de console no diretório atual.

    dotnet new console
    

    Gorjeta

    Como você não especificou um nome de projeto ou um diretório, o comando criará o novo projeto no diretório atual e nomeará o projeto para corresponder ao nome do diretório (inventário).

  2. Adicione uma referência de pacote à versão 3 do SDK Microsoft.Azure.Cosmos do NuGet.

    dotnet add package Microsoft.Azure.Cosmos --version 3.*
    
  3. Crie o projeto .NET para garantir que você configurou corretamente seu projeto.

    dotnet build
    

    A saída do comando deve ser semelhante a este exemplo:

    MSBuild version 17.5.0+6f08c67f3 for .NET
      Determining projects to restore...
      All projects are up-to-date for restore.
      dotnet-env-azure-cosmos-db -> /workspaces/dotnet-env-azure-cosmos-db/bin/Debug/net7.0/dotnet-env-azure-cosmos-db.dll
    
    Build succeeded.
        0 Warning(s)
        0 Error(s)
    
    Time Elapsed 00:00:05.96
    

Conecte-se à conta

Agora, o projeto .NET deve ser criado e pronto para você adicionar seu próprio código personalizado. Você tem acesso ao Microsoft.Azure.Cosmos namespace e a todas as classes necessárias para se conectar à API para NoSQL. Aqui, você abre o arquivo Program.cs e implementa o código para se conectar à conta usando as classes de cliente do SDK.

  1. Abra o arquivo Program.cs no editor de códigos.

  2. Exclua todo o código existente do arquivo.

  3. Adicione usando diretivas para os seguintes namespaces:

    using Microsoft.Azure.Cosmos;
    using Microsoft.Azure.Cosmos.Fluent;
    using Microsoft.Azure.Cosmos.Linq;
    
  4. Crie uma variável de cadeia de caracteres constante chamada connectionString. Defina o valor da variável para a cadeia de conexão que você registrou anteriormente neste módulo.

    const string connectionString = "<your-azure-cosmos-db-connection-string>";
    

    Gorjeta

    Supondo que o nome da conta do Azure Cosmos DB seja e a chave seja nybncrsna76fo-cosmos-nosql Aj2OSQqWhXfFzkITIi4MIbocWAAoBCUWnSPzHlQbDYA3TiyZCJlk8A6R1l6WqD45BxAG5vrsyQ4SCXEkPS1pLh==, você configuraria a cadeia de conexão como este exemplo:

    const string connectionString = "AccountEndpoint=https://nybncrsna76fo-cosmos-nosql.documents.azure.com:443/;AccountKey=Aj2OSQqWhXfFzkITIi4MIbocWAAoBCUWnSPzHlQbDYA3TiyZCJlk8A6R1l6WqD45BxAG5vrsyQ4SCXEkPS1pLh==;";
    
  5. Imprima a cadeia de conexão no console.

    Console.WriteLine($"[Connection string]:\t{connectionString}");
    
  6. Crie uma nova instância da CosmosSerializationOptions classe chamada serializerOptions. Defina a PropertyNamingPolicy propriedade como o valor CamelCase da CamelCase enumeração.

    CosmosSerializationOptions serializerOptions = new()
    {
        PropertyNamingPolicy = CosmosPropertyNamingPolicy.CamelCase
    };
    
  7. Crie uma nova instância da classe passando a cadeia de CosmosClientBuilder conexão para o construtor. Em seguida, encadeie o método fluent e defina o WithSerializerOptions(CosmosSerializationOptions) parâmetro desse método como serializerOptions. Encadeie o Build() método para criar uma instância do tipo CosmosClient chamado client. Finalmente, envolva a criação da variável cliente com uma instrução using.

    using CosmosClient client = new CosmosClientBuilder(connectionString)
        .WithSerializerOptions(serializerOptions)
        .Build();
    
  8. Imprima uma mensagem indicando que seu cliente está pronto.

    Console.WriteLine("[Client ready]");    
    
  9. Salve o arquivo .cs programa.

Verifique o seu trabalho

O aplicativo agora está pronto para ser executado e se conectar ao Azure Cosmos DB para NoSQL. Aqui, você compara o código do seu aplicativo com o nosso exemplo. Em seguida, verifique se seu aplicativo funciona conforme o esperado executando o código.

  1. Execute o aplicativo .NET no terminal

    dotnet run
    
  2. Observe a saída da execução do aplicativo. A saída deve corresponder ao exemplo aqui.

    [Connection string]:    <your-azure-cosmos-db-connection-string>
    [Client ready]
    

Nota

Se a criação ou execução do aplicativo .NET resultar em um erro, vá para a guia Revisar código para validar se seu código corresponde ao exemplo.