Skip to content

Latest commit

 

History

History
211 lines (149 loc) · 7.42 KB

azure-storage-tables-component.md

File metadata and controls

211 lines (149 loc) · 7.42 KB
Raw
title description ms.date ms.topic
.NET Aspire Azure Data Tables component
This article describes the .NET Aspire Azure Data Tables component features and capabilities.
05/14/2024
how-to

.NET Aspire Azure Data Tables component

In this article, you learn how to use the .NET Aspire Azure Data Tables component. The Aspire.Azure.Data.Tables library is used to:

  • Registers a xref:Azure.Data.Tables.TableServiceClient as a singleton in the DI container for connecting to Azure Table storage.
  • Enables corresponding health checks, logging and telemetry.

Prerequisites

Get started

To get started with the .NET Aspire Azure Data Tables component, install the Aspire.Azure.Data.Tables NuGet package.

.NET CLI

dotnet add package Aspire.Azure.Data.Tables

PackageReference

<PackageReference Include="Aspire.Azure.Data.Tables"
                  Version="[SelectVersion]" />

For more information, see dotnet add package or Manage package dependencies in .NET applications.

Example usage

In the :::no-loc text="Program.cs"::: file of your component-consuming project, call the xref:Microsoft.Extensions.Hosting.AspireTablesExtensions.AddAzureTableClient%2A extension to register a TableServiceClient for use via the dependency injection container.

builder.AddAzureTableClient("tables");

To retrieve the TableServiceClient instance using dependency injection, define it as a constructor parameter. Consider the following example service:

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

App host usage

To add Azure Storage hosting support to your xref:Aspire.Hosting.IDistributedApplicationBuilder, install the Aspire.Hosting.Azure.Storage NuGet package.

.NET CLI

dotnet add package Aspire.Hosting.Azure.Storage

PackageReference

<PackageReference Include="Aspire.Hosting.Azure.Storage"
                  Version="[SelectVersion]" />

In your app host project, register the Azure Table Storage component and consume the service using the following methods:

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

// Service consumption
Builder.AddProject<MyApp.ExampleProject>() 
       .WithReference(tables)

For more information, see xref:Aspire.Hosting.ResourceBuilderExtensions.WithReference%2A.

Configuration

The .NET Aspire Azure Table Storage component 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 component supports xref:Microsoft.Extensions.Configuration?displayProperty=fullName. It loads the xref:Aspire.Azure.Data.Tables.AzureDataTablesSettings from :::no-loc text="appsettings.json"::: or other configuration files using Aspire:Azure:Data:Tables key.

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

If you have set up your configurations in the Aspire:Azure:Data:Tables section of your :::no-loc text="appsettings.json"::: file you can just call the method AddAzureTableClient without passing any parameters.

Use inline delegates

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

builder.AddAzureTableClient(
    "tables",
    static settings => settings.ServiceUri = new Uri("YOUR_SERVICEURI"));

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

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

Named instances

If you want to add more than one xref:Azure.Data.Tables.TableServiceClient you can use named instances. Load the named configuration section from the json config by calling the AddAzureTableClient method and passing in the INSTANCE_NAME.

builder.AddAzureTableClient("INSTANCE_NAME");

The corresponding configuration JSON is defined as follows:

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

Configuration options

The following configurable options are exposed through the xref:Aspire.Azure.Data.Tables.AzureDataTablesSettings class:

Name Description
ServiceUri A "Uri" referencing the Table service.
Credential The credential used to authenticate to the Table Storage.
DisableHealthChecks A boolean value that indicates whether the Table Storage health check is disabled or not.
DisableTracing A boolean value that indicates whether the OpenTelemetry tracing is disabled or not.

[!INCLUDE component-health-checks]

By default, The .NET Aspire Azure Data Tables component handles the following:

  • Adds the AzureTableStorageHealthCheck health check, which attempts to connect to and query 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 component-observability-and-telemetry]

Logging

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

  • Azure.Core
  • Azure.Identity

Tracing

The .NET Aspire Azure Data Tables component will emit the following tracing activities using OpenTelemetry:

  • "Azure.Data.Tables.TableServiceClient"

Metrics

The .NET Aspire Azure Data Tables component currently does not support metrics by default due to limitations with the Azure SDK.

See also