EntityFrameworkCoreHealthChecksBuilderExtensions.AddDbContextCheck<TContext> Método

Definición

Espacio de nombres:

Microsoft.Extensions.DependencyInjection

Ensamblado:

Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore.dll

Paquete:

Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore v8.0.4

Source:

EntityFrameworkCoreHealthChecksBuilderExtensions.cs

Agrega una comprobación de estado para el tipo especificado 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

Parámetros de tipo

TContext

El tipo de la clase DbContext.

Parámetros

builder

IHealthChecksBuilder

El parámetro de cadena de consulta IHealthChecksBuilder.

name

String

El nombre de la comprobación de estado. Opcional. Si null el nombre de tipo de TContext se usará para el nombre.

failureStatus

Nullable<HealthStatus>

que HealthStatus se debe notificar cuando se produce un error en la comprobación de estado. Opcional. Si null , a continuación, se notificará el estado predeterminado de Unhealthy .

tags

IEnumerable<String>

Lista de etiquetas que se pueden usar para filtrar conjuntos de comprobaciones de estado. Opcional.

customTestQuery

Func<TContext,CancellationToken,Task<Boolean>>

Una consulta de prueba personalizada que se ejecutará cuando se ejecute la comprobación de estado para probar el estado de la conexión y las configuraciones de la base de datos.

Devoluciones

IHealthChecksBuilder

El parámetro de cadena de consulta IHealthChecksBuilder.

Comentarios

La implementación de comprobación de estado agregada por este método usará el contenedor de inserción de dependencias para crear una instancia de TContext.

De forma predeterminada, la implementación de comprobación de estado usará el método para probar la CanConnectAsync(CancellationToken) conectividad con la base de datos. Este método requiere que el proveedor de base de datos haya implementado correctamente la IDatabaseCreator interfaz . Si el proveedor de base de datos no ha implementado esta interfaz, la comprobación de estado notificará un error.

Proporcionar un customTestQuery elemento reemplazará el uso de para probar la conectividad de la base de CanConnectAsync(CancellationToken) datos. Una implementación de una consulta de prueba debe controlar las excepciones que pueden surgir debido a un error de conectividad y debe devolver un resultado de paso o error. La consulta de prueba debe diseñarse para completarse en una cantidad de tiempo breve y predicable.