Microsoft.Extensions.Compliance.Abstractions 9.0.0-preview.5.24311.7

Prefix Reserved
This is a prerelease version of Microsoft.Extensions.Compliance.Abstractions.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Microsoft.Extensions.Compliance.Abstractions --version 9.0.0-preview.5.24311.7                
NuGet\Install-Package Microsoft.Extensions.Compliance.Abstractions -Version 9.0.0-preview.5.24311.7                
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="Microsoft.Extensions.Compliance.Abstractions" Version="9.0.0-preview.5.24311.7" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Microsoft.Extensions.Compliance.Abstractions --version 9.0.0-preview.5.24311.7                
#r "nuget: Microsoft.Extensions.Compliance.Abstractions, 9.0.0-preview.5.24311.7"                
#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 Microsoft.Extensions.Compliance.Abstractions as a Cake Addin
#addin nuget:?package=Microsoft.Extensions.Compliance.Abstractions&version=9.0.0-preview.5.24311.7&prerelease

// Install Microsoft.Extensions.Compliance.Abstractions as a Cake Tool
#tool nuget:?package=Microsoft.Extensions.Compliance.Abstractions&version=9.0.0-preview.5.24311.7&prerelease                

Microsoft.Extensions.Compliance.Abstractions

This package introduces data classification and data redaction features.

Install the package

From the command-line:

dotnet add package Microsoft.Extensions.Compliance.Abstractions

Or directly in the C# project file:

<ItemGroup>
  <PackageReference Include="Microsoft.Extensions.Compliance.Abstractions" Version="[CURRENTVERSION]" />
</ItemGroup>

Usage Example

Implementing Redactors

Redactors can be implemented by inheriting from Microsoft.Extensions.Compliance.Redaction.Redactor. For example:

using Microsoft.Extensions.Compliance.Redaction;

public class StarRedactor : Redactor
{
    private const string Stars = "****";

    public override int GetRedactedLength(ReadOnlySpan<char> input) => Stars.Length;

    public override int Redact(ReadOnlySpan<char> source, Span<char> destination)
    {
        Stars.CopyTo(destination);
        return Stars.Length;
    }
}

Implementing Redactor Providers

Redactor Providers implement Microsoft.Extensions.Compliance.Redaction.IRedactorProvider. For example:

using Microsoft.Extensions.Compliance.Classification;
using Microsoft.Extensions.Compliance.Redaction;

public sealed class StarRedactorProvider : IRedactorProvider
{
    private static readonly StarRedactor _starRedactor = new();

    public static StarRedactorProvider Instance { get; } = new();

    public Redactor GetRedactor(DataClassificationSet classifications) => _starRedactor;
}

Feedback & Contributing

We welcome feedback and contributions in our GitHub repo.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  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.  net9.0 is compatible. 
.NET Framework net462 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (7)

Showing the top 5 NuGet packages that depend on Microsoft.Extensions.Compliance.Abstractions:

Package Downloads
Microsoft.Extensions.Telemetry.Abstractions

Common abstractions for high-level telemetry primitives.

Microsoft.Extensions.Compliance.Redaction

Redaction engine and canonical redactors.

Microsoft.AspNetCore.Diagnostics.Middleware

ASP.NET Core middleware for collecting high-quality telemetry.

Microsoft.Extensions.Compliance.Testing

Implementation of data classification and redaction designed for testing.

Serilog.Redaction

Serilog Redaction library for Microsoft.Extensions.Compliance.Redaction

GitHub repositories

This package is not used by any popular GitHub repositories.