Начало работы с Azure Cosmos DB для таблиц с помощью .NET

Статья
06/01/2023

ПРИМЕНИМО К: Таблица

В этой статье показано, как подключиться к Azure Cosmos DB для таблицы с помощью пакета SDK для .NET. После подключения можно выполнять операции с таблицами и элементами.

Предварительные требования

Учетная запись Azure с активной подпиской. Создайте учетную запись бесплатно.
Azure Cosmos DB для учетной записи таблицы. Создайте API для учетной записи таблицы.
.NET 6.0 или более поздней версии
Интерфейс командной строки (CLI) Azure или Azure PowerShell

Настройка проекта

Создайте консольное приложение .NET

Создайте новое приложение .NET, используя команду dotnet new с шаблоном console.

dotnet new console

Импортируйте пакет NuGet Azure.Data.Tables с помощью команды dotnet add package.

dotnet add package Azure.Data.Tables

Создайте проект с помощью команды dotnet build.

dotnet build

Подключение к Azure Cosmos DB для таблицы

Чтобы подключиться к API для Таблицы Azure Cosmos DB, создайте экземпляр TableServiceClient класса . Этот класс является начальной точкой для выполнения всех операций с таблицами. Существует два основных способа подключения к учетной записи API для таблицы с помощью класса TableServiceClient :

Подключение с помощью строки подключения API для таблицы

Подключение с использованием строки подключения

Наиболее распространенный конструктор для TableServiceClient принимает один параметр:

Параметр	Пример значения	Описание
`connectionString`	Переменная среды `COSMOS_CONNECTION_STRING`.	Строка подключения к API для учетной записи таблицы

Получение строки подключения к учетной записи

Azure CLI
PowerShell

Используйте команду az cosmosdb list, чтобы получить имя первой учетной записи Azure Cosmos DB в группе ресурсов и сохранить его в переменной оболочки accountName.
```
# Retrieve most recently created account name
accountName=$(
    az cosmosdb list \
        --resource-group $resourceGroupName \
        --query "[0].name" \
        --output tsv
)
```

Найдите PRIMARY CONNECTION STRING в списке строк подключения для учетной записи с помощью команды az-cosmosdb-keys-list.

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

Используйте командлет Get-AzCosmosDBAccount, чтобы получить имя первой учетной записи Azure Cosmos DB в группе ресурсов и сохранить его в переменной оболочки 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
```

Найдите ОСНОВНУЮ СТРОКУ ПОДКЛЮЧЕНИЯ в списке строк подключения для учетной записи с помощью командлета Get-AzCosmosDBAccountKey.

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

Чтобы использовать значение поля ОСНОВНАЯ СТРОКА ПОДКЛЮЧЕНИЯ в коде .NET, сохраните его в новой переменной среды на локальном компьютере, на котором выполняется приложение.

Windows
Linux / macOS

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

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

Создание TableServiceClient со строкой подключения

Создайте новый экземпляр класса TableServiceClient с переменной среды COSMOS_CONNECTION_STRING в качестве единственного параметра.

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

Сборка приложения

При создании приложения код будет в основном взаимодействовать с четырьмя типами ресурсов:

Учетная запись API для таблиц, которая является уникальным пространством имен верхнего уровня для данных Azure Cosmos DB.
Таблицы, содержащие набор отдельных элементов в учетной записи.
Элементы, представляющие отдельный элемент в таблице.

На следующей схеме показана связь между этими ресурсами.

Схема иерархии Azure Cosmos DB с учетными записями, таблицами и элементами.

Каждый тип ресурса представлен одним или несколькими связанными интерфейсами или классами .NET. Ниже приведен список наиболее распространенных типов.

Класс	Описание
`TableServiceClient`	Этот клиентский класс является логическим представлением службы Azure Cosmos DB на стороне клиента. Этот клиентский объект позволяет настраивать и выполнять запросы к службе.
`TableClient`	Этот клиентский класс является ссылкой на таблицу, которая может существовать или еще не существовать в службе. Таблица проверяется на стороне сервера при попытке доступа к ней или выполнении операции с ней.
`ITableEntity`	Этот интерфейс является базовым интерфейсом для всех элементов, создаваемых в таблице или запрашиваемых из таблицы. Этот интерфейс включает все обязательные свойства для элементов в API для таблицы.
`TableEntity`	Этот класс представляет собой универсальную реализацию интерфейса `ITableEntity` в формате словаря с парами "ключ — значение".

Сведения об использовании каждого из этих классов для создания приложения приведены в следующих руководствах.

Руководство	Описание
Создание таблицы	Создание таблиц
Создание элемента	Создание элементов
Чтение элемента	Чтение элементов

См. также раздел

Дальнейшие действия

Теперь, когда вы подключились к учетной записи API для таблиц, используйте следующее руководство по созданию таблиц и управлению ими.

Создание таблицы в Azure Cosmos DB для таблицы с помощью .NET

Share via