Added BlobFileStoreFactory to allow DefaultAzureCredential or Connectionstring authentication for Azure Blob storage #12874
Conversation
This allows to use registered clients from Azure.Configuration.Extensions (and DefaultAzureCredential )or specify a connectionstring
rikbosch
changed the title
…es collection and not on each tenant.
agriffard
changed the title
| using Microsoft.Extensions.DependencyInjection; | ||
| using OrchardCore.Modules; | ||
|
|
||
| namespace OrchardCore.FileStorage.AzureBlob; |
There was a problem hiding this comment.
Add new line after the namespace.
| private readonly IAzureClientFactory<BlobServiceClient> _clientFactory; | ||
| private readonly IServiceProvider _serviceProvider; | ||
|
|
||
| private const string DefaultStorageName = "Default"; |
There was a problem hiding this comment.
rename the variable to _defaultStorageName
|
|
||
| private BlobContainerClient CreateContainerClientFromOptions(BlobStorageOptions options) | ||
| { | ||
| // return a container client from connectionstring, if specified |
There was a problem hiding this comment.
| // return a container client from connectionstring, if specified | |
| // Create a container using the specified connection string. |
| return new BlobContainerClient(options.ConnectionString, options.ContainerName); | ||
| } | ||
|
|
||
| // else use the clientFactory to lookup a BlobService with the specified name |
There was a problem hiding this comment.
| // else use the clientFactory to lookup a BlobService with the specified name | |
| // Create a container using the specified Blob service. |
| .GetBlobContainerClient(options.ContainerName); | ||
| } | ||
|
|
||
| // fall-back to the default registered blob storage |
There was a problem hiding this comment.
| // fall-back to the default registered blob storage | |
| // Create a container using the Default client. |
| @@ -24,6 +24,9 @@ public static OrchardCoreBuilder AddAzureShellsConfiguration(this OrchardCoreBui | |||
|
|
|||
| services.TryAddSingleton<IContentTypeProvider, FileExtensionContentTypeProvider>(); | |||
|
|
|||
| // register the azure blob file storage services | |||
There was a problem hiding this comment.
I would just remove this comment.
| // always use TryXXX methods because this method can be called multiple times | ||
| // by different modules (currently: Azure Media and Azure Shells module) | ||
| services.TryAddSingleton<BlobFileStoreFactory>(); | ||
| return services; |
There was a problem hiding this comment.
New line before return
Then either remove the comment or change the comment block to something like this
// TryAddSingleton is used to prevent registering the service again.
| { | ||
| /// <summary> | ||
| /// Registers the BlobFileStorage services in the ServiceCollection. | ||
| /// Note: this method can be called multiple times |
There was a problem hiding this comment.
I would remove the comments here.
| /// <returns></returns> | ||
| public static OrchardCoreBuilder AddAzureBlobFileStorage(this OrchardCoreBuilder builder) | ||
| { | ||
| builder.ApplicationServices.AddAzureBlobFileStorage(); |
| @@ -95,22 +95,22 @@ public override void ConfigureServices(IServiceCollection services) | |||
| services.AddSingleton<IMediaFileStoreCache>(serviceProvider => | |||
| serviceProvider.GetRequiredService<IMediaFileStoreCacheFileProvider>()); | |||
|
|
|||
| // Register the BlobFileStorageFactory | |||
|
Additionally, please
|
|
It looks like the trail has gone cold on this. Just commenting to say that I'm looking for a way to use Azure Managed Identity for |
|
This pull request has merge conflicts. Please resolve those before requesting a review. |
|
Is this something you'd like to revisit any time soon @rikbosch or should we close? |
|
Would you like to perhaps take over this, @mariojsnunes? |
|
Yes, I'll look into it towards the end of the week |
|
Superseded by #15753. |
Fixes #12639
This PR introduces a
BlobFileStoreFactorywhich is used by theOrchardCore.Shells.AzureandOrchardCore.Media.Azuremodule.It allows to specify a reference to a configured
BlobServiceClientthrough the Microsoft.Extensions.Azure nuget package.see https://learn.microsoft.com/en-us/dotnet/azure/sdk/dependency-injection#configure-multiple-service-clients-with-different-names about configuring multiple blob clients and also: https://devblogs.microsoft.com/azure-sdk/best-practices-for-using-azure-sdk-with-asp-net-core/ for best-practices
for example:
program.csappsettings.json{ "OrchardCore": { "OrchardCore_Shells_Azure": { "BlobServiceName": "PrivateStorage", //<<< ! this is where the magic happens "ContainerName": "a-container-name", "BasePath": "shells" } } }