https://github.com/qinezh/microsoft.extensions.configuration.azureblob

Centralized app settings based on Azure Blob
https://github.com/qinezh/microsoft.extensions.configuration.azureblob

Last synced: 12 days ago
JSON representation

Centralized app settings based on Azure Blob

• Host: GitHub
• URL: https://github.com/qinezh/microsoft.extensions.configuration.azureblob
• Owner: qinezh
• Created: 2018-11-15T08:21:11.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2021-10-07T00:15:18.000Z (over 3 years ago)
• Last Synced: 2024-04-14T23:03:43.490Z (9 months ago)
• Language: C#
• Homepage:
• Size: 731 KB
• Stars: 5
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Microsoft.Extensions.Configuration.AzureBlob

[![Nuget](https://img.shields.io/nuget/v/AzureBlobConfigurationExtension?style=flat-square)](https://www.nuget.org/packages/AzureBlobConfigurationExtension/)

Azure blob configuration provider implementation for Microsoft.Extensions.Configuration.

With this extension, multiple instances can share the application settings saved in Azure Blob, and below functionalities are supported:

* integrated with ASP .NET Core framework.

* auto reload for configuration updates. (**NOTE: require to work with [IOptionsSnapshot](https://docs.microsoft.com/en-us/aspnet/core/fundamentals/configuration/options?view=aspnetcore-3.1#options-interfaces)**)

* version control with the git repo. 

* high avalibility as the configuration is stored at Azure Blob.

## Workflow

![](media/workflow.png)

## Usage

Install package:

```

dotnet add package AzureBlobConfigurationExtension

```

Code sample:

```csharp

using Microsoft.Extensions.Configuration.AzureBlob;

Configuration = new ConfigurationBuilder()

                .AddBlobJson(new BlobJsonConfigurationOption

                {

                    BlobUri = "{the_blob_uri}",

                    ReloadOnChange = true,

                    LogReloadException = e => logger.LogError(e, e.Message),

                    ActionOnReload = () => logger.LogInformation("Reloaded.")

                })

                .Build();

```

If the provided blob is:

* public => the blob will be accessed directly.

* private with SAS token => the blob will be accessed by the SAS token.

* private without SAS token => the blob will be accessed by MSI/AAD automatically.