DotNetDiag.HealthChecks.AzureDigitalTwin
10.0.16
dotnet add package DotNetDiag.HealthChecks.AzureDigitalTwin --version 10.0.16
NuGet\Install-Package DotNetDiag.HealthChecks.AzureDigitalTwin -Version 10.0.16
<PackageReference Include="DotNetDiag.HealthChecks.AzureDigitalTwin" Version="10.0.16" />
<PackageVersion Include="DotNetDiag.HealthChecks.AzureDigitalTwin" Version="10.0.16" />
<PackageReference Include="DotNetDiag.HealthChecks.AzureDigitalTwin" />
paket add DotNetDiag.HealthChecks.AzureDigitalTwin --version 10.0.16
#r "nuget: DotNetDiag.HealthChecks.AzureDigitalTwin, 10.0.16"
#:package DotNetDiag.HealthChecks.AzureDigitalTwin@10.0.16
#addin nuget:?package=DotNetDiag.HealthChecks.AzureDigitalTwin&version=10.0.16
#tool nuget:?package=DotNetDiag.HealthChecks.AzureDigitalTwin&version=10.0.16
Digital Twin Health Check
Azure Digital Twins is an Internet of Things (IoT) platform that enables you to create a digital representation of real-world things, places, business processes, and people.
For more information about Azure Digital Twin please check Azure Digital Twin Home
This health check can check the Digital Twin:
- liveness connection status.
- state of the model definition
- status of an instance
With all of the following examples, you can additionally add the following parameters:
name: The health check name. <br/>Default for liveness if not specified isazuredigitaltwin. <br/>Default for model state if not specified isazuredigitaltwinmodels. <br/>Default for instance status if not specified isazuredigitaltwininstance.failureStatus: TheHealthStatusthat should be reported when the health check fails. Default isHealthStatus.Unhealthy.tags: A list of tags that can be used to filter sets of health checks.timeout: ASystem.TimeSpanrepresenting the timeout of the check.
How to install
You can download the latest version from nuget packages:
Through Visual Studio:
Install-Package DotNetDiag.HealthChecks.AzureDigitalTwin
Or through CLI:
dotnet add package DotNetDiag.HealthChecks.AzureDigitalTwin
Digital Twin Liveness Health Check
This health check reads a specified Azure Digital Twins resource through Azure Resource Manager to verify authentication, connectivity, and access to that resource. The credential needs permission to read the resource, for example the Reader role assigned at the resource scope. This check does not verify model or twin instance availability at the data plane endpoint; use the model or instance health check for those checks.
Pass the full Azure resource ID in this format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}.
Example Usage
You can add health check with the default client arguments...
using Microsoft.Extensions.DependencyInjection;
public void ConfigureServices(IServiceCollection services)
{
services
.AddHealthChecks()
.AddAzureDigitalTwin(
"MyDigitalTwinClientId",
"MyDigitalTwinClientSecret",
"TenantId",
"/subscriptions/my-subscription-id/resourceGroups/my-resource-group/providers/Microsoft.DigitalTwins/digitalTwinsInstances/my-digital-twins");
}
... or with an Azure SDK TokenCredential, such as DefaultAzureCredential:
using Azure.Core;
using Azure.Identity;
using Microsoft.Extensions.DependencyInjection;
public void ConfigureServices(IServiceCollection services)
{
TokenCredential credentials = new DefaultAzureCredential();
services
.AddHealthChecks()
.AddAzureDigitalTwin(
credentials,
"/subscriptions/my-subscription-id/resourceGroups/my-resource-group/providers/Microsoft.DigitalTwins/digitalTwinsInstances/my-digital-twins");
}
Migration from the legacy management SDK
The liveness check now uses Azure.ResourceManager.DigitalTwins instead of Microsoft.Azure.Management.DigitalTwins and the Fluent resource management SDK. It reads a specified resource instead of listing the provider's supported operations. Both AddAzureDigitalTwin overloads and the AzureDigitalTwinSubscriptionHealthCheck constructors now require a resourceId. The clientId, clientSecret, and tenantId registration remains available with this additional argument.
This is a breaking API change: ServiceClientCredentials overloads and the protected ServiceClientCredentials field have been removed. Pass an Azure.Core.TokenCredential instead; for service principals, use new ClientSecretCredential(tenantId, clientId, clientSecret). For custom derived health checks, the protected ManagementClientConnections dictionary now stores Azure.ResourceManager.ArmClient values, and CreateManagementClient() returns ArmClient.
Digital Twin Model Health Check
This health check receives a list of models ids, and check if the Digital Twin has all models match with them.
If the health check detect an out of sync models return the data with those elements:
unregistered: those models that exist in model definition but not in the Digital Twin
Example Usage
<br/>C# Configuration:
You can also add health check with the default client arguments...
using Microsoft.Extensions.DependencyInjection;
public void ConfigureServices(IServiceCollection services)
{
services
.AddHealthChecks()
.AddAzureDigitalTwinModels(
"MyDigitalTwinClientId",
"MyDigitalTwinClientSecret",
"TenantId",
"https://my-awesome-dt-host",
["my:dt:definition_a;1", "my:dt:definition_b;1", "my:dt:definition_c;1"]);
}
... or with the token credentials flow that you want:
using Azure.Core;
using Azure.Identity;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Diagnostics.HealthChecks;
public void ConfigureServices(IServiceCollection services)
{
TokenCredential credentials = new DefaultAzureCredential();
services
.AddHealthChecks()
.AddAzureDigitalTwinModels(
credentials,
"https://my-awesome-dt-host",
["my:dt:definition_a;1", "my:dt:definition_b;1", "my:dt:definition_c;1"],
failureStatus: HealthStatus.Degraded);
}
<small>NOTE: This sample provides a Degraded status if this Health Check fails because it will check for a non sync model state (instead of a real connection status), and the resource is responding at the client call.</small>
<br/>Failure status response:
azuredigitaltwinmodels:
{
data:
{
unregistered: [ "my:dt:definition_b;1" ]
},
description: "The digital twin is out of sync with the models provided",
duration: "00:00:17.6056085",
exception: null,
status: 1,
tags: [ "ready" ]
}
Digital Twin Instance Health Check
This health check returns the status of a given instance.
Example Usage
<br/>C# Configuration:
You can also add health check with the default client arguments...
using Microsoft.Extensions.DependencyInjection;
public void ConfigureServices(IServiceCollection services)
{
services
.AddHealthChecks()
.AddAzureDigitalTwinInstance(
"MyDigitalTwinClientId",
"MyDigitalTwinClientSecret",
"TenantId",
"https://my-awesome-dt-host",
"my_dt_instance_name");
}
... or with the token credentials flow that you want:
using Azure.Core;
using Azure.Identity;
using Microsoft.Extensions.DependencyInjection;
public void ConfigureServices(IServiceCollection services)
{
TokenCredential credentials = new DefaultAzureCredential();
services
.AddHealthChecks()
.AddAzureDigitalTwinInstance(
credentials,
"https://my-awesome-dt-host",
"my_dt_instance_name");
}
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. 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 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 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.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 was computed. 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. |
-
.NETStandard 2.0
- Azure.DigitalTwins.Core (>= 1.6.0)
- Azure.Identity (>= 1.21.0)
- Azure.ResourceManager.DigitalTwins (>= 1.3.2)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 8.0.31)
-
net10.0
- Azure.DigitalTwins.Core (>= 1.6.0)
- Azure.Identity (>= 1.21.0)
- Azure.ResourceManager.DigitalTwins (>= 1.3.2)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 10.0.12)
-
net8.0
- Azure.DigitalTwins.Core (>= 1.6.0)
- Azure.Identity (>= 1.21.0)
- Azure.ResourceManager.DigitalTwins (>= 1.3.2)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 8.0.31)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.