Skip to content

Latest commit

 

History

History
160 lines (108 loc) · 6.56 KB

azure-storage-tables-integration.md

File metadata and controls

160 lines (108 loc) · 6.56 KB
title description ms.date uid
.NET Aspire Azure Data Tables integration
Learn how to use the .NET Aspire Azure Data Tables integration, which includes both hosting and client integrations.
12/09/2024
storage/azure-data-tables-integration

.NET Aspire Azure Data Tables integration

[!INCLUDE includes-hosting-and-client]

Azure Table Storage is a service for storing structured NoSQL data. The .NET Aspire Azure Data Tables integration enables you to connect to existing Azure Table Storage instances or create new instances from .NET applications.

Hosting integration

[!INCLUDE storage-app-host]

Add Azure Table Storage resource

In your app host project, register the Azure Table Storage integration by chaining a call to xref:Aspire.Hosting.AzureStorageExtensions.AddTables* on the IResourceBuilder<IAzureStorageResource> instance returned by xref:Aspire.Hosting.AzureStorageExtensions.AddAzureStorage*. The following example demonstrates how to add an Azure Table Storage resource named storage and a table resource named tables:

var builder = DistributedApplication.CreateBuilder(args);

var tables = builder.AddAzureStorage("storage")
                    .AddTables("tables");

builder.AddProject<Projects.ExampleProject>()
       .WithReference(tables)
       .WaitFor(tables);

// After adding all resources, run the app...

The preceding code:

  • Adds an Azure Storage resource named storage.
  • Adds a table storage resource named tables to the storage resource.
  • Adds the storage resource to the ExampleProject and waits for it to be ready before starting the project.

[!INCLUDE storage-hosting-health-checks]

Client integration

To get started with the .NET Aspire Azure Data Tables client integration, install the 📦 Aspire.Azure.Data.Tables NuGet package in the client-consuming project, that is, the project for the application that uses the Azure Data Tables client. The Azure Data Tables client integration registers a xref:Azure.Data.Tables.TableServiceClient instance that you can use to interact with Azure Table Storage.

.NET CLI

dotnet add package Aspire.Azure.Data.Tables

PackageReference

<PackageReference Include="Aspire.Azure.Data.Tables"
                  Version="*" />

Add Azure Table Storage client

In the :::no-loc text="Program.cs"::: file of your client-consuming project, call the xref:Microsoft.Extensions.Hosting.AspireTablesExtensions.AddAzureTableClient%2A extension method on any xref:Microsoft.Extensions.Hosting.IHostApplicationBuilder to register a TableServiceClient for use via the dependency injection container. The method takes a connection name parameter.

builder.AddAzureTableClient("tables");

You can then retrieve the TableServiceClient instance using dependency injection. For example, to retrieve the client from a service:

public class ExampleService(TableServiceClient client)
{
    // Use client...
}

Configuration

The .NET Aspire Azure Table Storage integration provides multiple options to configure the TableServiceClient based on the requirements and conventions of your project.

Use configuration providers

The .NET Aspire Azure Table Storage integration supports xref:Microsoft.Extensions.Configuration?displayProperty=fullName. It loads the xref:Aspire.Azure.Data.Tables.AzureDataTablesSettings and xref:Azure.Data.Tables.TableClientOptions from configuration by using the Aspire:Azure:Data:Tables key. The following snippet is an example of a :::no-loc text="appsettings.json"::: file that configures some of the options:

{
  "Aspire": {
    "Azure": {
      "Data": {
        "Tables": {
          "ServiceUri": "YOUR_URI",
          "DisableHealthChecks": true,
          "DisableTracing": false,
          "ClientOptions": {
            "EnableTenantDiscovery": true
          }
        }
      }
    }
  }
}

For the complete Azure Data Tables client integration JSON schema, see Aspire.Azure.Data.Tables/ConfigurationSchema.json.

Use inline delegates

You can also pass the Action<AzureDataTablesSettings> configureSettings delegate to set up some or all the options inline, for example to configure the ServiceUri:

builder.AddAzureTableClient(
    "tables",
    settings => settings.DisableHealthChecks = true);

You can also set up the xref:Azure.Data.Tables.TableClientOptions using Action<IAzureClientBuilder<TableServiceClient, TableClientOptions>> configureClientBuilder delegate, the second parameter of the AddAzureTableClient method. For example, to set the TableServiceClient ID to identify the client:

builder.AddAzureTableClient(
    "tables",
    configureClientBuilder: clientBuilder =>
        clientBuilder.ConfigureOptions(
            options => options.EnableTenantDiscovery = true));

Client integration health checks

By default, .NET Aspire integrations enable health checks for all services. For more information, see .NET Aspire integrations overview.

The .NET Aspire Azure Data Tables integration:

  • Adds the health check when xref:Aspire.Azure.Data.Tables.AzureDataTablesSettings.DisableHealthChecks?displayProperty=nameWithType is false, which attempts to connect to the Azure Table Storage.
  • Integrates with the /health HTTP endpoint, which specifies all registered health checks must pass for app to be considered ready to accept traffic.

[!INCLUDE integration-observability-and-telemetry]

Logging

The .NET Aspire Azure Data Tables integration uses the following log categories:

  • Azure.Core
  • Azure.Identity

Tracing

The .NET Aspire Azure Data Tables integration emits the following tracing activities using OpenTelemetry:

  • Azure.Data.Tables.TableServiceClient

Metrics

The .NET Aspire Azure Data Tables integration currently doesn't support metrics by default due to limitations with the Azure SDK.

See also