分享方式：

開始使用 Azure Cosmos DB for Table 搭配 .NET

  • 文章

適用於： 桌子

本文說明如何透過 .NET SDK 與 Azure Cosmos DB for Table 連線。 連線之後，您即可在表格和項目上執行作業。

封裝 (NuGet) | 範例 | API 參考 | 程式庫原始程式碼 | 提供意見反應 |

必要條件

設定您的專案

使用 dotnet new 命令搭配主控台範本來建立新的 .NET 應用程式。

dotnet new console

使用 命令匯入 Azure.Data.Tablesdotnet add package NuGet 套件。

dotnet add package Azure.Data.Tables

使用 dotnet build 命令建立專案。

dotnet build

連線至 Azure Cosmos DB for Table

若要連線到 Azure Cosmos DB 的 API for Table，請建立 TableServiceClient 類別的執行個體。 此類別是針對表格執行所有作業的起點。

若要使用 Microsoft Entra 連線到 NoSQL 帳戶的 API，請使用安全性主體。 主體的確切類型取決於您裝載應用程式程式碼的位置。 下表可作為快速參考指南。

應用程式的執行位置 安全性主體
本機電腦 (開發和測試) 使用者身分識別或服務主體
Azure 受控識別
Azure 外部的伺服器或用戶端 服務主體

匯入 Azure.Identity

Azure.Identity NuGet 套件包含所有 Azure SDK 程式庫之間共用的核心驗證功能。

使用 命令匯入 Azure.Identitydotnet add package NuGet 套件。

dotnet add package Azure.Identity

使用 dotnet build 命令重新建立專案。

dotnet build

在您的程式碼編輯器中，針對 Azure.Core 和 Azure.Identity 命名空間使用指示詞。

using Azure.Core;
using Azure.Identity;

使用預設認證實作建立 CosmosClient

如果您要在本機電腦上進行測試，或應用程式將在 Azure 服務上執行，並直接支援受控識別，請建立 DefaultAzureCredential 執行個體以取得 OAuth 權杖。

在此範例中，我們會將執行個體儲存在 TokenCredential 類型的變數中，因為此項目在 SDK 間是更為常見且重複使用的類型。

// Credential class for testing on a local machine or Azure services
TokenCredential credential = new DefaultAzureCredential();

使用 COSMOS_ENDPOINT 環境變數和 TokenCredential 物件作為參數，建立 CosmosClient 類別的新執行個體。

// New instance of TableServiceClient class using Microsoft Entra
TableServiceClient client = new(
    endpoint: Environment.GetEnvironmentVariable("COSMOS_ENDPOINT")!,
    tokenCredential: credential
);

建置您的 應用程式

組建應用程式時，程式碼主要與四種資源互動：

  • API for Table 帳戶是 Azure Cosmos DB 資料的唯一最上層命名空間。

  • 表格，其中包含帳戶中的一組個別項目。

  • 項目，代表表格中的個別項目。

下圖顯示資源之間的關係。

Azure Cosmos DB 階層的圖表，包括帳戶、數據表和專案。

每種資源以一或多個相關聯的 .NET 類別或介面來表示。 以下是最常見類型的清單：

類別 描述
TableServiceClient 此用戶端類別提供適用於 Azure Cosmos DB 服務的用戶端邏輯表示法。 用戶端物件會用於設定及執行針對服務的要求。
TableClient 此用戶端類別是服務中可能存在或不存在的表格參考。 當您嘗試存取資料庫或對其執行作業時，表格為已驗證的伺服器端。
ITableEntity 此介面是表格中已建立或從表格中查詢的項目基底介面。 此介面包含 API for Table 中項目的所有必要屬性。
TableEntity 這個類別是 ITableEntity 介面的通用實作，做為機碼值組的字典。

下列指南說明如何以上每個類別來組建應用程式。

指南 描述
建立資料表 建立表格
建立項目 建立項目
讀取項目 讀取項目

另請參閱

下一步

既然您已連線到 API for Table 帳戶，請使用下一份指南來建立和管理資料表。

使用 .NET 在 Azure Cosmos DB for Table 中建立資料表