EntityFrameworkCoreHealthChecksBuilderExtensions.AddDbContextCheck<TContext> Metodo
Definizione
Importante
Alcune informazioni sono relative alla release non definitiva del prodotto, che potrebbe subire modifiche significative prima della release definitiva. Microsoft non riconosce alcuna garanzia, espressa o implicita, in merito alle informazioni qui fornite.
Aggiunge un controllo di integrità per il tipo specificato 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 IHealthChecksBuilderParametri di tipo
- TContext
Il tipo DbContext.
Parametri
- builder
- IHealthChecksBuilder
- name
- String
Nome del controllo di integrità. Optional. Se null il nome del tipo di TContext verrà usato per il nome.
- failureStatus
- Nullable<HealthStatus>
Oggetto HealthStatus che deve essere segnalato quando il controllo integrità ha esito negativo. Optional. Se null quindi verrà segnalato lo stato predefinito di Unhealthy .
- tags
- IEnumerable<String>
Elenco di tag che possono essere usati per filtrare i set di controlli di integrità. Optional.
- customTestQuery
- Func<TContext,CancellationToken,Task<Boolean>>
Query di test personalizzata che verrà eseguita quando viene eseguito il controllo integrità per testare l'integrità della connessione e delle configurazioni del database.
Valori restituiti
Commenti
L'implementazione del controllo di integrità aggiunta da questo metodo userà il contenitore di inserimento delle dipendenze per creare un'istanza di TContext.
Per impostazione predefinita, l'implementazione del controllo integrità userà il metodo per testare la CanConnectAsync(CancellationToken) connettività al database. Questo metodo richiede che il provider di database abbia implementato correttamente l'interfaccia IDatabaseCreator . Se il provider di database non ha implementato questa interfaccia, il controllo integrità segnala un errore.
Se si specifica un oggetto customTestQuery , verrà sostituito l'uso di per testare la connettività del CanConnectAsync(CancellationToken) database. Un'implementazione di una query di test deve gestire le eccezioni che possono verificarsi a causa di un errore di connettività e deve restituire un risultato pass/fail. La query di test deve essere progettata per essere completata in un intervallo di tempo breve e predicabile.
