Audit.NET.AzureStorage 25.0.0

dotnet add package Audit.NET.AzureStorage --version 25.0.0
NuGet\Install-Package Audit.NET.AzureStorage -Version 25.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Audit.NET.AzureStorage" Version="25.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Audit.NET.AzureStorage --version 25.0.0
#r "nuget: Audit.NET.AzureStorage, 25.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Audit.NET.AzureStorage as a Cake Addin
#addin nuget:?package=Audit.NET.AzureStorage&version=25.0.0

// Install Audit.NET.AzureStorage as a Cake Tool
#tool nuget:?package=Audit.NET.AzureStorage&version=25.0.0

Audit.NET.AzureStorage

Azure Blob and Azure Table storage providers for Audit.NET library (An extensible framework to audit executing operations in .NET).

Store the audit events in an Azure Storage container, as Blob files in JSON format, or as rows on an Azure Table.

Install

NuGet Package To install the package run the following command on the Package Manager Console:

PM> Install-Package Audit.NET.AzureStorage

NuGet Status NuGet Count

IMPORTANT NOTES

Warning

This library has been deprecated.

This library uses the legacy client WindowsAzure.Storage package which has been deprecated and split into multiple client libraries (Azure.Storage.Blobs, Azure.Data.Tables, etc).

Suggested Alternatives

Usage

Please see the Audit.NET Readme

Configuration

Set the static Audit.Core.Configuration.DataProvider property to set one of the Azure Storage data providers, or call the UseAzureBlobStorage()/UseAzureTableStorage() methods on the fluent configuration. This should be done before any AuditScope creation, i.e. during application startup.

1- Azure Blob Storage

Stores each audit event as a BLOB file with the JSON representation of the Audit Event.

Configuration examples

Using a connection string:

Audit.Core.Configuration.Setup()
    .UseAzureBlobStorage(config => config
        .ConnectionString("DefaultEndpointsProtocol=https;AccountName=your account;AccountKey=your key")
        .ContainerName("event")
        .BlobName(ev => $"{ev.StartDate:yyyy-MM}/{ev.Environment.UserName}/{Guid.NewGuid()}.json")
        .WithAccessTier(StandardBlobTier.Cool)
        .WithMetadata(ev => new Dictionary<string, string>() { { "user", ev.Environment.UserName } }));

Using Azure Active Directory (authentication token):

Audit.Core.Configuration.Setup()
    .UseAzureBlobStorage(config => config
        .AzureActiveDirectory(adConfig => adConfig
            .AccountName("your account")
            .TenantId("your tenant ID"))
        .ContainerName("event")
        .BlobName(ev => $"{Guid.NewGuid()}.json"));
Provider Options
Authentication options

Depending on the authentication method, you can call one of the following two methods:

  • ConnectionString: To use Account Access Key or SAS authentication via an Azure Storage connection string.
  • AzureActiveDirectory: To use Azure Active Directory authentication via access tokens acquired automatically.
AzureActiveDirectory configuration

When using Azure Active Directory authentication you can provide the following configuration to AzureActiveDirectory() method:

  • AccountName: The Account Name of your Azure Storage.

  • TenantId: The Tenant ID, this is your Azure Active Directory ID. See How to get it.

  • AuthConnectionString: (Optional) Specifies a custom connection string for the Token Provider. Check this for more information.

  • ResouceUrl: (Optional) Specifies a custom resource URL to acquire the tokens for. By default the Azure Storage resource ID https://storage.azure.com/ is used.

  • EndpointSuffix: (Optional) Specifies a custom DNS endpoint suffix to use for the storage services. Default is core.windows.net.

  • UseHttps: (Optional) Specifies whether to use HTTPS to connect to storage service endpoints. Default is true.

Container options
  • ContainerName/ContainerNameBuilder: The container name to use (see the naming restrictions here). By default, "event" is used as the container name.
  • BlobName: A function that takes an Audit Event and returns a unique blob name for the event. The resulting name can include path information (slash separated sub-folders). By default, a random Guid is used as the blob name.
  • WithAccessTier: (optional) A function that takes an Audit Event and returns the Standard BLOB Access Tier to set after the blob upload. Note that using this setting implies that each upload will require two calls: one to upload the blob, and another one to set the access tier.
  • WithMetadata: (optional) A function that takes an Audit Event and returns a set of key-value pairs to be associated with the blob storage resource.
Query events

This provider implements GetEvent and GetEventAsync methods to obtain an audit event by id:

var event = blobDataProvider.GetEvent("eventId");

2- Azure Table Storage

Stores each audit event as a new row on an Azure Table, allowing to dynamically configure the columns.

Configuration example:

Audit.Core.Configuration.DataProvider = new AzureTableDataProvider()
{
    ConnectionString = "DefaultEndpointsProtocol=https;AccountName=your account;AccountKey=your key",
    TableName = "Events",
    TableEntityMapper = ev => new AuditEventTableEntity(ev)
};

Or by using the fluent configuration API via UseAzureTableStorage method:

Audit.Core.Configuration.Setup()
    .UseAzureTableStorage(_ => _
        .ConnectionString("DefaultEndpointsProtocol=https;AccountName=your account;AccountKey=your key")
        .TableName("Events")
        .EntityMapper(ev => new AuditEventTableEntity(ev)));

You can set the entity mapper to return any class implementing ITableEntity, as the provided default AuditEventTableEntity.

As an alternative, you can use EntityBuilder() method to configure the columns mapping:

Audit.Core.Configuration.Setup()
    .UseAzureTableStorage(_ => _
        .ConnectionString("DefaultEndpointsProtocol=https;AccountName=your account;AccountKey=your key")
        .TableName("Events")
        .EntityBuilder(e => e
            .PartitionKey(ev => $"Events{ev.StartDate:yyyyMM}")
            .RowKey(ev => Guid.NewGuid().ToString())
            .Columns(c => c.FromObject(ev => new { Date = ev.StartDate, AuditEventJson = ev.ToJson() }))));
Provider Options

Mandatory:

  • ConnectionString/ConnectionStringBuilder: The Azure Storage connection string.

Optional:

  • TableName: The table name to use. By default, "event" is used as the table name.
  • EntityMapper: A function that defines a mapping from an Audit Event to a Table Entity.
  • EntityBuilder: An alternative way to dynamically specify the table entity mapping for audit events:
    • PartitionKey: A function of the audit event that returns the partition key to use.
    • RowKey: A function of the audit event that returns the row key to use.
    • Columns: Provides a way to generate the extra columns from an anonymous object or a dictionary.
Query events

The Azure Table data provider does not implements GetEvent nor GetEventAsync methods.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
25.0.0 67 2/16/2024
24.0.1 85 2/12/2024
24.0.0 63 2/12/2024
23.0.0 1,317 12/14/2023
22.1.0 104 12/9/2023
22.0.2 155 12/1/2023
22.0.1 620 11/16/2023
22.0.0 90 11/14/2023
21.1.0 290 10/9/2023
21.0.4 151 9/15/2023
21.0.3 2,744 7/9/2023
21.0.2 158 7/6/2023
21.0.1 767 5/27/2023
21.0.0 999 4/15/2023
20.2.4 344 3/27/2023
20.2.3 253 3/17/2023
20.2.2 231 3/14/2023
20.2.1 243 3/11/2023
20.2.0 802 3/7/2023
20.1.6 272 2/23/2023
20.1.5 4,507 2/9/2023
20.1.4 1,750 1/28/2023
20.1.3 707 12/21/2022
20.1.2 409 12/14/2022
20.1.1 320 12/12/2022
20.1.0 500 12/4/2022
20.0.4 381 11/30/2022
20.0.3 1,664 10/28/2022
20.0.2 452 10/26/2022
20.0.1 488 10/21/2022
20.0.0 578 10/1/2022
19.4.1 901 9/10/2022
19.4.0 2,355 9/2/2022
19.3.0 841 8/23/2022
19.2.2 501 8/11/2022
19.2.1 503 8/6/2022
19.2.0 642 7/24/2022
19.1.4 10,563 5/23/2022
19.1.3 522 5/22/2022
19.1.2 620 5/18/2022
19.1.1 9,816 4/28/2022
19.1.0 19,098 4/10/2022
19.0.7 5,059 3/13/2022
19.0.6 624 3/7/2022
19.0.5 2,500 1/28/2022
19.0.4 878 1/23/2022
19.0.3 14,396 12/14/2021
19.0.2 400 12/11/2021
19.0.1 1,774 11/20/2021
19.0.0 751 11/11/2021
19.0.0-rc.net60.2 156 9/26/2021
19.0.0-rc.net60.1 205 9/16/2021
18.1.6 4,585 9/26/2021
18.1.5 3,702 9/7/2021
18.1.4 500 9/6/2021
18.1.3 3,529 8/19/2021
18.1.2 9,926 8/8/2021
18.1.1 2,233 8/5/2021
18.1.0 600 8/1/2021
18.0.1 496 7/30/2021
18.0.0 957 7/26/2021
17.0.8 781 7/7/2021
17.0.7 2,032 6/16/2021
17.0.6 523 6/5/2021
17.0.5 915 5/28/2021
17.0.4 7,390 5/4/2021
17.0.3 500 5/1/2021
17.0.2 1,482 4/22/2021
17.0.1 4,182 4/18/2021
17.0.0 3,227 3/26/2021
16.5.6 533 3/25/2021
16.5.5 508 3/23/2021
16.5.4 1,813 3/9/2021
16.5.3 682 2/26/2021
16.5.2 524 2/23/2021
16.5.1 1,041 2/21/2021
16.5.0 559 2/17/2021
16.4.5 510 2/15/2021
16.4.4 2,867 2/5/2021
16.4.3 1,233 1/27/2021
16.4.2 538 1/22/2021
16.4.1 558 1/21/2021
16.4.0 999 1/11/2021
16.3.3 582 1/8/2021
16.3.2 582 1/3/2021
16.3.1 578 12/31/2020
16.3.0 533 12/30/2020
16.2.1 3,616 12/27/2020
16.2.0 8,292 10/13/2020
16.1.5 637 10/4/2020
16.1.4 888 9/17/2020
16.1.3 1,397 9/13/2020
16.1.2 619 9/9/2020
16.1.1 680 9/3/2020
16.1.0 4,567 8/19/2020
16.0.3 699 8/15/2020
16.0.2 1,040 8/9/2020
16.0.1 704 8/8/2020
16.0.0 580 8/7/2020
15.3.0 3,723 7/23/2020
15.2.3 950 7/14/2020
15.2.2 11,163 5/19/2020
15.2.1 1,208 5/12/2020
15.2.0 651 5/9/2020
15.1.1 2,053 5/4/2020
15.1.0 5,421 4/13/2020
15.0.5 8,213 3/18/2020
15.0.4 2,516 2/28/2020
15.0.3 786 2/26/2020
15.0.2 5,735 1/20/2020
15.0.1 16,696 1/10/2020
15.0.0 930 12/17/2019
14.9.1 1,038 11/30/2019
14.9.0 665 11/29/2019
14.8.1 702 11/26/2019
14.8.0 688 11/20/2019
14.7.0 2,987 10/9/2019
14.6.6 718 10/8/2019
14.6.5 1,444 9/27/2019
14.6.4 882 9/21/2019
14.6.3 960 8/12/2019
14.6.2 741 8/3/2019
14.6.1 739 8/3/2019
14.6.0 744 7/26/2019
14.5.7 1,122 7/18/2019
14.5.6 854 7/10/2019
14.5.5 769 7/1/2019
14.5.4 718 6/17/2019
14.5.3 724 6/5/2019
14.5.2 752 5/30/2019
14.5.1 989 5/28/2019
14.5.0 919 5/24/2019
14.4.0 1,276 5/22/2019
14.3.4 782 5/14/2019
14.3.3 969 5/9/2019
14.3.2 806 4/30/2019
14.3.1 748 4/27/2019
14.3.0 772 4/24/2019
14.2.3 775 4/17/2019
14.2.2 778 4/10/2019
14.2.1 748 4/5/2019
14.2.0 16,162 3/16/2019
14.1.1 1,158 3/8/2019
14.1.0 1,047 2/11/2019
14.0.4 1,080 1/31/2019
14.0.3 1,333 1/22/2019
14.0.2 904 12/15/2018
14.0.1 1,649 11/29/2018
14.0.0 953 11/19/2018
13.3.0 926 11/16/2018
13.2.2 911 11/15/2018
13.2.1 926 11/13/2018
13.2.0 944 10/31/2018
13.1.5 912 10/31/2018
13.1.4 948 10/25/2018
13.1.3 987 10/18/2018
13.1.2 1,129 9/12/2018
13.1.1 968 9/11/2018
13.1.0 973 9/11/2018
13.0.0 1,704 8/29/2018
12.3.6 992 8/29/2018
12.3.5 1,088 8/22/2018
12.3.4 1,031 8/21/2018
12.3.3 25,737 8/21/2018
12.3.2 1,023 8/20/2018
12.3.1 1,031 8/20/2018
12.3.0 1,033 8/20/2018
12.2.2 1,092 8/15/2018
12.2.1 1,084 8/9/2018
12.2.0 1,086 8/8/2018
12.1.11 1,057 7/30/2018
12.1.10 1,051 7/20/2018
12.1.9 1,277 7/10/2018
12.1.8 1,126 7/2/2018
12.1.7 4,956 6/7/2018
12.1.6 1,216 6/4/2018
12.1.5 1,157 6/2/2018
12.1.4 1,092 5/25/2018
12.1.3 1,300 5/16/2018
12.1.2 1,129 5/15/2018
12.1.1 1,245 5/14/2018
12.1.0 1,201 5/9/2018
12.0.7 1,266 5/5/2018
12.0.6 1,140 5/4/2018
12.0.5 1,233 5/3/2018
12.0.4 1,302 4/30/2018
12.0.3 1,291 4/30/2018
12.0.2 1,261 4/27/2018
12.0.1 1,170 4/25/2018
12.0.0 1,148 4/22/2018
11.2.0 1,631 4/11/2018
11.1.0 1,137 4/8/2018
11.0.8 1,223 3/26/2018
11.0.7 1,227 3/20/2018
11.0.6 1,257 3/7/2018
11.0.5 1,090 2/22/2018
11.0.4 1,246 2/14/2018
11.0.3 1,186 2/12/2018
11.0.2 1,140 2/9/2018
11.0.1 1,233 1/29/2018
11.0.0 1,222 1/15/2018
10.0.3 1,269 12/29/2017
10.0.2 1,211 12/26/2017
10.0.1 1,227 12/18/2017
10.0.0 1,137 12/18/2017
9.3.0 1,307 12/17/2017
9.2.0 1,230 12/17/2017
9.1.3 11,473 12/5/2017
9.1.2 1,354 11/27/2017
9.1.1 1,212 11/21/2017
9.1.0 1,132 11/21/2017
9.0.1 1,192 11/11/2017
9.0.0 1,178 11/10/2017
8.7.0 1,185 11/9/2017
8.6.0 1,187 11/9/2017
8.5.0 2,022 10/3/2017
8.4.0 1,192 10/3/2017
8.3.1 1,519 9/8/2017
8.3.0 1,231 9/8/2017
8.2.0 1,223 9/4/2017
8.1.0 1,219 8/22/2017
8.0.0 5,911 8/19/2017
7.1.3 1,158 8/14/2017
7.1.2 1,155 8/2/2017
7.1.1 1,240 7/26/2017
7.1.0 1,272 7/5/2017
7.0.9 1,188 6/28/2017
7.0.8 1,208 6/19/2017
7.0.6 1,248 4/7/2017
7.0.5 1,218 3/21/2017
7.0.4 1,242 3/21/2017
7.0.3 1,257 3/20/2017
7.0.2 1,231 3/13/2017
7.0.0 1,257 3/1/2017
6.2.0 1,322 2/25/2017
6.1.0 1,220 2/14/2017
6.0.0 1,273 2/9/2017
5.3.0 1,246 2/5/2017
5.2.0 1,397 1/26/2017
5.1.0 1,208 1/19/2017
5.0.0 1,168 1/7/2017
4.11.0 1,243 1/5/2017
4.10.0 1,189 12/31/2016
4.9.0 1,202 12/26/2016
4.8.0 1,273 12/17/2016
4.7.0 1,229 12/8/2016
4.6.5 1,167 12/4/2016
4.6.4 1,211 11/25/2016
4.6.2 1,202 11/18/2016
4.6.1 1,187 11/15/2016
4.6.0 1,215 11/11/2016
4.5.9 1,522 11/2/2016
4.5.8 1,266 11/2/2016
4.5.7 1,193 10/26/2016
4.5.6 1,208 10/6/2016
4.5.5 1,233 10/3/2016
4.5.4 1,165 10/2/2016
4.5.3 1,170 9/30/2016
4.5.2 1,208 9/28/2016
4.5.1 1,174 9/28/2016
4.5.0 1,157 9/28/2016
4.4.0 1,406 9/23/2016
4.3.0 1,350 9/22/2016