Início Rápido: Criar um aplicativo Web do .NET usando a API para MongoDB do Azure Cosmos DBQuickstart: Build a .NET web app using Azure Cosmos DB's API for MongoDB

O Azure Cosmos DB é o serviço de banco de dados multimodelo distribuído globalmente da Microsoft.Azure Cosmos DB is Microsoft’s globally distributed multi-model database service. É possível criar e consultar rapidamente bancos de dados de documentos, de chave/valor e de grafo, que se beneficiem das funcionalidades de escala horizontal e de distribuição global no núcleo do Cosmos DB.You can quickly create and query document, key/value and graph databases, all of which benefit from the global distribution and horizontal scale capabilities at the core of Cosmos DB.

Este início rápido demonstra como criar uma conta do Cosmos com a API do Azure Cosmos DB para MongoDB.This quickstart demonstrates how to create a Cosmos account with Azure Cosmos DB's API for MongoDB. Em seguida, você criará e implantará um aplicativo Web de lista de tarefas criado usando o driver .NET do MongoDB.You'll then build and deploy a tasks list web app built using the MongoDB .NET driver.

Pré-requisitos para executar o aplicativo de exemploPrerequisites to run the sample app

Para executar o exemplo, você precisará do Visual Studio e de uma conta válida do Azure Cosmos DB.To run the sample, you'll need Visual Studio and a valid Azure Cosmos DB account.

Caso ainda não tenha o Visual Studio, baixe o Visual Studio 2019 Community Edition com a carga de trabalho de desenvolvimento para a Web e ASP.NET inserida na instalação.If you don't already have Visual Studio, download Visual Studio 2019 Community Edition with the ASP.NET and web development workload installed with setup.

Se você não tiver uma assinatura do Azure, crie uma conta gratuita antes de começar.If you don't have an Azure subscription, create a free account before you begin.

Criar uma conta de banco de dadosCreate a database account

  1. Em uma nova janela, entre no portal do Azure.In a new window, sign in to the Azure portal.

  2. No menu à esquerda, selecione Criar um recurso, Bancos de dados e em Azure Cosmos DB, selecione Criar.In the left menu, select Create a resource, select Databases, and then under Azure Cosmos DB, select Create.

    Captura de tela do portal do Azure, realçando Mais Serviços e Azure Cosmos DB

  3. Na página Criar Conta do Azure Cosmos DB, insira as configurações da nova conta do Azure Cosmos DB.In the Create Azure Cosmos DB Account page, enter the settings for the new Azure Cosmos DB account.

    ConfiguraçãoSetting ValorValue DESCRIÇÃODescription
    SubscriptionSubscription Sua assinaturaYour subscription Selecione a assinatura do Azure que você deseja usar para essa conta do Azure Cosmos DB.Select the Azure subscription that you want to use for this Azure Cosmos DB account.
    Grupo de recursosResource Group Criar NovoCreate new

    Em seguida, insira o mesmo nome exclusivo fornecido na IDThen enter the same unique name as provided in ID
    Selecione Criar novo.Select Create new. Insira o novo nome do grupo de recursos para sua conta.Then enter a new resource-group name for your account. Para simplificar, use um nome igual à sua ID.For simplicity, use the same name as your ID.
    Nome da contaAccount Name Insira um nome exclusivoEnter a unique name Insira um nome exclusivo para identificar a conta do Azure Cosmos DB.Enter a unique name to identify your Azure Cosmos DB account. Como documents.Azure.com é acrescentado à ID que você fornece para criar o URI, use uma ID exclusiva.Because documents.azure.com is appended to the ID that you provide to create your URI, use a unique ID.

    A ID deve conter apenas letras minúsculas, números e o caractere de hífen (-).The ID can use only lowercase letters, numbers, and the hyphen (-) character. Ela precisa ter entre 3 e 31 caracteres.It must be between 3 and 31 characters in length.
    APIAPI API do Azure Cosmos DB para MongoDBAzure Cosmos DB's API for MongoDB A API determina o tipo de conta a ser criada.The API determines the type of account to create. O Azure Cosmos DB fornece cinco APIs: Core (SQL) para bancos de dados de documentos, Gremlin para o bancos de dados de grafos, API para MongoDB do Azure Cosmos DB para bancos de dados de documentos, Tabela do Azure e Cassandra.Azure Cosmos DB provides five APIs: Core (SQL) for document databases, Gremlin for graph databases, Azure Cosmos DB's API MongoDB for document databases, Azure Table, and Cassandra. No momento, você deve criar uma conta separada para cada API.Currently, you must create a separate account for each API.

    Selecione MongoDB, porque neste guia de início rápido você está criando uma tabela que funciona com o MongoDB.Select MongoDB because in this quickstart you are creating a table that works with the MongoDB.
    LocationLocation Selecione a região mais próxima de seus usuáriosSelect the region closest to your users Selecione uma localização geográfica para hospedar a sua conta do Azure Cosmos DB.Select a geographic location to host your Azure Cosmos DB account. Use o local mais próximo dos usuários para fornecer a eles acesso mais rápido aos dados.Use the location that's closest to your users to give them the fastest access to the data.

    Selecione Revisar + Criar.Select Review+Create. Você pode ignorar as seções Rede e Marcas.You can skip the Network and Tags section.

    A página da nova conta do Azure Cosmos DB

  4. A criação da conta leva alguns minutos.The account creation takes a few minutes. Aguarde até que o portal exiba a página Parabéns! Sua conta do Cosmos com a compatibilidade de protocolo de transmissão para o MongoDB está pronta.Wait for the portal to display the Congratulations! Your Cosmos account with wire protocol compatibility for MongoDB is ready page.

    O painel Notificações do portal do Azure

O exemplo descrito neste artigo é compatível com MongoDB.Driver versão 2.6.1.The sample described in this article is compatible with MongoDB.Driver version 2.6.1.

Clonar o aplicativo de exemploClone the sample app

Primeiro, baixe o aplicativo de exemplo do GitHub.First, download the sample app from GitHub.

  1. Abra um prompt de comando, crie uma nova pasta chamada exemplos de git e feche o prompt de comando.Open a command prompt, create a new folder named git-samples, then close the command prompt.

    md "C:\git-samples"
    
  2. Abra uma janela de terminal de git, como git bash, e use o comando cd para alterar para a nova pasta para instalar o aplicativo de exemplo.Open a git terminal window, such as git bash, and use the cd command to change to the new folder to install the sample app.

    cd "C:\git-samples"
    
  3. Execute o comando a seguir para clonar o repositório de exemplo.Run the following command to clone the sample repository. Este comando cria uma cópia do aplicativo de exemplo no seu computador.This command creates a copy of the sample app on your computer.

    git clone https://github.com/Azure-Samples/azure-cosmos-db-mongodb-dotnet-getting-started.git
    

Se não quiser usar o git, você também pode baixar o projeto como um arquivo ZIP.If you don't wish to use git, you can also download the project as a ZIP file.

Examine o códigoReview the code

Esta etapa é opcional.This step is optional. Se você estiver interessado em aprender como os recursos de banco de dados são criados no código, poderá examinar os snippets de código a seguir.If you're interested in learning how the database resources are created in the code, you can review the following snippets. Caso contrário, você poderá pular para Atualizar sua cadeia de conexão.Otherwise, you can skip ahead to Update your connection string.

Todos os snippets de código a seguir são retirados do arquivo Dal.cs no diretório DAL.The following snippets are all taken from the Dal.cs file in the DAL directory.

  • Inicialize o cliente.Initialize the client.

        MongoClientSettings settings = new MongoClientSettings();
        settings.Server = new MongoServerAddress(host, 10255);
        settings.UseSsl = true;
        settings.SslSettings = new SslSettings();
        settings.SslSettings.EnabledSslProtocols = SslProtocols.Tls12;
    
        MongoIdentity identity = new MongoInternalIdentity(dbName, userName);
        MongoIdentityEvidence evidence = new PasswordEvidence(password);
    
        settings.Credential = new MongoCredential("SCRAM-SHA-1", identity, evidence);
    
        MongoClient client = new MongoClient(settings);
    
  • Recupere o banco de dados e a coleção.Retrieve the database and the collection.

    private string dbName = "Tasks";
    private string collectionName = "TasksList";
    
    var database = client.GetDatabase(dbName);
    var todoTaskCollection = database.GetCollection<MyTask>(collectionName);
    
  • Recupere todos os documentos.Retrieve all documents.

    collection.Find(new BsonDocument()).ToList();
    

Criar uma tarefa e inseri-la na coleçãoCreate a task and insert it into the collection

 public void CreateTask(MyTask task)
 {
     var collection = GetTasksCollectionForEdit();
     try
     {
         collection.InsertOne(task);
     }
     catch (MongoCommandException ex)
     {
         string msg = ex.Message;
     }
 }

Da mesma forma, é possível atualizar e excluir documentos usando os métodos de coleção. UpdateOne() e coleção. DeleteOne().Similarly, you can update and delete documents by using the collection.UpdateOne() and collection.DeleteOne() methods.

Atualizar sua cadeia de conexãoUpdate your connection string

Agora, volte ao portal do Azure para obter informações sobre a cadeia de conexão e copiá-las para o aplicativo.Now go back to the Azure portal to get your connection string information and copy it into the app.

  1. No portal do Azure, na sua conta do Cosmos, no painel de navegação esquerdo, clique em Cadeia de Conexão e, em seguida, clique em Chaves de leitura/gravação.In the Azure portal, in your Cosmos account, in the left navigation click Connection String, and then click Read-write Keys. Você usará os botões de cópia no lado direito da tela para copiar o Nome de usuário, Senha e Host para o arquivo Dal.cs na próxima etapa.You'll use the copy buttons on the right side of the screen to copy the Username, Password, and Host into the Dal.cs file in the next step.

  2. Abra o arquivo Dal.cs no diretório DAL.Open the Dal.cs file in the DAL directory.

  3. Copie o valor do nome de usuário do portal (usando o botão de cópia) e transforme-o no valor do nome de usuário no arquivo Dal.cs.Copy your username value from the portal (using the copy button) and make it the value of the username in your Dal.cs file.

  4. Em seguida, copie o valor de host do portal e transforme-o no valor do host no arquivo Dal.cs.Then copy your host value from the portal and make it the value of the host in your Dal.cs file.

  5. Em seguida, copie sua senha do portal e transforme-o no valor da senha no arquivo Dal.cs.Finally copy your password value from the portal and make it the value of the password in your Dal.cs file.

Agora, você atualizou o aplicativo com todas as informações necessárias para comunicar-se com o Cosmos DB.You've now updated your app with all the info it needs to communicate with Cosmos DB.

Executar o aplicativo WebRun the web app

  1. No Visual Studio, clique com o botão direito do mouse no projeto no Gerenciador de Soluções e clique em Gerenciar Pacotes NuGet.In Visual Studio, right-click on the project in Solution Explorer and then click Manage NuGet Packages.

  2. Na caixa Procurar do NuGet, digite MongoDB.Driver.In the NuGet Browse box, type MongoDB.Driver.

  3. Nos resultados, instale a biblioteca MongoDB.Driver.From the results, install the MongoDB.Driver library. Isso instala o pacote do MongoDB.Driver, bem como todas as dependências.This installs the MongoDB.Driver package as well as all dependencies.

  4. Clique em CTRL + F5 para executar o aplicativo.Click CTRL + F5 to run the application. Seu aplicativo é exibido no navegador.Your app displays in your browser.

  5. Clique em Criar no navegador e crie algumas novas tarefas em seu aplicativo de lista de tarefas.Click Create in the browser and create a few new tasks in your task list app.

Examinar SLAs no Portal do AzureReview SLAs in the Azure portal

O portal do Azure monitora a taxa de transferência, armazenamento, disponibilidade, latência e consistência da conta do Cosmos DB.The Azure portal monitors your Cosmos DB account throughput, storage, availability, latency, and consistency. Gráficos de métricas associados a um SLA (Contrato de Nível de Serviço) do Azure Cosmos DB mostram o valor do SLA em comparação com o desempenho real.Charts for metrics associated with an Azure Cosmos DB Service Level Agreement (SLA) show the SLA value compared to actual performance. Esse conjunto de métricas torna o monitoramento dos SLAs transparente.This suite of metrics makes monitoring your SLAs transparent.

Para examinar as métricas e os SLAs:To review metrics and SLAs:

  1. Selecione Métricas no menu de navegação da sua conta do Cosmos DB.Select Metrics in your Cosmos DB account's navigation menu.

  2. Selecione uma guia, tal como Latência, e selecione um período à direita.Select a tab such as Latency, and select a timeframe on the right. Comparar as linhas Real e SLA dos gráficos.Compare the Actual and SLA lines on the charts.

    Pacote de métricas do Azure Cosmos DB

  3. Examine as métricas nas outras guias.Review the metrics on the other tabs.

Limpar recursosClean up resources

Quando você concluir seu aplicativo Web e a conta do Azure Cosmos DB, poderá excluir os recursos do Azure criados para não incorrer em mais cobranças.When you're done with your web app and Azure Cosmos DB account, you can delete the Azure resources you created so you don't incur more charges. Para excluir os recursos:To delete the resources:

  1. No portal do Azure, selecione Grupos de recursos no canto esquerdo.In the Azure portal, select Resource groups on the far left. Se o menu esquerdo estiver recolhido, selecione Expandir botão para expandi-lo.If the left menu is collapsed, select Expand button to expand it.

  2. Selecione o grupo de recursos que você criou para este início rápido.Select the resource group you created for this quickstart.

    Selecione o grupo de recursos a excluir

  3. Na nova janela, selecione Excluir grupo de recursos.In the new window, select Delete resource group.

    Exclua o grupo de recursos

  4. Na próxima janela, insira o nome do grupo de recursos a ser excluído e selecione Excluir.In the next window, enter the name of the resource group to delete, and then select Delete.

Próximas etapasNext steps

Neste início rápido, você aprendeu como criar uma conta do Cosmos, criar uma coleção e executar um aplicativo de console.In this quickstart, you've learned how to create a Cosmos account, create a collection and run a console app. Agora você pode importar dados adicionais para o banco de dados Cosmos.You can now import additional data to your Cosmos database.