Table of Contents

Orleans.Lattice.Backup.AzureBlob API reference

The package has two public types: the options class and the registration extension. The sink implementation itself is internal and is reached only through the core ILatticeBackupSink seam; its behaviour is described in Architecture.

LatticeBackupAzureBlobServiceCollectionExtensions

Static extension method on ISiloBuilder.

  • ISiloBuilder AddLatticeBackupAzureBlob(this ISiloBuilder builder, Action<LatticeBackupAzureBlobOptions> configure)

    Registers the Azure Blob Storage sink as the silo's ILatticeBackupSink, replacing the in-cluster default that AddLatticeBackup installs. It may be called before or after AddLatticeBackup because it replaces the sink registration outright. A repeat call re-registers the sink and adds its configure delegate after the earlier ones - every delegate runs, in registration order - so a later call overrides only the properties it sets; setting a second authentication mode on top of an earlier one is rejected at validation. The container client is built once, from the populated authentication mode, when the sink is first resolved. Throws ArgumentNullException when builder or configure is null.

LatticeBackupAzureBlobOptions

Configuration for the Azure Blob Storage sink. Exactly one authentication mode must be configured; see Configuration for the full property table, defaults, and mode rules. In summary:

  • const string DefaultContainerName = "orleans-lattice-backup" - the default container name.
  • string? ConnectionString - storage-account connection string.
  • Uri? ServiceUri - blob-service endpoint URI, paired with one credential below.
  • Azure.Core.TokenCredential? TokenCredential - Azure AD credential used with ServiceUri.
  • Azure.Storage.StorageSharedKeyCredential? SharedKeyCredential - shared-key credential used with ServiceUri.
  • Azure.Storage.Blobs.BlobServiceClient? ServiceClient - a pre-built service client used verbatim.
  • string ContainerName - the container that backs the sink (default DefaultContainerName).
  • Action<Azure.Storage.Blobs.BlobClientOptions>? ConfigureClientOptions - optional callback to customise the client options the sink builds (ignored when ServiceClient is supplied).

The options type also carries internal validation and client-construction helpers that the registration invokes; these are not part of the public surface.