Rozpoczynanie pracy z usługą Azure Cosmos DB dla tabel przy użyciu platformy .NET
DOTYCZY: 
Stół
W tym artykule pokazano, jak nawiązać połączenie z usługą Azure Cosmos DB dla tabeli przy użyciu zestawu .NET SDK. Po nawiązaniu połączenia można wykonywać operacje na tabelach i elementach.
Kod źródłowy biblioteki źródłowej interfejsu API package (NuGet)Samples | API Reference | Code | (Dokumentacja interfejsu API pakietu (NuGet) | Prześlij opinię |
Wymagania wstępne
- Konto platformy Azure z aktywną subskrypcją. Utwórz konto bezpłatnie.
- Usługa Azure Cosmos DB dla konta tabeli. Utwórz interfejs API dla konta tabeli.
- .NET 6.0 lub nowszy
- Interfejs wiersza polecenia platformy Azure lub program Azure PowerShell
konfigurowanie projektu
Utwórz nową aplikację .NET przy użyciu dotnet new polecenia z szablonem konsoli .
dotnet new console
Zaimportuj pakiet NuGet Azure.Data.Tables przy użyciu dotnet add package polecenia .
dotnet add package Azure.Data.Tables
Skompiluj projekt za dotnet build pomocą polecenia .
dotnet build
Nawiązywanie połączenia z usługą Azure Cosmos DB dla tabeli
Aby nawiązać połączenie z interfejsem API dla tabeli usługi Azure Cosmos DB, utwórz wystąpienie TableServiceClient klasy . Ta klasa jest punktem wyjścia do wykonania wszystkich operacji względem tabel.
Aby nawiązać połączenie z kontem interfejsu API dla noSQL przy użyciu usługi Microsoft Entra, użyj podmiotu zabezpieczeń. Dokładny typ podmiotu zabezpieczeń będzie zależeć od tego, gdzie hostujesz kod aplikacji. Poniższa tabela służy jako krótki przewodnik informacyjny.
| Gdzie działa aplikacja | Podmiot zabezpieczeń |
|---|---|
| Maszyna lokalna (programowanie i testowanie) | Tożsamość użytkownika lub jednostka usługi |
| Azure | Tożsamość zarządzana |
| Serwery lub klienci spoza platformy Azure | Jednostka usługi |
Importowanie pliku Azure.Identity
Pakiet NuGet Azure.Identity zawiera podstawowe funkcje uwierzytelniania współużytkowane przez wszystkie biblioteki zestawu Azure SDK.
Zaimportuj pakiet NuGet Azure.Identity przy użyciu dotnet add package polecenia .
dotnet add package Azure.Identity
Skompiluj projekt za dotnet build pomocą polecenia .
dotnet build
W edytorze kodu dodaj dyrektywy using dla Azure.Core przestrzeni nazw i Azure.Identity .
using Azure.Core;
using Azure.Identity;
Tworzenie elementu CosmosClient z domyślną implementacją poświadczeń
Jeśli testujesz na komputerze lokalnym lub aplikacja będzie działać w usługach platformy Azure z bezpośrednią obsługą tożsamości zarządzanych, uzyskaj token OAuth, tworząc DefaultAzureCredential wystąpienie.
W tym przykładzie zapisano wystąpienie w zmiennej typu TokenCredential , ponieważ jest to bardziej ogólny typ, który jest wielokrotnego użytku w zestawach SDK.
// Credential class for testing on a local machine or Azure services
TokenCredential credential = new DefaultAzureCredential();
Utwórz nowe wystąpienie klasy CosmosClient ze zmienną COSMOS_ENDPOINT środowiskową i obiektEm TokenCredential jako parametry.
// New instance of TableServiceClient class using Microsoft Entra
TableServiceClient client = new(
endpoint: Environment.GetEnvironmentVariable("COSMOS_ENDPOINT")!,
tokenCredential: credential
);
Kompilowanie aplikacji
Podczas kompilowania aplikacji kod będzie przede wszystkim współdziałać z czterema typami zasobów:
Interfejs API dla konta tabeli, który jest unikatową przestrzenią nazw najwyższego poziomu dla danych usługi Azure Cosmos DB.
Tabele zawierające zestaw pojedynczych elementów na twoim koncie.
Elementy reprezentujące pojedynczy element w tabeli.
Na poniższym diagramie przedstawiono relacje między tymi zasobami.
Diagram hierarchiczny przedstawiający konto usługi Azure Cosmos DB u góry. Konto ma dwa podrzędne węzły tabeli. Jeden z węzłów tabeli zawiera dwa elementy podrzędne.
Każdy typ zasobu jest reprezentowany przez co najmniej jedną skojarzną klasę lub interfejsy platformy .NET. Oto lista najbardziej typowych typów:
| Klasa | opis |
|---|---|
TableServiceClient |
Ta klasa klienta zapewnia logiczną reprezentację po stronie klienta dla usługi Azure Cosmos DB. Obiekt klienta służy do konfigurowania i wykonywania żądań względem usługi. |
TableClient |
Ta klasa klienta jest odwołaniem do tabeli, która może lub nie istnieje jeszcze w usłudze. Tabela jest weryfikowana po stronie serwera podczas próby uzyskania do niej dostępu lub wykonania operacji względem niej. |
ITableEntity |
Ten interfejs jest interfejsem podstawowym dla wszystkich elementów utworzonych w tabeli lub zapytanych z tabeli. Ten interfejs zawiera wszystkie wymagane właściwości elementów w interfejsie API dla tabeli. |
TableEntity |
Ta klasa jest ogólną implementacją interfejsu ITableEntity jako słownika par klucz-wartość. |
W poniższych przewodnikach pokazano, jak utworzyć aplikację przy użyciu każdej z tych klas.
| Przewodnik | opis |
|---|---|
| Utwórz tabelę | Utwórz tabele |
| Tworzenie elementu | Tworzenie elementów |
| Odczytywanie elementu | Odczytywanie elementów |
Zobacz też
Następne kroki
Po nawiązaniu połączenia z interfejsem API dla konta tabeli użyj następnego przewodnika, aby utworzyć tabele i zarządzać nimi.