AzureStorageClient 1.1.2

Introduction

Project to handle all interaction between Data2Track applications and the Azure Storage service. With this class library it will be easier to mantain the code for Azure connection in other projects.

Requirements

To run/debug this project its important to have .NET 7 installed.

Azure Storage service

The following Azure Storage serivces are supported in this project:

• Azure Table Storage
• Azure Blob Storage
• Azure Queue Storage

Azure environments

• Producation
• Test
• RawData
• Local

Implementation in other projects

This class library is made to make life easier in other projects. To implement this in another project the following steps are required

1. Install the nuget package

Go to the nuget package manager of the project and search for "AzureStorageClient"

2. User secrets

Add user secrets to the project. The following section should be included:

  "AzureConnectionConfiguration": {
    "LocalConnectionString": "",
    "ProductionConnectionString": "",
    "TestConnectionString": "",
    "RawDataConnectionString": ""
  }

if the project is gonna be deployed to a Function App its important to configure the application settings. This can be done the following way: click new application setting:

Name AzureConnectionConfiguration:TestConnectionString example

Value "connectionstring for the storage account"

This has to be handled different compared to the local developement. The reason for this is the way a production environment handles appsettings.

3. Startup

To use the package in a Azure Function project (V4 isolated), the options must be loaded inside the ConfigureService method and the AzureTableService must be injected with dependency injection. See the following example

  services.AddOptions<AzureConnectionConfiguration>().Configure<IConfiguration>((settings, config) =>
  {
      config.GetSection("AzureConnectionConfiguration").Bind(settings);
  });
  services.AddScoped<IAzureTableService, AzureTableService>();

4. Usage in service

To use the service(s) it first must be injected into the service/feature that wants to use Azure Storage services. See the following example.

using AzureStorageClient.Services.Interfaces;
using AzureStorageClient.Models;

private readonly IAzureTableService _azureTableService

public SomeClass(IAzureTableService azureTableService)
{
  _azureTableService = azureTableService;
}

public async Task<Entity> GetEntity()
{
  string filter = "PartitionKey eq 'SOME PARTITIONKEY' and RowKey eq 'SOME ROWKEY'";
  return await _azureTableService.GetEntity(filter, tableName, CloudStorageEnvironment.Local);
}

5. Usage of the AzureTableService

To use the example from 4. it is required to have a class that repesents the object in the table. This class needs to extend from the class AzureTableEntity (which comes included in with this package in the AzureStorageClient.Models namespace).

public class SomeClass : AzureTableEntity
{

}