EntityFrameworkCoreHealthChecksBuilderExtensions.AddDbContextCheck<TContext> Méthode

Définition

Espace de noms:

Microsoft.Extensions.DependencyInjection

Assembly:

Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore.dll

Paquet:

Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore v8.0.5

Source:

EntityFrameworkCoreHealthChecksBuilderExtensions.cs

Ajoute une case activée d’intégrité pour le type spécifiéDbContext.

public static Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder AddDbContextCheck<TContext> (this Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder builder, string? name = default, Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus? failureStatus = default, System.Collections.Generic.IEnumerable<string>? tags = default, Func<TContext,System.Threading.CancellationToken,System.Threading.Tasks.Task<bool>>? customTestQuery = default) where TContext : Microsoft.EntityFrameworkCore.DbContext;

static member AddDbContextCheck : Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder * string * Nullable<Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus> * seq<string> * Func<'Context, System.Threading.CancellationToken, System.Threading.Tasks.Task<bool> (requires 'Context :> Microsoft.EntityFrameworkCore.DbContext)> -> Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder (requires 'Context :> Microsoft.EntityFrameworkCore.DbContext)

<Extension()>
Public Function AddDbContextCheck(Of TContext As DbContext) (builder As IHealthChecksBuilder, Optional name As String = Nothing, Optional failureStatus As Nullable(Of HealthStatus) = Nothing, Optional tags As IEnumerable(Of String) = Nothing, Optional customTestQuery As Func(Of TContext, CancellationToken, Task(Of Boolean)) = Nothing) As IHealthChecksBuilder

Paramètres de type

TContext

Type de DbContext.

Paramètres

builder

IHealthChecksBuilder

Le IHealthChecksBuilder.

name

String

Nom du contrôle d’intégrité. facultatif. Si null le nom de type est TContext utilisé pour le nom.

failureStatus

Nullable<HealthStatus>

HealthStatus qui doit être signalé en cas d’échec de l’case activée d’intégrité. facultatif. Si null alors le status par défaut de Unhealthy est signalé.

tags

IEnumerable<String>

Liste des balises qui peuvent être utilisées pour filtrer des ensembles de contrôles d’intégrité. facultatif.

customTestQuery

Func<TContext,CancellationToken,Task<Boolean>>

Requête de test personnalisée qui sera exécutée lorsque le case activée d’intégrité s’exécute pour tester l’intégrité de la connexion et des configurations de la base de données.

Retours

IHealthChecksBuilder

Le IHealthChecksBuilder.

Remarques

L’implémentation de case activée d’intégrité ajoutée par cette méthode utilise le conteneur d’injection de dépendances pour créer un instance de TContext.

Par défaut, l’implémentation de case activée d’intégrité utilise la méthode pour tester la CanConnectAsync(CancellationToken) connectivité à la base de données. Cette méthode nécessite que le fournisseur de base de données ait correctement implémenté l’interface IDatabaseCreator . Si le fournisseur de base de données n’a pas implémenté cette interface, le case activée d’intégrité signale une défaillance.

Fournir un customTestQuery remplacera l’utilisation de pour tester la connectivité de CanConnectAsync(CancellationToken) base de données. Une implémentation d’une requête de test doit gérer les exceptions qui peuvent survenir en raison d’un échec de connectivité et doit retourner un résultat de réussite/échec. La requête de test doit être conçue pour se terminer dans un laps de temps court et prédicaable.