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

GÄLLER FÖR: Tabell

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.

Paket (NuGet) | Prover | API-referens | Bibliotekskällans kod | Ge feedback |

Förutsättningar

• Ett Azure-konto med en aktiv prenumeration. Skapa ett konto utan kostnad.
• Azure Cosmos DB för tabellkonto. Skapa ett API för tabellkonto.
• .NET 6.0 eller senare
• Azure Command-Line Interface (CLI) eller Azure PowerShell

Konfigurera projektet

Skapa .NET-konsolprogrammet

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 for 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. Det finns två huvudsakliga sätt att ansluta till ett API för tabellkonto med hjälp av klassen TableServiceClient :

• Ansluta med ett API för tabellanslutningssträng

Ansluta med en anslutningssträng

Den vanligaste konstruktorn för TableServiceClient har en enda parameter:

Parameter	Exempelvärde	Beskrivning
connectionString	COSMOS_CONNECTION_STRING miljövariabel	Anslutningssträng till API:et för tabellkontot

Hämta anslutningssträngen för ditt konto

Azure CLI

1. az cosmosdb list Använd kommandot för att hämta namnet på det första Azure Cosmos DB-kontot i resursgruppen och lagra det i shell-variabeln accountName.

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

2. Leta reda på PRIMÄR ANSLUTNINGSSTRÄNG i listan över anslutningssträngar för kontot med az-cosmosdb-keys-list kommandot .

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

PowerShell

1. Använd cmdleten Get-AzCosmosDBAccount för att hämta namnet på det första Azure Cosmos DB-kontot i resursgruppen och lagra det i ACCOUNT_NAME-gränssnittsvariabeln.

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

2. Leta reda på PRIMÄR ANSLUTNINGSSTRÄNG i listan över anslutningssträngar för kontot med cmdleten Get-AzCosmosDBAccountKey .

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

Om du vill använda värdet PRIMÄR ANSLUTNINGSSTRÄNG i .NET-koden sparar du det i en ny miljövariabel på den lokala datorn som kör programmet.

Windows

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

Linux/macOS

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

Skapa TableServiceClient med anslutningssträng

Skapa en ny instans av klassen TableServiceClient med COSMOS_CONNECTION_STRING miljövariabeln som enda parameter.

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

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.

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 efterfrågas från tabellen. Det här gränssnittet innehåller alla obligatoriska 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

• Paket (NuGet)
• Exempel
• API-referens
• Bibliotekskällans kod
• Ge feedback

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.

Skapa en tabell i Azure Cosmos DB for Table med hjälp av .NET