Dela via


Kom igång med Azure Cosmos DB for Table med hjälp av .NET

GÄLLER FÖR: Bord

Den här artikeln visar hur du ansluter till Azure Cosmos DB for Table med hjälp av .NET SDK. När du är ansluten kan du utföra åtgärder på tabeller och objekt.

Package (NuGet)Samples API reference Library source code Give Feedback (Paket (NuGet) | Samples | API reference | Library source code | Give Feedback |

Förutsättningar

Konfigurera projektet

Skapa ett nytt .NET-program med hjälp dotnet new av kommandot med konsolmallen.

dotnet new console

Importera NuGet-paketet Azure.Data.Tables med kommandot dotnet add package .

dotnet add package Azure.Data.Tables

Skapa projektet med dotnet build kommandot .

dotnet build

Ansluta till Azure Cosmos DB för table

Om du vill ansluta till API:et för Tabell i Azure Cosmos DB skapar du en instans av TableServiceClient klassen. Den här klassen är startpunkten för att utföra alla åtgärder mot tabeller.

Om du vill ansluta till ditt API för NoSQL-konto med Hjälp av Microsoft Entra använder du ett säkerhetsobjekt. Den exakta typen av huvudnamn beror på var du är värd för programkoden. Tabellen nedan fungerar som en snabbreferensguide.

Där programmet körs Säkerhetsobjekt
Lokal dator (utveckla och testa) Användaridentitet eller tjänstens huvudnamn
Azure Hanterad identitet
Servrar eller klienter utanför Azure Tjänstens huvudnamn

Importera Azure.Identity

NuGet-paketet Azure.Identity innehåller grundläggande autentiseringsfunktioner som delas mellan alla Azure SDK-bibliotek.

Importera Azure.Identity NuGet-paketet med kommandot dotnet add package .

dotnet add package Azure.Identity

Återskapa projektet med dotnet build kommandot .

dotnet build

I kodredigeraren lägger du till med hjälp av direktiv för Azure.Core och Azure.Identity namnområden.

using Azure.Core;
using Azure.Identity;

Skapa CosmosClient med standardimplementering av autentiseringsuppgifter

Om du testar på en lokal dator, eller om programmet körs på Azure-tjänster med direkt stöd för hanterade identiteter, hämtar du en OAuth-token genom att skapa en DefaultAzureCredential instans.

I det här exemplet sparade vi instansen i en variabel av typen TokenCredential eftersom det är en mer allmän typ som kan återanvändas mellan SDK:er.

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

Skapa en ny instans av klassen CosmosClient med COSMOS_ENDPOINT miljövariabeln och TokenCredential-objektet som parametrar.

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

Skapa ditt program

När du skapar ditt program interagerar koden främst med fyra typer av resurser:

  • API:et för tabellkontot, som är det unika toppnivånamnområdet för dina Azure Cosmos DB-data.

  • Tabeller, som innehåller en uppsättning enskilda objekt i ditt konto.

  • Objekt som representerar ett enskilt objekt i tabellen.

Följande diagram visar relationen mellan de här resurserna.

Diagram över Azure Cosmos DB-hierarkin, inklusive konton, tabeller och objekt.

Hierarkiskt diagram som visar ett Azure Cosmos DB-konto högst upp. Kontot har två underordnade tabellnoder. En av tabellnoderna innehåller två underordnade objekt.

Varje typ av resurs representeras av en eller flera associerade .NET-klasser eller gränssnitt. Här är en lista över de vanligaste typerna:

Klass beskrivning
TableServiceClient Den här klientklassen tillhandahåller en logisk representation på klientsidan för Azure Cosmos DB-tjänsten. Klientobjektet används för att konfigurera och köra begäranden mot tjänsten.
TableClient Den här klientklassen är en referens till en tabell som kanske, eller kanske inte finns i tjänsten ännu. Tabellen verifieras på serversidan när du försöker komma åt den eller utföra en åtgärd mot den.
ITableEntity Det här gränssnittet är basgränssnittet för alla objekt som skapas i tabellen eller som efterfrågas från tabellen. Det här gränssnittet innehåller alla nödvändiga egenskaper för objekt i API:et för tabell.
TableEntity Den här klassen är en allmän implementering av ITableEntity gränssnittet som en ordlista med nyckel/värde-par.

Följande guider visar hur du använder var och en av dessa klasser för att skapa ditt program.

Guide beskrivning
Skapa en tabell Skapa tabeller
Skapa ett objekt Skapa objekt
Läsa ett objekt Läsa objekt

Se även

Nästa steg

Nu när du har anslutit till ett API för tabellkonto använder du nästa guide för att skapa och hantera tabeller.