Začínáme se službou Azure Cosmos DB for Table s využitím .NET

PLATÍ PRO: Tabulka

V tomto článku se dozvíte, jak se připojit ke službě Azure Cosmos DB for Table pomocí sady .NET SDK. Po připojení můžete provádět operace s tabulkami a položkami.

Balíček (NuGet) | Vzorky | Referenční informace k | rozhraní API Zdrojový kód | knihovny Poslat zpětnou vazbu |

Požadavky

• Účet Azure s aktivním předplatným. Vytvořte si účet zdarma.
• Účet Azure Cosmos DB for Table. Vytvořte rozhraní API pro účet Tabulky.
• .NET 6.0 nebo novější
• Rozhraní azure Command-Line (CLI) nebo Azure PowerShell

Nastavení projektu

Vytvoření konzolové aplikace .NET

Vytvořte novou aplikaci .NET pomocí dotnet new příkazu se šablonou konzoly .

dotnet new console

Importujte balíček NuGet Azure.Data.Tables pomocí dotnet add package příkazu .

dotnet add package Azure.Data.Tables

Sestavte projekt pomocí dotnet build příkazu .

dotnet build

Připojení ke službě Azure Cosmos DB for Table

Pokud se chcete připojit k rozhraní API pro tabulku služby Azure Cosmos DB, vytvořte instanci TableServiceClient třídy. Tato třída je výchozím bodem pro provádění všech operací s tabulkami. Existují dva primární způsoby připojení k rozhraní API pro účet Table pomocí třídy TableServiceClient :

• Připojení pomocí rozhraní API pro připojovací řetězec tabulky

Připojení pomocí připojovacího řetězce

Nejběžnější konstruktor pro TableServiceClient má jeden parametr:

Parametr	Příklad hodnoty	Popis
connectionString	COSMOS_CONNECTION_STRING proměnná prostředí	Připojovací řetězec k rozhraní API pro účet Table

Načtení připojovacího řetězce účtu

Azure CLI

1. Pomocí příkazu az cosmosdb list načtěte název prvního účtu služby Azure Cosmos DB ve vaší skupině prostředků a uložte ho do proměnné prostředí accountName .

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

2. Pomocí příkazu vyhledejte PRIMÁRNÍ PŘIPOJOVACÍ ŘETĚZEC ze seznamu připojovacích řetězců pro účet 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"
   

PowerShell

1. Pomocí rutiny Get-AzCosmosDBAccount načtěte název prvního účtu služby Azure Cosmos DB ve vaší skupině prostředků a uložte ho do proměnné prostředí 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
   

2. Pomocí rutiny vyhledejte PRIMÁRNÍ PŘIPOJOVACÍ ŘETĚZEC ze seznamu připojovacích řetězců pro účet Get-AzCosmosDBAccountKey .

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

Pokud chcete použít hodnotu PRIMARY CONNECTION STRING v kódu .NET, uchovávejte ji v nové proměnné prostředí na místním počítači, na kterém běží aplikace.

Windows

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

Linux / macOS

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

Vytvoření TableServiceClient s připojovacím řetězcem

Vytvořte novou instanci třídy TableServiceClient s proměnnou COSMOS_CONNECTION_STRING prostředí jako jediným parametrem.

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

Sestavení aplikace

Při sestavování aplikace bude váš kód primárně pracovat se čtyřmi typy prostředků:

• Účet rozhraní API pro table, což je jedinečný obor názvů nejvyšší úrovně pro data služby Azure Cosmos DB.

• Tabulky, které obsahují sadu jednotlivých položek ve vašem účtu.

• Položky, které představují jednotlivé položky v tabulce.

Na následujícím diagramu jsou vztahy těchto prostředků.

Hierarchický diagram znázorňující účet služby Azure Cosmos DB v horní části Účet má dva podřízené uzly tabulky. Jeden z uzlů tabulky obsahuje dvě podřízené položky.

Každý typ prostředku je reprezentován jednou nebo více přidruženými třídami nebo rozhraními .NET. Tady je seznam nejběžnějších typů:

Třída	Popis
TableServiceClient	Tato klientská třída poskytuje logickou reprezentaci služby Azure Cosmos DB na straně klienta. Objekt klienta se používá ke konfiguraci a spouštění požadavků na službu.
TableClient	Tato třída klienta je odkazem na tabulku, která ve službě ještě může nebo nemusí existovat. Tabulka se ověří na straně serveru, když se k ní pokusíte získat přístup nebo s ní provedete operaci.
ITableEntity	Toto rozhraní je základní rozhraní pro všechny položky, které jsou vytvořeny v tabulce nebo dotazovány z tabulky. Toto rozhraní obsahuje všechny požadované vlastnosti pro položky v rozhraní API pro table.
TableEntity	Tato třída je obecná implementace ITableEntity rozhraní jako slovník párů klíč-hodnota.

Následující příručky ukazují, jak použít každou z těchto tříd k sestavení aplikace.

Průvodce	Popis
Vytvoření tabulky	Vytváření tabulek
Vytvoření položky	Vytvoření položek
Čtení položky	Čtení položek

Viz také

• Balíček (NuGet)
• ukázky
• Referenční materiály k rozhraní API
• Zdrojový kód knihovny
• Poslat zpětnou vazbu

Další kroky

Teď, když jste se připojili k rozhraní API pro účet Table, použijte další příručku k vytváření a správě tabulek.

Vytvoření tabulky ve službě Azure Cosmos DB pro tabulku pomocí .NET