# AspireTablesExtensions Methods

- Package: [Aspire.Azure.Data.Tables](/reference/api/csharp/aspire.azure.data.tables.md)
- Type: [AspireTablesExtensions](/reference/api/csharp/aspire.azure.data.tables/aspiretablesextensions.md)
- Kind: `Methods`
- Members: `4`

Provides extension methods for registering `Tables.TableServiceClient` as a singleton in the services provided by the `Hosting.IHostApplicationBuilder`.

## AddAzureTableClient(IHostApplicationBuilder, string, Action<AzureDataTablesSettings>, Action<IAzureClientBuilder<TableServiceClient, TableClientOptions>>)

> **Obsolete:** Use AddAzureTableServiceClient instead. This method will be removed in a future version.

- Name: `AddAzureTableClient(IHostApplicationBuilder, string, Action<AzureDataTablesSettings>, Action<IAzureClientBuilder<TableServiceClient, TableClientOptions>>)`
- Modifiers: `extension`
- Source: [GitHub](https://github.com/microsoft/aspire/blob/5bd693ae1897dee5e2ce71c2cc08879c1c7eff51/src/Components/Aspire.Azure.Data.Tables/AspireTablesExtensions.cs#L54-L58)

Registers `Tables.TableServiceClient` as a singleton in the services provided by the `builder`. Enables retries, corresponding health check, logging and telemetry.

```csharp
public static class AspireTablesExtensions
{
    public static void AddAzureTableClient(
        this IHostApplicationBuilder builder,
        string connectionName,
        Action<AzureDataTablesSettings>? configureSettings = null,
        Action<IAzureClientBuilder<TableServiceClient, TableClientOptions>>? configureClientBuilder = null)
    {
        // ...
    }
}
```

## Parameters

- `builder` (`IHostApplicationBuilder`)
  The `Hosting.IHostApplicationBuilder` to read config from and add services to.
- `connectionName` (`string`)
  A name used to retrieve the connection string from the ConnectionStrings configuration section.
- `configureSettings` (`Action<AzureDataTablesSettings>`) `optional`
  An optional method that can be used for customizing the [AzureDataTablesSettings](/reference/api/csharp/aspire.azure.data.tables/azuredatatablessettings.md). It's invoked after the settings are read from the configuration.
- `configureClientBuilder` (`Action<IAzureClientBuilder<TableServiceClient, TableClientOptions>>`) `optional`
  An optional method that can be used for customizing the `Extensions.IAzureClientBuilder`2`.

## Exceptions

- `InvalidOperationException` -- Thrown when neither [AzureDataTablesSettings.ConnectionString](/reference/api/csharp/aspire.azure.data.tables/azuredatatablessettings/properties.md#connectionstring) nor [AzureDataTablesSettings.ServiceUri](/reference/api/csharp/aspire.azure.data.tables/azuredatatablessettings/properties.md#serviceuri) is provided.

## Remarks

Reads the configuration from "Aspire:Azure:Data:Tables" section.

## AddAzureTableServiceClient(IHostApplicationBuilder, string, Action<AzureDataTablesSettings>, Action<IAzureClientBuilder<TableServiceClient, TableClientOptions>>)

- Name: `AddAzureTableServiceClient(IHostApplicationBuilder, string, Action<AzureDataTablesSettings>, Action<IAzureClientBuilder<TableServiceClient, TableClientOptions>>)`
- Modifiers: `extension`
- Source: [GitHub](https://github.com/microsoft/aspire/blob/5bd693ae1897dee5e2ce71c2cc08879c1c7eff51/src/Components/Aspire.Azure.Data.Tables/AspireTablesExtensions.cs#L40-L44)

Registers `Tables.TableServiceClient` as a singleton in the services provided by the `builder`. Enables retries, corresponding health check, logging and telemetry.

```csharp
public static class AspireTablesExtensions
{
    public static void AddAzureTableServiceClient(
        this IHostApplicationBuilder builder,
        string connectionName,
        Action<AzureDataTablesSettings>? configureSettings = null,
        Action<IAzureClientBuilder<TableServiceClient, TableClientOptions>>? configureClientBuilder = null)
    {
        // ...
    }
}
```

## Parameters

- `builder` (`IHostApplicationBuilder`)
  The `Hosting.IHostApplicationBuilder` to read config from and add services to.
- `connectionName` (`string`)
  A name used to retrieve the connection string from the ConnectionStrings configuration section.
- `configureSettings` (`Action<AzureDataTablesSettings>`) `optional`
  An optional method that can be used for customizing the [AzureDataTablesSettings](/reference/api/csharp/aspire.azure.data.tables/azuredatatablessettings.md). It's invoked after the settings are read from the configuration.
- `configureClientBuilder` (`Action<IAzureClientBuilder<TableServiceClient, TableClientOptions>>`) `optional`
  An optional method that can be used for customizing the `Extensions.IAzureClientBuilder`2`.

## Exceptions

- `InvalidOperationException` -- Thrown when neither [AzureDataTablesSettings.ConnectionString](/reference/api/csharp/aspire.azure.data.tables/azuredatatablessettings/properties.md#connectionstring) nor [AzureDataTablesSettings.ServiceUri](/reference/api/csharp/aspire.azure.data.tables/azuredatatablessettings/properties.md#serviceuri) is provided.

## Remarks

Reads the configuration from "Aspire:Azure:Data:Tables" section.

## AddKeyedAzureTableClient(IHostApplicationBuilder, string, Action<AzureDataTablesSettings>, Action<IAzureClientBuilder<TableServiceClient, TableClientOptions>>)

> **Obsolete:** Use AddKeyedAzureTableServiceClient instead. This method will be removed in a future version.

- Name: `AddKeyedAzureTableClient(IHostApplicationBuilder, string, Action<AzureDataTablesSettings>, Action<IAzureClientBuilder<TableServiceClient, TableClientOptions>>)`
- Modifiers: `extension`
- Source: [GitHub](https://github.com/microsoft/aspire/blob/5bd693ae1897dee5e2ce71c2cc08879c1c7eff51/src/Components/Aspire.Azure.Data.Tables/AspireTablesExtensions.cs#L90-L94)

Registers `Tables.TableServiceClient` as a singleton in the services provided by the `builder`. Enables retries, corresponding health check, logging and telemetry.

```csharp
public static class AspireTablesExtensions
{
    public static void AddKeyedAzureTableClient(
        this IHostApplicationBuilder builder,
        string name,
        Action<AzureDataTablesSettings>? configureSettings = null,
        Action<IAzureClientBuilder<TableServiceClient, TableClientOptions>>? configureClientBuilder = null)
    {
        // ...
    }
}
```

## Parameters

- `builder` (`IHostApplicationBuilder`)
  The `Hosting.IHostApplicationBuilder` to read config from and add services to.
- `name` (`string`)
- `configureSettings` (`Action<AzureDataTablesSettings>`) `optional`
  An optional method that can be used for customizing the [AzureDataTablesSettings](/reference/api/csharp/aspire.azure.data.tables/azuredatatablessettings.md). It's invoked after the settings are read from the configuration.
- `configureClientBuilder` (`Action<IAzureClientBuilder<TableServiceClient, TableClientOptions>>`) `optional`
  An optional method that can be used for customizing the `Extensions.IAzureClientBuilder`2`.

## Exceptions

- `InvalidOperationException` -- Thrown when neither [AzureDataTablesSettings.ConnectionString](/reference/api/csharp/aspire.azure.data.tables/azuredatatablessettings/properties.md#connectionstring) nor [AzureDataTablesSettings.ServiceUri](/reference/api/csharp/aspire.azure.data.tables/azuredatatablessettings/properties.md#serviceuri) is provided.

## Remarks

Reads the configuration from "Aspire:Azure:Data:Tables" section.

## AddKeyedAzureTableServiceClient(IHostApplicationBuilder, string, Action<AzureDataTablesSettings>, Action<IAzureClientBuilder<TableServiceClient, TableClientOptions>>)

- Name: `AddKeyedAzureTableServiceClient(IHostApplicationBuilder, string, Action<AzureDataTablesSettings>, Action<IAzureClientBuilder<TableServiceClient, TableClientOptions>>)`
- Modifiers: `extension`
- Source: [GitHub](https://github.com/microsoft/aspire/blob/5bd693ae1897dee5e2ce71c2cc08879c1c7eff51/src/Components/Aspire.Azure.Data.Tables/AspireTablesExtensions.cs#L76-L80)

Registers `Tables.TableServiceClient` as a singleton for given `name` in the services provided by the `builder`. Enables retries, corresponding health check, logging and telemetry.

```csharp
public static class AspireTablesExtensions
{
    public static void AddKeyedAzureTableServiceClient(
        this IHostApplicationBuilder builder,
        string name,
        Action<AzureDataTablesSettings>? configureSettings = null,
        Action<IAzureClientBuilder<TableServiceClient, TableClientOptions>>? configureClientBuilder = null)
    {
        // ...
    }
}
```

## Parameters

- `builder` (`IHostApplicationBuilder`)
  The `Hosting.IHostApplicationBuilder` to read config from and add services to.
- `name` (`string`)
  The name of the component, which is used as the `ServiceDescriptor.ServiceKey` of the service and also to retrieve the connection string from the ConnectionStrings configuration section.
- `configureSettings` (`Action<AzureDataTablesSettings>`) `optional`
  An optional method that can be used for customizing the [AzureDataTablesSettings](/reference/api/csharp/aspire.azure.data.tables/azuredatatablessettings.md). It's invoked after the settings are read from the configuration.
- `configureClientBuilder` (`Action<IAzureClientBuilder<TableServiceClient, TableClientOptions>>`) `optional`
  An optional method that can be used for customizing the `Extensions.IAzureClientBuilder`2`.

## Exceptions

- `InvalidOperationException` -- Thrown when neither [AzureDataTablesSettings.ConnectionString](/reference/api/csharp/aspire.azure.data.tables/azuredatatablessettings/properties.md#connectionstring) nor [AzureDataTablesSettings.ServiceUri](/reference/api/csharp/aspire.azure.data.tables/azuredatatablessettings/properties.md#serviceuri) is provided.

## Remarks

Reads the configuration from "Aspire:Azure:Data:Tables:{name}" section.