Přidání služby Azure Cosmos DB do aplikace pomocí sady Visual Studio Připojení ed Services

Pomocí sady Visual Studio můžete ke službě Azure Cosmos DB připojit libovolnou z následujících možností pomocí funkce Připojení ed Services:

  • Konzolová aplikace .NET Framework
  • ASP.NET Model-View-Controller (MVC) (.NET Framework)
  • ASP.NET Core
  • .NET Core (včetně konzolové aplikace, WPF, model Windows Forms, knihovny tříd)
  • Role pracovního procesu .NET Core
  • Azure Functions
  • aplikace Univerzální platforma Windows
  • Xamarin
  • Cordova

Funkce připojené služby přidá do projektu všechny potřebné odkazy a kód připojení a odpovídajícím způsobem upraví konfigurační soubory.

Poznámka:

Toto téma se týká sady Visual Studio ve Windows. Visual Studio pro Mac najdete v tématu Připojení služby v Visual Studio pro Mac.

Požadavky

Připojení do služby Azure Cosmos DB pomocí Připojení ed Services

  1. Otevřete projekt v sadě Visual Studio.

  2. V Průzkumník řešení klikněte pravým tlačítkem na uzel Připojení ed Services a v místní nabídce vyberte Přidat Připojení ed Service.

  3. Na kartě Připojení ed Služby vyberte ikonu + pro závislosti služeb.

    Screenshot showing how to add a service dependency.

  4. Na stránce Přidat závislost vyberte Azure Cosmos DB.

    Screenshot showing

    Pokud ještě nejste přihlášení, přihlaste se ke svému účtu Azure. Pokud účet Azure nemáte, můžete si zaregistrovat bezplatnou zkušební verzi.

  5. Na obrazovce Azure Cosmos DB vyberte existující službu Azure Cosmos DB a vyberte Další.

    Pokud potřebujete vytvořit databázi, přejděte k dalšímu kroku. Jinak přejděte ke kroku 7.

    Screenshot showing how to add an existing Azure Cosmos DB to project.

  6. Vytvoření služby Azure Cosmos DB:

    1. V dolní části obrazovky vyberte Vytvořit novou službu Azure Cosmos DB .

    2. Vyplňte azure Cosmos DB: Vytvořte novou obrazovku a vyberte Vytvořit.

      Screenshot showing

    3. Po zobrazení dialogového okna Konfigurace služby Azure Cosmos DB se nová databáze zobrazí v seznamu. Vyberte novou databázi v seznamu a vyberte Další.

  7. Zadejte název připojovací řetězec a zvolte, jestli chcete připojovací řetězec uložit v místním souboru tajných kódů nebo ve službě Azure Key Vault.

    Screenshot showing

  8. Na obrazovce Souhrn změn se zobrazí všechny změny, které budou provedeny v projektu, pokud proces dokončíte. Pokud změny vypadají v pořádku, zvolte Dokončit.

    Screenshot showing

  9. Připojení se zobrazí v části Závislosti služby na kartě Připojení ed Služby.

    Screenshot showing

Poznámka:

U projektů rozhraní .NET Framework se uživatelské rozhraní služeb Připojení mírně liší. Pokud chcete zobrazit rozdíly, porovnejte verzi sady Visual Studio 2019 této stránky.

  1. Otevřete projekt v sadě Visual Studio.

  2. V Průzkumník řešení klikněte pravým tlačítkem na uzel Připojení ed Services a v místní nabídce vyberte Přidat a otevřete nabídku dostupných služeb.

    Screenshot showing Connected Services context menu options.

  3. Zvolte Azure Cosmos DB. Zobrazí se stránka Připojení k závislostem. Měli byste vidět dvě možnosti, jednu pro místní emulátor, emulátor služby Azure Cosmos DB v kontejneru (místní) a jednu pro připojení k živé službě Azure Cosmos DB. Počáteční vývoj můžete snížit a zjednodušit tím, že začnete s místním emulátorem. Později můžete migrovat do živé služby opakováním těchto kroků a zvolením jiné možnosti.

    Screenshot showing Azure Cosmos DB choices.

    Pokud se rozhodnete použít emulátor služby Azure Cosmos DB, kliknutím na tlačítko Další zobrazíte obrazovku Souhrn změn , která ukazuje, jak se projekt upravuje. Do projektu se přidá odkaz na balíček NuGet a do projektu se přidá kód připojení místního emulátoru. Jakmile kliknete na Dokončit na poslední obrazovce, kontejner emulátoru se vytvoří. V okně výstupu se zobrazí stav stahování image.

    Pokud se chcete připojit ke službě Azure, pokračujte dalším krokem nebo pokud ještě nejste přihlášení, před pokračováním se přihlaste ke svému účtu Azure. Pokud účet Azure nemáte, můžete si zaregistrovat bezplatnou zkušební verzi.

  4. Na obrazovce Azure Cosmos DB vyberte existující službu Azure Cosmos DB a vyberte Další.

    Pokud potřebujete vytvořit databázi, přejděte k dalšímu kroku. Jinak přejděte ke kroku 7.

    Screenshot showing

  5. Vytvoření služby Azure Cosmos DB:

    1. V dolní části obrazovky vyberte Vytvořit novou službu Azure Cosmos DB .

    2. Vyplňte azure Cosmos DB: Vytvořte novou obrazovku a vyberte Vytvořit.

      Screenshot showing

    3. Po zobrazení dialogového okna Konfigurace služby Azure Cosmos DB se nová databáze zobrazí v seznamu. Vyberte novou databázi v seznamu a vyberte Další.

  6. Zadejte název připojovací řetězec a zvolte, jestli chcete připojovací řetězec uložit v místním souboru tajných kódů nebo ve službě Azure Key Vault.

    Screenshot showing

    Připojovací řetězec se přidá jako tajný kód a zpřístupní se v konfiguraci aplikace. V aplikacích ASP.NET Core můžete k tomuto připojovací řetězec přistupovat pomocí Configuration vlastnosti objektuWebApplicationBuild.

  7. Na obrazovce Souhrn změn se zobrazí všechny změny, které budou provedeny v projektu, pokud proces dokončíte. Pokud změny vypadají v pořádku, zvolte Dokončit.

    Screenshot showing

  8. V Průzkumník řešení poklikejte na uzel Připojení služby a otevřete kartu Připojení ed Služby. Připojení se zobrazí v části Závislosti služby:

    Screenshot showing

    Pokud kliknete na tři tečky vedle přidané závislosti, zobrazí se různé možnosti, jako je například Připojení znovu otevřít průvodce a změnit připojení. Můžete také kliknout na tři tečky v pravém horním rohu okna a zobrazit možnosti spuštění místních závislostí, změnit nastavení a další.

  9. Ve výchozím nastavení je limit paměti v kontejneru nastavený na 2G, ale obvykle se ke spuštění služby Azure Cosmos DB vyžaduje více paměti. Pokud chcete tento problém vyřešit, přejděte do .vs/sd/<GUID>/local složky ve složce řešení. V Průzkumníku Windows možná budete muset povolit skryté soubory, aby se složka zobrazila .vs . Najděte a otevřete soubor cosmosdb1.docker-compose.yml. Nastavte limit paměti 4G nebo vyšší.

    mem_limit = 4G
    

    Chcete-li restartovat kontejner s novým nastavením, v části Závislosti služby na kartě Připojení ed Služby klikněte na tři tečky a zvolte Spustit místní závislosti.

Poznámka:

Místní emulátor služby Azure Cosmos DB může odkazovat na základní image, která používá dočasnou licenci pro službu Azure Cosmos DB. Pokud se kontejner nespustí, zkontrolujte kartu Protokoly v okně Kontejnery* pro kontejner Azure Cosmos DB. Pokud se jedná o problém s vypršením platnosti pal, musíte získat nejnovější základní image místního kontejneru. Z příkazového řádku konzoly spusťte následující příkaz: docker pull mcr.microsoft.com/cosmosdb/linux/azure-cosmos-emulator:latest. Licence se pravidelně aktualizuje a po vypršení platnosti by se měl problém vyřešit aktualizací nejnovějšího kontejneru. Problémy s emulátorem služby Azure Cosmos DB můžete zobrazit a nahlásit v úložišti GitHub emulátoru služby Azure Cosmos DB.

Další kroky

Zjistěte, jak bezpečně ukládat tajné kódy podle Sejf úložiště tajných kódů aplikací ve vývoji v ASP.NET Core. Konkrétně ke čtení připojovací řetězec z úložiště tajných kódů můžete přidat kód jako v části Čtení tajného kódu prostřednictvím konfiguračního rozhraní API. Kód může vypadat takto, kde builder je instance WebApplicationBuild , která se zobrazí v Program.cs v šablonách projektu ASP.NET Core:

// New instance of CosmosClient class using a connection string
using CosmosClient client = new(
    connectionString: builder.Configuration["CosmosDBConnectionString"]
);

Poskytuje CosmosClient přístup k funkcím služby Azure Cosmos DB prostřednictvím různých metod. Jakmile máte instanci CosmosClient, můžete databázi NoSQL vytvořit pomocí této příručky: Vytvořte databázi ve službě Azure Cosmos DB for NoSQL pomocí .NET.