Azure Cosmos DB: Creare un'app Web per le API DocumentDB con .NET e il portale di AzureAzure Cosmos DB: Build a DocumentDB API web app with .NET and the Azure portal

Azure Cosmos DB è il servizio di database multimodello distribuito a livello globale di Microsoft.Azure Cosmos DB is Microsoft’s globally distributed multi-model database service. È possibile creare ed eseguire rapidamente query su database di documenti, coppie chiave/valore e grafi, sfruttando in ognuno dei casi i vantaggi offerti dalle funzionalità di scalabilità orizzontale e distribuzione globale alla base di Azure 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 Azure Cosmos DB.

Questa guida di avvio rapido mostra come creare un account, un database di documenti e una raccolta di Azure Cosmos DB tramite il portale di Azure.This quick start demonstrates how to create an Azure Cosmos DB account, document database, and collection using the Azure portal. Si creerà e distribuirà quindi l'app Web elenco attività basata sull'API .NET DocumentDB, come mostrato nello screenshot seguente.You'll then build and deploy a todo list web app built on the DocumentDB .NET API, as shown in the following screenshot.

App elenco attività con dati di esempio

PrerequisitiPrerequisites

Se Visual Studio 2017 non è ancora installato, è possibile scaricare e usare la versione gratuita Visual Studio 2017 Community Edition.If you don’t already have Visual Studio 2017 installed, you can download and use the free Visual Studio 2017 Community Edition. Durante l'installazione di Visual Studio abilitare Sviluppo di Azure.Make sure that you enable Azure development during the Visual Studio setup.

Se non si ha una sottoscrizione di Azure, creare un account gratuito prima di iniziare.If you don't have an Azure subscription, create a free account before you begin.

È inoltre possibile provare gratuitamente Microsoft Azure Cosmos DB senza una sottoscrizione di Azure e senza impegno.Alternatively, you can Try Azure Cosmos DB for free without an Azure subscription, free of charge and commitments. Oppure usare l'emulatore di Azure Cosmos DB per questa esercitazione con l'URI https://localhost:8081 e la chiaveOr you can use the Azure Cosmos DB Emulator for this tutorial with a URI of https://localhost:8081 and a key of

C2y6yDjf5/R+ob0N8A7Cgv30VRDJIWEHLM+4QDU5DE2nQ9nDuVTqobD4b8mGGyPMbIZnqyMsEcaGQy67XIw/Jw==

Creare un account di databaseCreate a database account

  1. In una nuova finestra del browser accedere al portale di Azure.In a new browser window, sign in to the Azure portal.
  2. Fare clic su Nuovo > Database > Azure Cosmos DB.Click New > Databases > Azure Cosmos DB.

    Riquadro Database nel portale di Azure

  3. Nella pagina Nuovo account immettere le impostazioni per il nuovo account Azure Cosmos DB.In the New account page, enter the settings for the new Azure Cosmos DB account.

    ImpostazioneSetting Valore consigliatoSuggested value DescrizioneDescription
    IDID Immettere un nome univocoEnter a unique name Immettere un nome univoco per identificare l'account Azure Cosmos DB.Enter a unique name to identify this Azure Cosmos DB account. Poiché alI'ID fornito viene aggiunto documents.azure.com per creare l'URI, usare un ID univoco ma facilmente identificabile.Because documents.azure.com is appended to the ID that you provide to create your URI, use a unique but identifiable ID.

    L'ID può contenere solo lettere minuscole, numeri e il segno meno (-) e deve avere una lunghezza compresa tra 3 e 50 caratteri.The ID can contain only lowercase letters, numbers, and the hyphen (-) character, and it must contain 3 to 50 characters.
    APIAPI SQLSQL L'API determina il tipo di account da creare.The API determines the type of account to create. Azure Cosmos DB offre cinque API per soddisfare le esigenze dell'applicazione, ovvero SQL (database di documenti) Gremlin (grafo), MongoDB, SQL (database di documenti), Tabella di Azure e Cassandra, per ognuna delle quali è attualmente necessario un account separato.Azure Cosmos DB provides five APIs to suits the needs of your application: SQL (document database), Gremlin (graph database), MongoDB (document database), Azure Table, and Cassandra, each which currently require a separate account.

    Selezionare SQL perché in questo avvio rapido si sta creando un database di documenti su cui è possibile eseguire query tramite la sintassi SQL e a cui è possibile accedere tramite l'API DocumentDB.Select SQL because in this quickstart you are creating a document database that is queryable using SQL syntax and accessible with the DocumentDB API.

    Altre informazioni sull'API di DocumentDBLearn more about the DocumentDB API
    SottoscrizioneSubscription Sottoscrizione in usoYour subscription Selezionare la sottoscrizione di Azure da usare per l'account Azure Cosmos DB.Select Azure subscription that you want to use for this Azure Cosmos DB account.
    Gruppo di risorseResource Group Creare un nuovo gruppo di risorseCreate new

    Immettere quindi lo stesso nome univoco specificato sopra in IDThen enter the same unique name as provided above in ID
    Selezionare Crea nuovo, quindi immettere il nome di un nuovo gruppo di risorse per l'account.Select Create New, then enter a new resource-group name for your account. Per semplicità si può usare lo stesso nome usato come ID.For simplicity, you can use the same name as your ID.
    PercorsoLocation Selezionare l'area più vicina agli utentiSelect the region closest to your users Selezionare la posizione geografica in cui ospitare l'account Azure Cosmos DB.Select geographic location in which to host your Azure Cosmos DB account. Usare la località più vicina agli utenti per offrire loro la massima velocità di accesso ai dati.Use the location that's closest to your users to give them the fastest access to the data.
    Abilita ridondanza geograficaEnable geo-redundancy Lasciare vuotoLeave blank Consente di creare una versione replicata del database in una seconda area abbinata.This creates a replicated version of your database in a second (paired) region. Lasciare vuoto.Leave this blank.
    Aggiungi al dashboardPin to dashboard SelezionareSelect Selezionare questa casella per aggiungere il nuovo account di database al dashboard del portale e accedervi più facilmente.Select this box so that your new database account is added to your portal dashboard for easy access.

    Fare quindi clic su Crea.Then click Create.

    Pannello Nuovo account per Azure Cosmos DB

  4. La creazione dell'account richiede alcuni minuti,The account creation takes a few minutes. Durante la creazione dell'account il portale visualizza il riquadro Deploying Azure Cosmos DB (Distribuzione di Azure Cosmos DB) a destra, quindi potrebbe essere necessario scorrere a destra del dashboard per visualizzare il riquadro.During account creation the portal displays the Deploying Azure Cosmos DB tile on the right side, you may need to scroll right on your dashboard to see the tile. È presente anche un indicatore di stato nella parte superiore della schermata.There is also a progress bar displayed near the top of the screen. È possibile esaminare lo stato di avanzamento nelle due aree.You can watch either area for progress.

    Riquadro Notifiche del portale di Azure

    Al termine della creazione dell'account verrà visualizzata la pagina L'account Azure Cosmos DB è stato creato.Once the account is created, the Congratulations! Your Azure Cosmos DB account was created page is displayed.

Aggiungere una raccoltaAdd a collection

È ora possibile usare lo strumento Esplora dati nel portale di Azure per creare un database e una raccolta.You can now use the Data Explorer tool in the Azure portal to create a database and collection.

  1. Fare clic su Esplora dati > Nuova raccolta.Click Data Explorer > New Collection.

    A destra verrà visualizzata l'area Aggiungi raccolta. Per vederla potrebbe essere necessario scorrere verso destra.The Add Collection area is displayed on the far right, you may need to scroll right to see it.

    Esplora dati nel portale di Azure: pannello Aggiungi raccolta

  2. Nella pagina Aggiungi raccolta immettere le impostazioni per la nuova raccolta.In the Add collection page, enter the settings for the new collection.

    ImpostazioneSetting Valore consigliatoSuggested value DescrizioneDescription
    ID databaseDatabase id AttivitàTasks Immettere Tasks come nome del nuovo database.Enter Tasks as the name for the new database. I nomi dei database devono avere una lunghezza compresa tra 1 e 255 caratteri e non possono contenere /, \, #, ? o spazi finali.Database names must contain from 1 through 255 characters, and they cannot contain /, \, #, ?, or a trailing space.
    ID raccoltaCollection id ItemsItems Immettere Items come nome della nuova raccolta.Enter Items as the name for your new collection. Gli ID delle raccolte prevedono gli stessi requisiti relativi ai caratteri dei nomi di database.Collection ids have the same character requirements as database names.
    Capacità di archiviazioneStorage capacity Fissa (10 GB)Fixed (10 GB) Modificare il valore in Fissa (10 GB).Change the value to Fixed (10 GB). Questo valore indica la capacità di archiviazione del database.This value is the storage capacity of the database.
    Velocità effettivaThroughput 400 UR400 RU Modificare la velocità effettiva in 400 unità richiesta al secondo (UR/sec).Change the throughput to 400 request units per second (RU/s). La capacità di archiviazione deve essere impostata su Fisso (10 GB) per impostare la velocità effettiva su 400 UR/sec.Storage capacity must be set to Fixed (10 GB) in order to set throughput to 400 RU/s. Se si vuole ridurre la latenza, è possibile aumentare la velocità effettiva in un secondo momento.If you want to reduce latency, you can scale up the throughput later.
    Chiave di partizionePartition key /category/category Immettere /category come chiave di partizione.Enter /category as the partition key. Una chiave di partizione che distribuisce i dati in modo uniforme a ogni partizione del database.A partition key distributes data evenly to each partition in the database. Per altre informazioni sul partizionamento, vedere Progettazione per il partizionamento.To learn more about partitioning, see Designing for partitioning.

    Fare clic su OK.Click OK.

    In Esplora dati verranno visualizzati il nuovo database e la nuova raccolta.Data Explorer displays the new database and collection.

    Esplora dati nel portale di Azure, con il nuovo database e la nuova raccolta

Aggiungere dati di esempioAdd sample data

È ora possibile aggiungere dati alla nuova raccolta usando Esplora dati.You can now add data to your new collection using Data Explorer.

  1. In Esplora dati il nuovo database viene visualizzato nel riquadro Raccolte.In Data Explorer, the new database appears in the Collections pane. Espandere il database Tasks, espandere la raccolta Items, fare clic su Documenti e quindi su Nuovo documento.Expand the Tasks database, expand the Items collection, click Documents, and then click New Documents.

    Creare nuovi documenti in Esplora dati nel portale di Azure

  2. Aggiungere ora un documento alla raccolta con la struttura seguente.Now add a document to the collection with the following structure.

    {
        "id": "1",
        "category": "personal",
        "name": "groceries",
        "description": "Pick up apples and strawberries.",
        "isComplete": false
    }
    
  3. Dopo avere aggiunto il codice JSON alla scheda Documenti, fare clic su Salva.Once you've added the json to the Documents tab, click Save.

    Copiare i dati JSON e fare clic su Salva in Esplora dati nel portale di Azure

  4. Creare e salvare un altro documento inserendo un valore univoco per la proprietà id e modificando le altre proprietà come si preferisce.Create and save one more document where you insert a unique value for the id property, and change the other properties as you see fit. I nuovi documenti possono avere la struttura desiderata, perché Azure Cosmos DB non impone alcuno schema per i dati.Your new documents can have any structure you want as Azure Cosmos DB doesn't impose any schema on your data.

    È ora possibile usare query in Esplora dati per recuperare i dati.You can now use queries in Data Explorer to retrieve your data. Per impostazione predefinita, Esplora dati usa SELECT * FROM c per recuperare tutti i documenti della raccolta, ma è possibile usare una query SQL diversa, ad esempio SELECT * FROM c ORDER BY c._ts DESC, per restituire tutti i documenti in ordine decrescente in base al timestamp.By default, Data Explorer uses SELECT * FROM c to retrieve all documents in the collection, but you can change that to a different SQL query, such as SELECT * FROM c ORDER BY c._ts DESC, to return all the documents in descending order based on their timestamp.

    È anche possibile usare Esplora dati per creare stored procedure, funzioni definite dall'utente e trigger per eseguire la logica di business sul lato server e aumentare la velocità effettiva.You can also use Data Explorer to create stored procedures, UDFs, and triggers to perform server-side business logic as well as scale throughput. Esplora dati espone tutti i tipi di accesso ai dati a livello di codice predefiniti disponibili nelle API, ma consente anche di accedere facilmente ai dati nel portale di Azure.Data Explorer exposes all of the built-in programmatic data access available in the APIs, but provides easy access to your data in the Azure portal.

Clonare l'applicazione di esempioClone the sample application

Si può ora passare a usare il codice.Now let's switch to working with code. Si clonerà un'app per le API DocumentDB da GitHub, si imposterà la stringa di connessione e si eseguirà l'app.Let's clone a DocumentDB API app from GitHub, set the connection string, and run it. Come si noterà, è facile usare i dati a livello di codice.You'll see how easy it is to work with data programmatically.

  1. Aprire una finestra del terminale Git, ad esempio Git Bash, ed eseguire il comando CD per passare a una directory di lavoro.Open a git terminal window, such as git bash, and CD to a working directory.

  2. Eseguire il comando seguente per clonare l'archivio di esempio.Run the following command to clone the sample repository.

    git clone https://github.com/Azure-Samples/documentdb-dotnet-todo-app.git
    
  3. Aprire quindi il file della soluzione todo in Visual Studio.Then open the todo solution file in Visual Studio.

Esaminare il codiceReview the code

Ecco una breve analisi di ciò che accade nell'app.Let's make a quick review of what's happening in the app. Aprire il file DocumentDBRepository.cs. Come si noterà, queste righe di codice creano le risorse di Azure Cosmos DB.Open the DocumentDBRepository.cs file and you'll find that these lines of code create the Azure Cosmos DB resources.

  • Viene inizializzato DocumentClient alla riga 78.The DocumentClient is initialized on line 78.

    client = new DocumentClient(new Uri(ConfigurationManager.AppSettings["endpoint"]), ConfigurationManager.AppSettings["authKey"]);
    
  • Viene creato un nuovo database alla riga 93.A new database is created on line 93.

    await client.CreateDatabaseAsync(new Database { Id = DatabaseId });
    
  • Viene creata una nuova raccolta alla riga 112.A new collection is created on line 112.

    await client.CreateDocumentCollectionAsync(
        UriFactory.CreateDatabaseUri(DatabaseId),
        new DocumentCollection { Id = CollectionId },
        new DocumentCollection
            {
               Id = CollectionId,
               PartitionKey = new PartitionKeyDefinition() { Paths = new Collection<string>() { "/category" } }
            },
        new RequestOptions { OfferThroughput = 1000 });
    

Aggiornare la stringa di connessioneUpdate your connection string

Tornare ora al portale di Azure per recuperare le informazioni sulla stringa di connessione e copiarle nell'app.Now go back to the Azure portal to get your connection string information and copy it into the app.

  1. Nell'account Azure Cosmos DB nel portale di Azure fare clic su Chiavi nel riquadro di spostamento a sinistra e quindi su Chiavi di lettura/scrittura.In the Azure portal, in your Azure Cosmos DB account, in the left navigation click Keys, and then click Read-write Keys. Usare i pulsanti di copia sul lato destro dello schermo per copiare l'URI e la chiave primaria nel file web.config nel passaggio seguente.You'll use the copy buttons on the right side of the screen to copy the URI and Primary Key into the web.config file in the next step.

    Visualizzazione e copia di una chiave di accesso nel portale di Azure, pannello Chiavi

  2. In Visual Studio 2017 aprire il file web.config.In Visual Studio 2017, open the web.config file.

  3. Copiare il valore di URI dal portale (usando il pulsante di copia) e impostarlo come valore della chiave di endpoint in web.config.Copy your URI value from the portal (using the copy button) and make it the value of the endpoint key in web.config.

    <add key="endpoint" value="FILLME" />

  4. Copiare quindi il valore di CHIAVE PRIMARIA dal portale e impostarlo come valore di authKey in web.config. L'app è stata aggiornata con tutte le informazioni necessarie per comunicare con Azure Cosmos DB.Then copy your PRIMARY KEY value from the portal and make it the value of the authKey in web.config. You've now updated your app with all the info it needs to communicate with Azure Cosmos DB.

    <add key="authKey" value="FILLME" />

Eseguire l'app WebRun the web app

  1. In Visual Studio fare clic con il pulsante destro del mouse sul progetto in Esplora soluzioni e quindi scegliere Gestisci pacchetti NuGet.In Visual Studio, right-click on the project in Solution Explorer and then click Manage NuGet Packages.

  2. Nella casella Sfoglia di NuGet digitare DocumentDB.In the NuGet Browse box, type DocumentDB.

  3. Dai risultati installare la libreria Microsoft.Azure.DocumentDB.From the results, install the Microsoft.Azure.DocumentDB library. Viene installato il pacchetto Microsoft.Azure.DocumentDB, insieme a tutte le dipendenze.This installs the Microsoft.Azure.DocumentDB package as well as all dependencies.

  4. Premere CTRL+F5 per eseguire l'applicazione.Click CTRL + F5 to run the application. L'app viene visualizzata nel browser.Your app displays in your browser.

  5. Fare clic su Crea nuovo nel browser e creare alcune nuove attività nell'app elenco attività.Click Create New in the browser and create a few new tasks in your to-do app.

    App elenco attività con dati di esempio

È ora possibile tornare a Esplora dati e visualizzare, modificare e usare questi nuovi dati, nonché eseguire query su di essi.You can now go back to Data Explorer and see query, modify, and work with this new data.

Esaminare i contratti di servizio nel portale di AzureReview SLAs in the Azure portal

La velocità effettiva, lo spazio di archiviazione, la disponibilità, la latenza e la coerenza delle risorse nell'account vengono monitorati nel portale di Azure.The throughput, storage, availability, latency, and consistency of the resources in your account are monitored in the Azure portal. Di seguito vengono illustrate brevemente queste metriche.Let's take a quick look at these metrics.

  1. Fare clic su Metriche nel menu di spostamento.Click Metrics in the navigation menu.

    Metriche nel portale di Azure

  2. Fare clic su ogni scheda per conoscere le metriche offerte da Azure Cosmos DB.Click through each of the tabs so you're aware of the metrics Azure Cosmos DB provides.

    Ogni grafico associato ai contratti di servizio per Azure Cosmos DB contiene una linea che indica le eventuali violazioni dei contratti di servizio.Each chart that's associated with the Azure Cosmos DB Service Level Agreements (SLAs) provides a line that shows if any of the SLAs have been violated. Con questo gruppo di metriche, Azure Cosmos DB garantisce trasparenza nel monitoraggio dei contratti di servizio.Azure Cosmos DB makes monitoring your SLAs transparent with this suite of metrics.

    Gruppo di metriche di Azure Cosmos DB

Pulire le risorseClean up resources

Se non si intende continuare a usare l'app, eliminare tutte le risorse create tramite questa guida di avvio rapido nel portale di Azure eseguendo questi passaggi:If you're not going to continue to use this app, delete all resources created by this quickstart in the Azure portal with the following steps:

  1. Scegliere Gruppi di risorse dal menu a sinistra del portale di Azure e quindi fare clic sul nome della risorsa creata.From the left-hand menu in the Azure portal, click Resource groups and then click the name of the resource you created.
  2. Nella pagina del gruppo di risorse fare clic su Elimina, digitare il nome della risorsa da eliminare nella casella di testo e quindi fare clic su Elimina.On your resource group page, click Delete, type the name of the resource to delete in the text box, and then click Delete.

Passaggi successiviNext steps

In questa guida di avvio rapido si è appreso come creare un account Azure Cosmos DB, come creare una raccolta con Esplora dati e come eseguire un'app Web.In this quickstart, you've learned how to create an Azure Cosmos DB account, create a collection using the Data Explorer, and run a web app. È ora possibile importare dati aggiuntivi nell'account Cosmos DB.You can now import additional data to your Cosmos DB account.