EntityFrameworkCoreHealthChecksBuilderExtensions.AddDbContextCheck<TContext> Méthode
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Ajoute un contrôle 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 IHealthChecksBuilderParamètres de type
- TContext
Le type DbContext.
Paramètres
- builder
- IHealthChecksBuilder
L’attribut IHealthChecksBuilder.
- name
- String
Nom du case activée d’intégrité. Optionnel. Si null le nom de type est TContext utilisé pour le nom.
- failureStatus
- Nullable<HealthStatus>
Qui HealthStatus doit être signalé lorsque le contrôle d’intégrité échoue. Optionnel. Si null l’état par défaut de celui-ci Unhealthy est signalé.
- tags
- IEnumerable<String>
Liste des balises qui peuvent être utilisées pour filtrer des ensembles de vérifications d’intégrité. Optionnel.
- customTestQuery
- Func<TContext,CancellationToken,Task<Boolean>>
Requête de test personnalisée qui sera exécutée lorsque la vérification d’intégrité s’exécute pour tester l’intégrité de la connexion et des configurations de base de données.
Retours
L’attribut IHealthChecksBuilder.
Remarques
L’implémentation de contrôle d’intégrité ajoutée par cette méthode utilise le conteneur d’injection de dépendances pour créer une instance de TContext.
Par défaut, l’implémentation de contrôle 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, la vérification d’intégrité signale un échec.
Fournir un customTestQuery remplacement de l’utilisation de la connectivité de base de données pour tester la connectivité de base de CanConnectAsync(CancellationToken) données. Une implémentation d’une requête de test doit gérer les exceptions qui peuvent survenir en raison d’une défaillance 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 délai court et prédicatable.
