Introdução ao Azure Cosmos DB para Tabela com .NET

APLICA-SE A: Tabela

Este artigo mostra-lhe como ligar ao Azure Cosmos DB para Tabela com o SDK .NET. Depois de ligado, pode efetuar operações em tabelas e itens.

Pacote (NuGet) | Exemplos | Referência | da APICódigo fonte | da biblioteca Enviar Comentários |

Pré-requisitos

• Uma conta do Azure com uma subscrição ativa. Crie uma conta gratuitamente.
• Azure Cosmos DB para conta de Tabela. Crie uma API para a Conta de tabela.
• .NET 6.0 ou posterior
• Interface de Command-Line do Azure (CLI) ou Azure PowerShell

Configurar o seu projeto

Criar a aplicação de consola .NET

Crie uma nova aplicação .NET com o dotnet new comando com o modelo de consola .

dotnet new console

Importe o pacote NuGet Azure.Data.Tables com o dotnet add package comando .

dotnet add package Azure.Data.Tables

Crie o projeto com o dotnet build comando .

dotnet build

Ligar ao Azure Cosmos DB para Tabela

Para ligar à API para a Tabela do Azure Cosmos DB, crie uma instância da TableServiceClient classe . Esta classe é o ponto de partida para realizar todas as operações em tabelas. Existem duas formas principais de ligar a uma API para a conta de Tabela com a classe TableServiceClient :

• Ligar com uma API para a cadeia de ligação Tabela

Ligar com uma cadeia de ligação

O construtor mais comum para TableServiceClient tem um único parâmetro:

Parâmetro	Valor de exemplo	Description
connectionString	COSMOS_CONNECTION_STRING variável de ambiente	Cadeia de ligação à API para a conta Tabela

Obter a cadeia de ligação da conta

CLI do Azure

1. Utilize o az cosmosdb list comando para obter o nome da primeira conta do Azure Cosmos DB no grupo de recursos e armazene-a na variável da shell accountName .

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

2. Localize a CADEIA DE LIGAÇÃO PRIMÁRIA na lista de cadeias de ligação da conta com o az-cosmosdb-keys-list comando .

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

PowerShell

1. Utilize o Get-AzCosmosDBAccount cmdlet para obter o nome da primeira conta do Azure Cosmos DB no grupo de recursos e armazene-o na variável de shell 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. Localize a CADEIA DE LIGAÇÃO PRIMÁRIA na lista de cadeias de ligação da conta com o Get-AzCosmosDBAccountKey cmdlet .

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

Para utilizar o valor CADEIA DE LIGAÇÃO PRIMÁRIA no código .NET, mantenha-o numa nova variável de ambiente no computador local que executa a aplicação.

Windows

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

Linux/macOS

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

Criar TableServiceClient com cadeia de ligação

Crie uma nova instância da classe TableServiceClient com a variável de COSMOS_CONNECTION_STRING ambiente como o único parâmetro.

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

Compilar a aplicação

À medida que cria a sua aplicação, o seu código irá interagir principalmente com quatro tipos de recursos:

• A API para a conta tabela, que é o espaço de nomes de nível superior exclusivo para os seus dados do Azure Cosmos DB.

• Tabelas, que contêm um conjunto de itens individuais na sua conta.

• Itens, que representam um item individual na sua tabela.

O diagrama seguinte mostra a relação entre estes recursos.

Diagrama hierárquico a mostrar uma conta do Azure Cosmos DB na parte superior. A conta tem dois nós de tabela subordinados. Um dos nós de tabela inclui dois itens subordinados.

Cada tipo de recurso é representado por uma ou mais classes ou interfaces .NET associadas. Eis uma lista dos tipos mais comuns:

Classe	Descrição
TableServiceClient	Esta classe de cliente fornece uma representação lógica do lado do cliente para o serviço do Azure Cosmos DB. O objeto de cliente é utilizado para configurar e executar pedidos no serviço.
TableClient	Esta classe de cliente é uma referência a uma tabela que pode, ou não, ainda existir no serviço. A tabela é validada do lado do servidor quando tenta aceder à mesma ou efetuar uma operação na mesma.
ITableEntity	Esta interface é a interface base para todos os itens criados na tabela ou consultados a partir da tabela. Esta interface inclui todas as propriedades necessárias para itens na API para Tabela.
TableEntity	Esta classe é uma implementação genérica da ITableEntity interface como um dicionário de pares chave-valor.

Os guias seguintes mostram-lhe como utilizar cada uma destas classes para criar a sua aplicação.

Guia	Descrição
Criar tabelas	Criar tabelas
Criar um item	Criar itens
Ler um item	Ler itens

Ver também

• Pacote (NuGet)
• Amostras
• Referência da API
• Código fonte da biblioteca
• Enviar Comentários

Passos seguintes

Agora que se ligou a uma API para conta de Tabela, utilize o guia seguinte para criar e gerir tabelas.

Criar uma tabela no Azure Cosmos DB para Tabela com .NET