DevExpress.AspNetCore.Reporting.Azure 26.1.5

Microsoft Azure Integration for DevExpress ASP.NET Core Reports

This package allows you to cache documents generated with DevExpress ASP.NET Core Reporting in Azure Storage. The Web Document Viewer saves document files in Blob Storage and stores service information in Table Storage. As a result, the Web Document Viewer and Report Designer preview remain available across requests, application restarts, and load-balanced instances. This architecture enables scalable, stateless deployment on Azure App Service, containers, and Linux-based hosts.

Key Features

• Caches generated report documents in Azure Blob Storage and stores Web Document Viewer service data in Azure Table Storage.
• Keeps document state available across requests, application restarts, and load-balanced instances to support stateless, horizontally scaled Azure deployments.
• Provides the UseAzureCachedReportSourceBuilder method to configure the cache for the Web Document Viewer and Report Designer.
• Provisions the required Azure Storage resources through IAzureResourceProvisionService.CreateRequiredResourcesAsync().
• Supports Azure Service Bus for multi-instance synchronization through the UseAzureEnvironment method.

Example: Cache Report Documents in Azure Storage

1. Grant your app's managed identity the Storage Blob Data Contributor and Storage Table Data Contributor roles on the storage account.

2. Configure BlobServiceClient and TableServiceClient and register them in the application's service container. Refer to the following Microsoft article: Use the Azure SDK for .NET in ASP.NET Core apps.

3. Implement services that pass these clients to the Web Document Viewer:

   using Azure.Data.Tables;
   using Azure.Storage.Blobs;
   using DevExpress.XtraReports.Web.Azure;
   
   public class BlobServiceClientProvider(BlobServiceClient client) : IBlobServiceClientProvider {
       public BlobServiceClient GetBlobServiceClient() => client;
   }
   
   public class TableServiceClientProvider(TableServiceClient client) : ITableServiceClientProvider {
       public TableServiceClient GetTableServiceClient() => client;
   }
   

4. Enable the cache and register these services in Program.cs:

   using DevExpress.AspNetCore;
   using DevExpress.AspNetCore.Reporting;
   using DevExpress.AspNetCore.Reporting.Azure;
   using DevExpress.XtraReports.Web.Azure;
   
   var builder = WebApplication.CreateBuilder(args);
   builder.Services.AddDevExpressControls();
   builder.Services.ConfigureReportingServices(configurator => {
       // Cache generated documents in Azure Storage.
       configurator.ConfigureWebDocumentViewer(viewer => viewer.UseAzureCachedReportSourceBuilder());
   });
   // BlobServiceClient and TableServiceClient must already be registered (see step 2).
   // Registered after ConfigureReportingServices, these replace the connection-string providers.
   builder.Services.AddScoped<IBlobServiceClientProvider, BlobServiceClientProvider>();
   builder.Services.AddScoped<ITableServiceClientProvider, TableServiceClientProvider>();
   
   var app = builder.Build();
   app.UseDevExpressControls();
   app.Run();
   

5. Create the required Azure Storage resources — the dxxrreports and dxxrdocuments tables and the dxxrcommonstorage blob container. Call the following code once at application startup:

   // Program.cs
   //...
   using (var scope = app.Services.CreateScope()) {
       var azureResourceInitializer = scope.ServiceProvider.GetService<IAzureResourceProvisionService>();
       azureResourceInitializer.CreateRequiredResourcesAsync().GetAwaiter().GetResult();
   }
   // app.Run();
   

Evaluation Period, Pricing Options, and Licensing Terms

Whether you own a license or want to start a 30-day evaluation, download and register your DevExpress license key. To obtain your key, sign in to the DevExpress Download Manager with an existing DevExpress.com account or create a free account. For key registration instructions, see License Key for DevExpress Products.

If you purchase a license after evaluating a product, re-register your updated DevExpress license key to remove evaluation warnings and messages.

This package is included in the following commercial subscriptions:

• DevExpress Reporting Subscription
• DevExpress ASP.NET Subscription
• DevExpress DXperience Subscription
• DevExpress Universal Subscription

See DevExpress Subscriptions & Licensing for subscription comparison tables, purchasing FAQ, and licensing information.

Related Components/Packages

DevExpress.AspNetCore.Reporting — Web Document Viewer and End-User Report Designer for ASP.NET Core. This package is required — install it alongside DevExpress.AspNetCore.Reporting.Azure.

dotnet add package DevExpress.AspNetCore.Reporting

Documentation

• Microsoft Azure Integration Specifics
• Implement an Azure Storage Cache
• Cloud Integration Overview

Software Bill of Materials (SBOM)

To access SBOM files for DevExpress packages, please refer to the following article: Software Bill of Materials (SBOM) for DevExpress .NET assemblies/NuGet packages, JavaScript, VCL and other redistributable artifacts.

See Also: Information Security | Security - What You Need to Know

Useful Online Resources

• www.devexpress.com
• DevExpress Support Center
• DevExpress Blogs