Merge pull request #265747 from alexwolfmsft/cosmos-table-dotnet-quickstart

v-ccolin · web-flow · commit e2095dda35da · 2024-03-07T08:30:49.000Z
Update Cosmos Table quickstart for .NET to use azd and codespaces
diff --git a/articles/cosmos-db/includes/cosmos-db-create-tableapi-account.md b/articles/cosmos-db/includes/cosmos-db-create-tableapi-account.md
@@ -9,4 +9,5 @@ ms.date: 04/06/2018
 ms.author: mimig
 ms.custom: include file
 ---
-For instructions on creating an Azure Cosmos DB for Table account, see [Create a database account](../table/quickstart-dotnet.md#create-an-azure-cosmos-db-account).
+
+For instructions on creating an Azure Cosmos DB for Table account, see [Create a database account](../how-to-manage-database-account.md).
diff --git a/articles/cosmos-db/table/how-to-create-container.md b/articles/cosmos-db/table/how-to-create-container.md
@@ -19,13 +19,13 @@ This article explains the different ways to create a container in Azure Cosmos D
 This article explains the different ways to create a container in Azure Cosmos DB for Table. If you are using a different API, see [API for MongoDB](../mongodb/how-to-create-container.md), [API for Cassandra](../cassandra/how-to-create-container.md), [API for Gremlin](../gremlin/how-to-create-container.md), and [API for NoSQL](../how-to-create-container.md) articles to create the container.
 
 > [!NOTE]
-> When creating containers, make sure you don’t create two containers with the same name but different casing. That’s because some parts of the Azure platform are not case-sensitive, and this can result in confusion/collision of telemetry and actions on containers with such names.
+> When creating containers, make sure you don't create two containers with the same name but different casing. That's because some parts of the Azure platform are not case-sensitive, and this can result in confusion/collision of telemetry and actions on containers with such names.
 
 ## <a id="portal-table"></a>Create using Azure portal
 
 1. Sign in to the [Azure portal](https://portal.azure.com/).
 
-1. [Create a new Azure Cosmos DB account](quickstart-dotnet.md#create-an-azure-cosmos-db-account), or select an existing account.
+1. [Create a new Azure Cosmos DB account](../how-to-manage-database-account.md), or select an existing account.
 
 1. Open the **Data Explorer** pane, and select **New Table**. Next, provide the following details:
 
diff --git a/articles/cosmos-db/table/includes/dev-prereqs.md b/articles/cosmos-db/table/includes/dev-prereqs.md
@@ -0,0 +1,25 @@
+---
+author: seesharprun
+ms.author: sidandrews
+ms.service: cosmos-db
+ms.subservice: nosql
+ms.topic: include
+ms.date: 01/08/2024
+ms.custom: include file
+zone_pivot_groups: azure-cosmos-db-quickstart-env
+---
+
+::: zone pivot="devcontainer-codespace"
+
+- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
+- [GitHub account](https://docs.github.com//get-started/quickstart/creating-an-account-on-github)
+
+::: zone-end
+
+::: zone pivot="devcontainer-vscode"
+
+- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
+- [Azure Developer CLI](/azure/developer/azure-developer-cli/install-azd)
+- [Docker Desktop](https://www.docker.com/products/docker-desktop/)
+
+::: zone-end
diff --git a/articles/cosmos-db/table/includes/dev-setup.md b/articles/cosmos-db/table/includes/dev-setup.md
@@ -0,0 +1,63 @@
+---
+author: seesharprun
+ms.author: sidandrews
+ms.service: cosmos-db
+ms.subservice: nosql
+ms.topic: include
+ms.date: 01/08/2024
+ms.custom: include file
+zone_pivot_groups: azure-cosmos-db-quickstart-env
+---
+
+::: zone pivot="devcontainer-codespace"
+
+> [!IMPORTANT]
+> GitHub accounts include an entitlement of storage and core hours at no cost. For more information, see [included storage and core hours for GitHub accounts](https://docs.github.com/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces#monthly-included-storage-and-core-hours-for-personal-accounts).
+
+::: zone-end
+
+::: zone pivot="devcontainer-vscode"
+
+::: zone-end
+
+1. Open a terminal in the root directory of the project.
+
+1. Authenticate to the Azure Developer CLI using `azd auth login`. Follow the steps specified by the tool to authenticate to the CLI using your preferred Azure credentials.
+
+    ```azurecli
+    azd auth login
+    ```
+
+1. Use `azd init` to initialize the project.
+
+    ```azurecli
+    azd init
+    ```
+
+1. During initialization, configure a unique environment name.
+
+    > [!TIP]
+    > The environment name will also be used as the target resource group name. For this quickstart, consider using `msdocs-cosmos-db`.
+
+1. Deploy the Azure Cosmos DB account using `azd up`. The Bicep templates also deploy a sample web application.
+
+    ```azurecli
+    azd up
+    ```
+
+1. During the provisioning process, select your subscription and desired location. Wait for the provisioning process to complete. The process can take **approximately five minutes**.
+
+1. Once the provisioning of your Azure resources is done, a URL to the running web application is included in the output.
+
+    ```output
+    Deploying services (azd deploy)
+    
+      (✓) Done: Deploying service web
+    - Endpoint: <https://[container-app-sub-domain].azurecontainerapps.io>
+    
+    SUCCESS: Your application was provisioned and deployed to Azure in 5 minutes 0 seconds.
+    ```
+
+1. Use the URL in the console to navigate to your web application in the browser. Observe the output of the running app.
+
+    :::image type="content" source="../media/cosmos-table-app.png" alt-text="Screenshot of the running web application.":::
diff --git a/articles/cosmos-db/table/media/cosmos-table-app.png b/articles/cosmos-db/table/media/cosmos-table-app.png
diff --git a/articles/cosmos-db/table/quickstart-dotnet.md b/articles/cosmos-db/table/quickstart-dotnet.md
@@ -8,7 +8,8 @@ ms.subservice: table
 ms.devlang: csharp
 ms.topic: quickstart
 ms.date: 08/22/2022
-ms.custom: devx-track-csharp, devguide-csharp, cosmos-db-dev-journey, devx-track-azurecli, devx-track-dotnet
+ms.custom: devx-track-csharp, ignite-2022, devguide-csharp, cosmos-db-dev-journey, devx-track-azurecli, devx-track-dotnet, devx-track-extended-azdevcli
+zone_pivot_groups: azure-cosmos-db-quickstart-env
 ---
 
 # Quickstart: Azure Cosmos DB for Table for .NET
@@ -23,7 +24,7 @@ ms.custom: devx-track-csharp, devguide-csharp, cosmos-db-dev-journey, devx-track
 > * [Python](quickstart-python.md)
 >
 
-This quickstart shows how to get started with the Azure Cosmos DB for Table from a .NET application. The Azure Cosmos DB for Table is a schemaless data store allowing applications to store structured NoSQL data in the cloud. You'll learn how to create tables, rows, and perform basic tasks within your Azure Cosmos DB resource using the [Azure.Data.Tables Package (NuGet)](https://www.nuget.org/packages/Azure.Data.Tables/).
+This quickstart shows how to get started with the Azure Cosmos DB for Table from a .NET application. The Azure Cosmos DB for Table is a schemaless data store allowing applications to store structured table data in the cloud. You'll learn how to create tables, rows, and perform basic tasks within your Azure Cosmos DB resource using the [Azure.Data.Tables Package (NuGet)](https://www.nuget.org/packages/Azure.Data.Tables/).
 
 > [!NOTE]
 > The [example code snippets](https://github.com/Azure-Samples/cosmos-db-table-api-dotnet-samples) are available on GitHub as a .NET project.
@@ -32,72 +33,49 @@ This quickstart shows how to get started with the Azure Cosmos DB for Table from
 
 ## Prerequisites
 
-* An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free).
-* [.NET 6.0](https://dotnet.microsoft.com/download)
-* [Azure Command-Line Interface (CLI)](/cli/azure/) or [Azure PowerShell](/powershell/azure/)
-
-### Prerequisite check
-
-* In a terminal or command window, run ``dotnet --list-sdks`` to check that .NET 6.x is one of the available versions.
-* Run ``az --version`` (Azure CLI) or ``Get-Module -ListAvailable AzureRM`` (Azure PowerShell) to check that you have the appropriate Azure command-line tools installed.
+[!INCLUDE[Developer Quickstart prerequisites](includes/dev-prereqs.md)]
 
 ## Setting up
 
-This section walks you through how to create an Azure Cosmos DB account and set up a project that uses the API for Table NuGet packages.
-
-### Create an Azure Cosmos DB account
-
-This quickstart will create a single Azure Cosmos DB account using the API for Table.
+Deploy this project's development container to your environment. Then, use the Azure Developer CLI (azd) to create an Azure Cosmos DB for Table account and deploy a containerized sample application. The sample application uses the client library to manage, create, read, and query sample data.
 
-#### [Azure CLI](#tab/azure-cli)
+::: zone pivot="devcontainer-codespace"
 
-[!INCLUDE [azure-cli-create-resource-group-and-resource](./includes/quickstart-dotnet/azure-cli-create-resource-group-and-resource.md)]
+[![Open in GitHub Codespaces](https://img.shields.io/static/v1?style=for-the-badge&label=GitHub+Codespaces&message=Open&color=brightgreen&logo=github)](https://codespaces.new/Azure-Samples/cosmos-db-table-dotnet-quickstart?template=false&quickstart=1&azure-portal=true)
 
-#### [PowerShell](#tab/azure-powershell)
+::: zone-end
 
-[!INCLUDE [Powershell - create resource group and resources](./includes/quickstart-dotnet/powershell-create-resource-group-and-resource.md)]
+::: zone pivot="devcontainer-vscode"
 
-#### [Portal](#tab/azure-portal)
+[![Open in Dev Container](https://img.shields.io/static/v1?style=for-the-badge&label=Dev+Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/Azure-Samples/cosmos-db-table-dotnet-quickstart)
 
-[!INCLUDE [Portal - create resource](./includes/quickstart-dotnet/portal-create-resource.md)]
+::: zone-end
 
----
-
-### Get API for Table connection string
+[!INCLUDE[Developer Quickstart setup](includes/dev-setup.md)]
 
-#### [Azure CLI](#tab/azure-cli)
+### Install the client library
 
-[!INCLUDE [Azure CLI - get connection string](./includes/quickstart-dotnet/azure-cli-get-connection-string.md)]
+The client library is available through NuGet, as the `Microsoft.Azure.Cosmos` package.
 
-#### [PowerShell](#tab/azure-powershell)
+1. Open a terminal and navigate to the `/src/web` folder.
 
-[!INCLUDE [Powershell - get connection string](./includes/quickstart-dotnet/powershell-get-connection-string.md)]
+    ```bash
+    cd ./src/web
+    ```
 
-#### [Portal](#tab/azure-portal)
+1. If not already installed, install the `Microsoft.Azure.Cosmos` package using `dotnet add package`.
 
-[!INCLUDE [Portal - get connection string](./includes/quickstart-dotnet/portal-get-connection-string-from-resource.md)]
-
----
+    ```bash
+    dotnet add package Microsoft.Azure.Cosmos
+    ```
 
-### Create a new .NET app
-
-Create a new .NET application in an empty folder using your preferred terminal. Use the [``dotnet new console``](/dotnet/core/tools/dotnet-new) to create a new console app.
-
-```console
-dotnet new console --output <app-name>
-```
-
-### Install the NuGet package
-
-Add the [Azure.Data.Tables](https://www.nuget.org/packages/Azure.Data.Tables) NuGet package to the new .NET project. Use the [``dotnet add package``](/dotnet/core/tools/dotnet-add-package) command specifying the name of the NuGet package.
-
-```console
-dotnet add package Azure.Data.Tables
-```
+1. Also, install the `Azure.Identity` package if not already installed.
 
-### Configure environment variables
+    ```bash
+    dotnet add package Azure.Identity
+    ```
 
-[!INCLUDE [Multi-tab](./includes/quickstart-dotnet/environment-variables-connection-string.md)]
+1. Open and review the **src/web/Cosmos.Samples.Table.Quickstart.Web.csproj** file to validate that the `Microsoft.Azure.Cosmos` and `Azure.Identity` entries both exist.
 
 ## Code examples
 
