Rozpoczynanie pracy z usługą Azure Cosmos DB dla tabel przy użyciu platformy .NET

Artykuł
06/01/2023

DOTYCZY: Tabeli

W tym artykule pokazano, jak nawiązać połączenie z usługą Azure Cosmos DB dla tabel przy użyciu zestawu SDK platformy .NET. Po nawiązaniu połączenia można wykonywać operacje na tabelach i elementach.

Wymagania wstępne

Konto platformy Azure z aktywną subskrypcją. Utwórz bezpłatne konto.
Usługa Azure Cosmos DB dla konta tabeli. Utwórz interfejs API dla konta tabeli.
.NET 6.0 lub nowszy
Interfejs platformy Azure Command-Line (CLI) lub Azure PowerShell

konfigurowanie projektu

Tworzenie aplikacji konsolowej .NET

Utwórz nową aplikację .NET przy użyciu dotnet new polecenia z szablonem konsoli .

dotnet new console

Zaimportuj pakiet NuGet Azure.Data.Tables przy dotnet add package użyciu 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 wykonywania wszystkich operacji względem tabel. Istnieją dwa podstawowe sposoby nawiązywania połączenia z interfejsem API dla konta tabel przy użyciu klasy TableServiceClient :

Nawiązywanie połączenia za pomocą interfejsu API dla parametrów połączenia tabeli

Nawiązywanie połączenia przy użyciu parametrów połączenia

Najbardziej typowy konstruktor klasy TableServiceClient ma jeden parametr:

Parametr	Przykładowa wartość	Opis
`connectionString`	`COSMOS_CONNECTION_STRING` zmienna środowiskowa	Parametry połączenia z interfejsem API dla konta tabeli

Pobieranie parametrów połączenia konta

Interfejs wiersza polecenia platformy Azure
Program PowerShell

az cosmosdb list Użyj polecenia , aby pobrać nazwę pierwszego konta usługi Azure Cosmos DB w grupie zasobów i zapisać je w zmiennej powłoki accountName.

# Retrieve most recently created account name
accountName=$(
    az cosmosdb list \
        --resource-group $resourceGroupName \
        --query "[0].name" \
        --output tsv
)

Znajdź podstawowe parametry połączenia z listy parametrów połączenia dla konta za az-cosmosdb-keys-list pomocą polecenia .

az cosmosdb keys list \
    --resource-group $resourceGroupName \
    --name $accountName \
    --type "connection-strings" \
    --query "connectionStrings[?description == \`Primary Table Connection String\`] | [0].connectionString"

Get-AzCosmosDBAccount Użyj polecenia cmdlet , aby pobrać nazwę pierwszego konta usługi Azure Cosmos DB w grupie zasobów i zapisać je w zmiennej powłoki ACCOUNT_NAME.

# Retrieve most recently created account name
$parameters = @{
    ResourceGroupName = $RESOURCE_GROUP_NAME
}
$ACCOUNT_NAME = (
    Get-AzCosmosDBAccount @parameters |
        Select-Object -Property Name -First 1
).Name

Znajdź PODSTAWOWE PARAMETRY POŁĄCZENIA z listy parametrów połączenia dla konta za Get-AzCosmosDBAccountKey pomocą polecenia cmdlet .

$parameters = @{
    ResourceGroupName = $RESOURCE_GROUP_NAME
    Name = $ACCOUNT_NAME
    Type = "ConnectionStrings"
}    
Get-AzCosmosDBAccountKey @parameters |
    Select-Object -Property "Primary Table Connection String" -First 1

Aby użyć wartości PODSTAWOWE PARAMETRY POŁĄCZENIA w kodzie platformy .NET, utrwali ją w nowej zmiennej środowiskowej na komputerze lokalnym z uruchomioną aplikacją.

Windows
Linux/macOS

$env:COSMOS_CONNECTION_STRING = "<cosmos-account-PRIMARY-CONNECTION-STRING>"

export COSMOS_CONNECTION_STRING="<cosmos-account-PRIMARY-CONNECTION-STRING>"

Tworzenie obiektu TableServiceClient z parametrami połączenia

Utwórz nowe wystąpienie klasy TableServiceClient ze zmienną COSMOS_CONNECTION_STRING środowiskową jako jedynym parametrem.

// New instance of TableServiceClient class using a connection string
TableServiceClient client = new(
    connectionString: Environment.GetEnvironmentVariable("COSMOS_CONNECTION_STRING")!
);

Kompilowanie aplikacji

Podczas tworzenia aplikacji kod będzie współdziałać głównie 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, które zawierają 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 hierarchii usługi Azure Cosmos DB, w tym kont, tabel i elementów.

Każdy typ zasobu jest reprezentowany przez co najmniej jedną skojarzną klasę lub interfejsy platformy .NET. Oto lista najpopularniejszych 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 podstawowym interfejsem dla wszystkich elementów utworzonych w tabeli lub odpytywane 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
Tworzenie tabeli	Tworzenie tabel
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 tabel skorzystaj z następnego przewodnika, aby utworzyć tabele i zarządzać nimi.

Tworzenie tabeli w usłudze Azure Cosmos DB dla tabel przy użyciu platformy .NET

Share via