NetEvolve.HealthChecks.Azure.Blobs
4.0.67
dotnet add package NetEvolve.HealthChecks.Azure.Blobs --version 4.0.67
NuGet\Install-Package NetEvolve.HealthChecks.Azure.Blobs -Version 4.0.67
<PackageReference Include="NetEvolve.HealthChecks.Azure.Blobs" Version="4.0.67" />
paket add NetEvolve.HealthChecks.Azure.Blobs --version 4.0.67
#r "nuget: NetEvolve.HealthChecks.Azure.Blobs, 4.0.67"
// Install NetEvolve.HealthChecks.Azure.Blobs as a Cake Addin #addin nuget:?package=NetEvolve.HealthChecks.Azure.Blobs&version=4.0.67 // Install NetEvolve.HealthChecks.Azure.Blobs as a Cake Tool #tool nuget:?package=NetEvolve.HealthChecks.Azure.Blobs&version=4.0.67
NetEvolve.HealthChecks.Azure.Blobs
This package provides a health check for Azure Blobs, based on the Azure.Storage.Blobs package. The main purpose is to check that the Azure Blob Service and the Storage Container is reachable and that the client can connect to it.
💡 This package is available for .NET 6.0 and later.
Installation
To use this package, you need to add the package to your project. You can do this by using the NuGet package manager or by using the dotnet CLI.
dotnet add package NetEvolve.HealthChecks.Azure.Blobs
Health Check - Azure Blob Container Availability
The health check is a liveness check. It will check that the Azure Blob Service and the Storage Container is reachable and that the client can connect to it. If the service or the container needs longer than the configured timeout to respond, the health check will return Degraded. If the service or the container is not reachable, the health check will return Unhealthy.
Usage
After adding the package, yo need to import the namespace NetEvolve.HealthChecks.Azure.Blobs and add the health check to the service collection.
using NetEvolve.HealthChecks.Azure.Blobs;
Therefor you can use two different approaches. In both approaches you have to provide a name for the health check.
Parameters
name: The name of the health check. The name is used to identify the configuration object. It is required and must be unique within the application.options: The configuration options for the health check. If you don't provide any options, the health check will use the configuration based approach.tags: The tags for the health check. The tagsazure,storageandblobare always used as default and combined with the user input. You can provide additional tags to group or filter the health checks.
Variant 1: Configuration based
The first one is to use the configuration based approach. Therefor you have to add the configuration section HealthChecks:AzureBlobContainer to your appsettings.json file.
var builder = services.AddHealthChecks();
builder.AddAzureBlobContainer("<name>");
The configuration looks like this:
{
..., // other configuration
"HealthChecks": {
"AzureBlobContainer": {
"<name>": {
"ConnectionString": "<connection-string>", // required
"ContainerName": "<container-name>", // required
..., // other configuration
"Timeout": "<timeout>" // optional, default is 100 milliseconds
}
}
}
}
Variant 2: Options based
The second one is to use the options based approach. Therefor you have to create an instance of AzureBlobContainerOptions and provide the configuration.
var builder = services.AddHealthChecks();
builder.AddAzureBlobContainer("<name>", options =>
{
options.ConnectionString = "<connection-string>";
options.ContainerName = "<container-name>";
...
options.Timeout = "<timeout>";
});
💡 You can always provide tags to all health checks, for grouping or filtering.
var builder = services.AddHealthChecks();
builder.AddKafka("<name>", options => ..., "azure");
| Product | Versions 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. |
-
net8.0
- Azure.Identity (>= 1.13.1)
- Azure.Storage.Blobs (>= 12.23.0)
- NetEvolve.Arguments (>= 1.2.168)
- NetEvolve.Extensions.Tasks (>= 1.2.188)
- NetEvolve.HealthChecks.Abstractions (>= 4.0.67)
- System.Text.Json (>= 9.0.0)
-
net9.0
- Azure.Identity (>= 1.13.1)
- Azure.Storage.Blobs (>= 12.23.0)
- NetEvolve.Arguments (>= 1.2.168)
- NetEvolve.Extensions.Tasks (>= 1.2.188)
- NetEvolve.HealthChecks.Abstractions (>= 4.0.67)
- System.Text.Json (>= 9.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.