Azure Blob Storage Databus Managed Identity documentation (#6641)

* Azure Blob Storage Databus Managed Identity documentation * Apply suggestions from code review
Particular · May 24, 2024 · 364336d · 364336d
1 parent 6685b93
commit 364336d
Show file tree

Hide file tree

Showing 8 changed files with 109 additions and 0 deletions.
diff --git a/Snippets/ABSDataBus/ABSDataBus_4/ABSDataBus_4.csproj b/Snippets/ABSDataBus/ABSDataBus_4/ABSDataBus_4.csproj
@@ -3,6 +3,9 @@
     <TargetFramework>net48</TargetFramework>
   </PropertyGroup>
   <ItemGroup>
+    <PackageReference Include="Azure.Identity" Version="1.*" />
+    <PackageReference Include="Microsoft.Extensions.Azure" Version="1.*" />
+    <PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" Version="8.*" />
     <PackageReference Include="NServiceBus.DataBus.AzureBlobStorage" Version="4.*" />
   </ItemGroup>
 </Project>
diff --git a/Snippets/ABSDataBus/ABSDataBus_4/Usage.cs b/Snippets/ABSDataBus/ABSDataBus_4/Usage.cs
@@ -1,5 +1,9 @@
 using System;
+using Azure.Identity;
 using Azure.Storage.Blobs;
+using Microsoft.Extensions.Azure;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Hosting;
 using NServiceBus;
 using NServiceBus.DataBus.AzureBlobStorage;
 
@@ -37,6 +41,28 @@ class Usage
         #endregion
     }
 
+    void UsageManagedIdentity(EndpointConfiguration endpointConfiguration, IHostApplicationBuilder builder)
+    {
+        #region AzureDataBusManagedIdentityServiceClient
+
+        var serviceClient = new BlobServiceClient(new Uri("https://<account-name>.blob.core.windows.net"), new DefaultAzureCredential());
+        endpointConfiguration.UseDataBus<AzureDataBus>()
+            .UseBlobServiceClient(serviceClient);
+
+        #endregion
+
+        #region AzureDataBusManagedIdentityExtensions
+
+        builder.Services.AddAzureClients(azureClients =>
+        {
+            azureClients.AddBlobServiceClient(new Uri("https://<account-name>.blob.core.windows.net"));
+            azureClients.UseCredential(new DefaultAzureCredential());
+        });
+        builder.Services.AddSingleton<IProvideBlobServiceClient, CustomProvider>();
+
+        #endregion
+    }
+
     #region CustomBlobServiceClientProvider
 
     public class CustomProvider : IProvideBlobServiceClient

diff --git a/Snippets/ABSDataBus/ABSDataBus_5/ABSDataBus_5.csproj b/Snippets/ABSDataBus/ABSDataBus_5/ABSDataBus_5.csproj
@@ -4,5 +4,8 @@
   </PropertyGroup>
   <ItemGroup>
     <PackageReference Include="NServiceBus.DataBus.AzureBlobStorage" Version="5.*" />
+    <PackageReference Include="Azure.Identity" Version="1.*" />
+    <PackageReference Include="Microsoft.Extensions.Azure" Version="1.*" />
+    <PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" Version="8.*" />
   </ItemGroup>
 </Project>
diff --git a/Snippets/ABSDataBus/ABSDataBus_5/Usage.cs b/Snippets/ABSDataBus/ABSDataBus_5/Usage.cs
@@ -3,6 +3,9 @@
 using NServiceBus;
 using NServiceBus.DataBus.AzureBlobStorage;
 using System;
+using Azure.Identity;
+using Microsoft.Extensions.Azure;
+using Microsoft.Extensions.Hosting;
 
 class Usage
 {
@@ -38,6 +41,28 @@ class Usage
         #endregion
     }
 
+    void UsageManagedIdentity(EndpointConfiguration endpointConfiguration, IHostApplicationBuilder builder)
+    {
+        #region AzureDataBusManagedIdentityServiceClient
+
+        var serviceClient = new BlobServiceClient(new Uri("https://<account-name>.blob.core.windows.net"), new DefaultAzureCredential());
+        endpointConfiguration.UseDataBus<AzureDataBus, SystemJsonDataBusSerializer>()
+                             .UseBlobServiceClient(serviceClient);
+
+        #endregion
+
+        #region AzureDataBusManagedIdentityExtensions
+
+        builder.Services.AddAzureClients(azureClients =>
+        {
+            azureClients.AddBlobServiceClient(new Uri("https://<account-name>.blob.core.windows.net"));
+            azureClients.UseCredential(new DefaultAzureCredential());
+        });
+        builder.Services.AddSingleton<IProvideBlobServiceClient, CustomProvider>();
+
+        #endregion
+    }
+
     #region CustomBlobServiceClientProvider
 
     public class CustomProvider : IProvideBlobServiceClient

diff --git a/Snippets/ABSDataBus/ABSDataBus_6/ABSDataBus_6.csproj b/Snippets/ABSDataBus/ABSDataBus_6/ABSDataBus_6.csproj
@@ -3,6 +3,9 @@
     <TargetFramework>net8.0</TargetFramework>
   </PropertyGroup>
   <ItemGroup>
+    <PackageReference Include="Azure.Identity" Version="1.*" />
+    <PackageReference Include="Microsoft.Extensions.Azure" Version="1.*" />
+    <PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" Version="8.*" />
     <PackageReference Include="NServiceBus.DataBus.AzureBlobStorage" Version="6.*" />
   </ItemGroup>
 </Project>
diff --git a/Snippets/ABSDataBus/ABSDataBus_6/Usage.cs b/Snippets/ABSDataBus/ABSDataBus_6/Usage.cs
@@ -3,6 +3,9 @@
 using NServiceBus;
 using NServiceBus.DataBus.AzureBlobStorage;
 using System;
+using Azure.Identity;
+using Microsoft.Extensions.Azure;
+using Microsoft.Extensions.Hosting;
 
 class Usage
 {
@@ -38,6 +41,28 @@ class Usage
         #endregion
     }
 
+    void UsageManagedIdentity(EndpointConfiguration endpointConfiguration, IHostApplicationBuilder builder)
+    {
+        #region AzureDataBusManagedIdentityServiceClient
+
+        var serviceClient = new BlobServiceClient(new Uri("https://<account-name>.blob.core.windows.net"), new DefaultAzureCredential());
+        endpointConfiguration.UseDataBus<AzureDataBus, SystemJsonDataBusSerializer>()
+                             .UseBlobServiceClient(serviceClient);
+
+        #endregion
+
+        #region AzureDataBusManagedIdentityExtensions
+
+        builder.Services.AddAzureClients(azureClients =>
+        {
+            azureClients.AddBlobServiceClient(new Uri("https://<account-name>.blob.core.windows.net"));
+            azureClients.UseCredential(new DefaultAzureCredential());
+        });
+        builder.Services.AddSingleton<IProvideBlobServiceClient, CustomProvider>();
+
+        #endregion
+    }
+
     #region CustomBlobServiceClientProvider
 
     public class CustomProvider : IProvideBlobServiceClient

diff --git a/...bus/messaging/databus/azure-blob-storage_config_ABSDataBus_[4.0,5.0).partial.md b/...bus/messaging/databus/azure-blob-storage_config_ABSDataBus_[4.0,5.0).partial.md
@@ -24,3 +24,15 @@ snippet: AzureDataBusConnectionAndContainer
 
 > [!NOTE]
 > The container name is optional and will be set to the default when omitted.
+
+#### Token-credentials
+
+Enables usage of Azure Active Directory (AAD) authentication such as [managed identities for Azure resources](https://learn.microsoft.com/en-us/azure/storage/blobs/authorize-access-azure-active-directory) instead of the shared secret in the connection string.
+
+#### With a preconfigured BlobServiceClient
+
+snippet: AzureDataBusManagedIdentityServiceClient
+
+#### With Microsoft.Extensions.Azure
+
+snippet: AzureDataBusManagedIdentityExtensions
diff --git a/...icebus/messaging/databus/azure-blob-storage_config_ABSDataBus_[5.0,).partial.md b/...icebus/messaging/databus/azure-blob-storage_config_ABSDataBus_[5.0,).partial.md
@@ -24,3 +24,15 @@ snippet: AzureDataBusConnectionAndContainer
 
 > [!NOTE]
 > The container name is optional and will be set to the default when omitted.
+
+#### Token-credentials
+
+Enables usage of Azure Active Directory (AAD) authentication such as [managed identities for Azure resources](https://learn.microsoft.com/en-us/azure/storage/blobs/authorize-access-azure-active-directory) instead of the shared secret in the connection string.
+
+#### With a preconfigured BlobServiceClient
+
+snippet: AzureDataBusManagedIdentityServiceClient
+
+#### With Microsoft.Extensions.Azure
+
+snippet: AzureDataBusManagedIdentityExtensions