1 <?xml version="1.0"?>
\r
4 <name>Microsoft.Extensions.Diagnostics.HealthChecks</name>
\r
7 <member name="T:Microsoft.Extensions.Diagnostics.HealthChecks.DelegateHealthCheck">
\r
9 A simple implementation of <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/> which uses a provided delegate to
\r
10 implement the check.
\r
13 <member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.DelegateHealthCheck.#ctor(System.Func{System.Threading.CancellationToken,System.Threading.Tasks.Task{Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult}})">
\r
15 Create an instance of <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.DelegateHealthCheck"/> from the specified delegate.
\r
17 <param name="check">A delegate which provides the code to execute when the health check is run.</param>
\r
19 <member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.DelegateHealthCheck.CheckHealthAsync(Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckContext,System.Threading.CancellationToken)">
\r
21 Runs the health check, returning the status of the component being checked.
\r
23 <param name="context">A context object associated with the current execution.</param>
\r
24 <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> that can be used to cancel the health check.</param>
\r
25 <returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that completes when the health check has finished, yielding the status of the component being checked.</returns>
\r
27 <member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckLogScope.#ctor(System.String)">
\r
29 Creates a new instance of <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckLogScope"/> with the provided name.
\r
31 <param name="healthCheckName">The name of the health check being executed.</param>
\r
33 <member name="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckPublisherOptions">
\r
35 Options for the default service that executes <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheckPublisher"/> instances.
\r
38 <member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckPublisherOptions.#ctor">
\r
40 Creates a new instance of <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckPublisherOptions"/>.
\r
43 <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckPublisherOptions.Delay">
\r
45 Gets or sets the initial delay applied after the application starts before executing
\r
46 <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheckPublisher"/> instances. The delay is applied once at startup, and does
\r
47 not apply to subsequent iterations. The default value is 5 seconds.
\r
50 <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckPublisherOptions.Period">
\r
52 Gets or sets the period of <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheckPublisher"/> execution. The default value is
\r
56 The <see cref="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckPublisherOptions.Period"/> cannot be set to a value lower than 1 second.
\r
59 <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckPublisherOptions.Predicate">
\r
61 Gets or sets a predicate that is used to filter the set of health checks executed.
\r
64 If <see cref="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckPublisherOptions.Predicate"/> is <c>null</c>, the health check publisher service will run all
\r
65 registered health checks - this is the default behavior. To run a subset of health checks,
\r
66 provide a function that filters the set of checks. The predicate will be evaluated each period.
\r
69 <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckPublisherOptions.Timeout">
\r
71 Gets or sets the timeout for executing the health checks an all <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheckPublisher"/>
\r
72 instances. Use <see cref="F:System.Threading.Timeout.InfiniteTimeSpan"/> to execute with no timeout.
\r
73 The default value is 30 seconds.
\r
76 <member name="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckService">
\r
78 A service which can be used to check the status of <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/> instances
\r
79 registered in the application.
\r
83 The default implementation of <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckService"/> is registered in the dependency
\r
84 injection container as a singleton service by calling
\r
85 <see cref="M:Microsoft.Extensions.DependencyInjection.HealthCheckServiceCollectionExtensions.AddHealthChecks(Microsoft.Extensions.DependencyInjection.IServiceCollection)"/>.
\r
88 The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/> returned by
\r
89 <see cref="M:Microsoft.Extensions.DependencyInjection.HealthCheckServiceCollectionExtensions.AddHealthChecks(Microsoft.Extensions.DependencyInjection.IServiceCollection)"/>
\r
90 provides a convenience API for registering health checks.
\r
93 <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/> implementations can be registered through extension methods provided by
\r
94 <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.
\r
98 <member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckService.CheckHealthAsync(System.Threading.CancellationToken)">
\r
100 Runs all the health checks in the application and returns the aggregated status.
\r
102 <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> which can be used to cancel the health checks.</param>
\r
104 A <see cref="T:System.Threading.Tasks.Task`1"/> which will complete when all the health checks have been run,
\r
105 yielding a <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReport"/> containing the results.
\r
108 <member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckService.CheckHealthAsync(System.Func{Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration,System.Boolean},System.Threading.CancellationToken)">
\r
110 Runs the provided health checks and returns the aggregated status
\r
112 <param name="predicate">
\r
113 A predicate that can be used to include health checks based on user-defined criteria.
\r
115 <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> which can be used to cancel the health checks.</param>
\r
117 A <see cref="T:System.Threading.Tasks.Task`1"/> which will complete when all the health checks have been run,
\r
118 yielding a <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReport"/> containing the results.
\r
121 <member name="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckServiceOptions">
\r
123 Options for the default implementation of <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckService"/>
\r
126 <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckServiceOptions.Registrations">
\r
128 Gets the health check registrations.
\r
131 <member name="T:Microsoft.Extensions.DependencyInjection.HealthChecksBuilderAddCheckExtensions">
\r
133 Provides basic extension methods for registering <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/> instances in an <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.
\r
136 <member name="M:Microsoft.Extensions.DependencyInjection.HealthChecksBuilderAddCheckExtensions.AddCheck(Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder,System.String,Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck,System.Nullable{Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus},System.Collections.Generic.IEnumerable{System.String})">
\r
138 Adds a new health check with the specified name and implementation.
\r
140 <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</param>
\r
141 <param name="name">The name of the health check.</param>
\r
142 <param name="instance">An <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/> instance.</param>
\r
143 <param name="failureStatus">
\r
144 The <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus"/> that should be reported when the health check reports a failure. If the provided value
\r
145 is <c>null</c>, then <see cref="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Unhealthy"/> will be reported.
\r
147 <param name="tags">A list of tags that can be used to filter health checks.</param>
\r
148 <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</returns>
\r
150 <member name="M:Microsoft.Extensions.DependencyInjection.HealthChecksBuilderAddCheckExtensions.AddCheck(Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder,System.String,Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck,System.Nullable{Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus},System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.TimeSpan})">
\r
152 Adds a new health check with the specified name and implementation.
\r
154 <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</param>
\r
155 <param name="name">The name of the health check.</param>
\r
156 <param name="instance">An <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/> instance.</param>
\r
157 <param name="failureStatus">
\r
158 The <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus"/> that should be reported when the health check reports a failure. If the provided value
\r
159 is <c>null</c>, then <see cref="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Unhealthy"/> will be reported.
\r
161 <param name="tags">A list of tags that can be used to filter health checks.</param>
\r
162 <param name="timeout">An optional <see cref="T:System.TimeSpan"/> representing the timeout of the check.</param>
\r
163 <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</returns>
\r
165 <member name="M:Microsoft.Extensions.DependencyInjection.HealthChecksBuilderAddCheckExtensions.AddCheck``1(Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder,System.String,System.Nullable{Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus},System.Collections.Generic.IEnumerable{System.String})">
\r
167 Adds a new health check with the specified name and implementation.
\r
169 <typeparam name="T">The health check implementation type.</typeparam>
\r
170 <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</param>
\r
171 <param name="name">The name of the health check.</param>
\r
172 <param name="failureStatus">
\r
173 The <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus"/> that should be reported when the health check reports a failure. If the provided value
\r
174 is <c>null</c>, then <see cref="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Unhealthy"/> will be reported.
\r
176 <param name="tags">A list of tags that can be used to filter health checks.</param>
\r
177 <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</returns>
\r
179 This method will use <see cref="M:Microsoft.Extensions.DependencyInjection.ActivatorUtilities.GetServiceOrCreateInstance``1(System.IServiceProvider)"/> to create the health check
\r
180 instance when needed. If a service of type <typeparamref name="T"/> is registered in the dependency injection container
\r
181 with any lifetime it will be used. Otherwise an instance of type <typeparamref name="T"/> will be constructed with
\r
182 access to services from the dependency injection container.
\r
185 <member name="M:Microsoft.Extensions.DependencyInjection.HealthChecksBuilderAddCheckExtensions.AddCheck``1(Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder,System.String,System.Nullable{Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus},System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.TimeSpan})">
\r
187 Adds a new health check with the specified name and implementation.
\r
189 <typeparam name="T">The health check implementation type.</typeparam>
\r
190 <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</param>
\r
191 <param name="name">The name of the health check.</param>
\r
192 <param name="failureStatus">
\r
193 The <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus"/> that should be reported when the health check reports a failure. If the provided value
\r
194 is <c>null</c>, then <see cref="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Unhealthy"/> will be reported.
\r
196 <param name="tags">A list of tags that can be used to filter health checks.</param>
\r
197 <param name="timeout">An optional <see cref="T:System.TimeSpan"/> representing the timeout of the check.</param>
\r
198 <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</returns>
\r
200 This method will use <see cref="M:Microsoft.Extensions.DependencyInjection.ActivatorUtilities.GetServiceOrCreateInstance``1(System.IServiceProvider)"/> to create the health check
\r
201 instance when needed. If a service of type <typeparamref name="T"/> is registered in the dependency injection container
\r
202 with any lifetime it will be used. Otherwise an instance of type <typeparamref name="T"/> will be constructed with
\r
203 access to services from the dependency injection container.
\r
206 <member name="M:Microsoft.Extensions.DependencyInjection.HealthChecksBuilderAddCheckExtensions.AddTypeActivatedCheck``1(Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder,System.String,System.Object[])">
\r
208 Adds a new type activated health check with the specified name and implementation.
\r
210 <typeparam name="T">The health check implementation type.</typeparam>
\r
211 <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</param>
\r
212 <param name="name">The name of the health check.</param>
\r
213 <param name="args">Additional arguments to provide to the constructor.</param>
\r
214 <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</returns>
\r
216 This method will use <see cref="M:Microsoft.Extensions.DependencyInjection.ActivatorUtilities.CreateInstance``1(System.IServiceProvider,System.Object[])"/> to create the health check
\r
217 instance when needed. Additional arguments can be provided to the constructor via <paramref name="args"/>.
\r
220 <member name="M:Microsoft.Extensions.DependencyInjection.HealthChecksBuilderAddCheckExtensions.AddTypeActivatedCheck``1(Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder,System.String,System.Nullable{Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus},System.Object[])">
\r
222 Adds a new type activated health check with the specified name and implementation.
\r
224 <typeparam name="T">The health check implementation type.</typeparam>
\r
225 <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</param>
\r
226 <param name="name">The name of the health check.</param>
\r
227 <param name="failureStatus">
\r
228 The <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus"/> that should be reported when the health check reports a failure. If the provided value
\r
229 is <c>null</c>, then <see cref="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Unhealthy"/> will be reported.
\r
231 <param name="args">Additional arguments to provide to the constructor.</param>
\r
232 <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</returns>
\r
234 This method will use <see cref="M:Microsoft.Extensions.DependencyInjection.ActivatorUtilities.CreateInstance``1(System.IServiceProvider,System.Object[])"/> to create the health check
\r
235 instance when needed. Additional arguments can be provided to the constructor via <paramref name="args"/>.
\r
238 <member name="M:Microsoft.Extensions.DependencyInjection.HealthChecksBuilderAddCheckExtensions.AddTypeActivatedCheck``1(Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder,System.String,System.Nullable{Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus},System.Collections.Generic.IEnumerable{System.String},System.Object[])">
\r
240 Adds a new type activated health check with the specified name and implementation.
\r
242 <typeparam name="T">The health check implementation type.</typeparam>
\r
243 <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</param>
\r
244 <param name="name">The name of the health check.</param>
\r
245 <param name="failureStatus">
\r
246 The <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus"/> that should be reported when the health check reports a failure. If the provided value
\r
247 is <c>null</c>, then <see cref="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Unhealthy"/> will be reported.
\r
249 <param name="tags">A list of tags that can be used to filter health checks.</param>
\r
250 <param name="args">Additional arguments to provide to the constructor.</param>
\r
251 <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</returns>
\r
253 This method will use <see cref="M:Microsoft.Extensions.DependencyInjection.ActivatorUtilities.CreateInstance``1(System.IServiceProvider,System.Object[])"/> to create the health check
\r
254 instance when needed. Additional arguments can be provided to the constructor via <paramref name="args"/>.
\r
257 <member name="M:Microsoft.Extensions.DependencyInjection.HealthChecksBuilderAddCheckExtensions.AddTypeActivatedCheck``1(Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder,System.String,System.Nullable{Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus},System.Collections.Generic.IEnumerable{System.String},System.TimeSpan,System.Object[])">
\r
259 Adds a new type activated health check with the specified name and implementation.
\r
261 <typeparam name="T">The health check implementation type.</typeparam>
\r
262 <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</param>
\r
263 <param name="name">The name of the health check.</param>
\r
264 <param name="failureStatus">
\r
265 The <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus"/> that should be reported when the health check reports a failure. If the provided value
\r
266 is <c>null</c>, then <see cref="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Unhealthy"/> will be reported.
\r
268 <param name="tags">A list of tags that can be used to filter health checks.</param>
\r
269 <param name="args">Additional arguments to provide to the constructor.</param>
\r
270 <param name="timeout">A <see cref="T:System.TimeSpan"/> representing the timeout of the check.</param>
\r
271 <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</returns>
\r
273 This method will use <see cref="M:Microsoft.Extensions.DependencyInjection.ActivatorUtilities.CreateInstance``1(System.IServiceProvider,System.Object[])"/> to create the health check
\r
274 instance when needed. Additional arguments can be provided to the constructor via <paramref name="args"/>.
\r
277 <member name="T:Microsoft.Extensions.DependencyInjection.HealthChecksBuilderDelegateExtensions">
\r
279 Provides extension methods for registering delegates with the <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.
\r
282 <member name="M:Microsoft.Extensions.DependencyInjection.HealthChecksBuilderDelegateExtensions.AddCheck(Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder,System.String,System.Func{Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult},System.Collections.Generic.IEnumerable{System.String})">
\r
284 Adds a new health check with the specified name and implementation.
\r
286 <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</param>
\r
287 <param name="name">The name of the health check.</param>
\r
288 <param name="tags">A list of tags that can be used to filter health checks.</param>
\r
289 <param name="check">A delegate that provides the health check implementation.</param>
\r
290 <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</returns>
\r
292 <member name="M:Microsoft.Extensions.DependencyInjection.HealthChecksBuilderDelegateExtensions.AddCheck(Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder,System.String,System.Func{Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult},System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.TimeSpan})">
\r
294 Adds a new health check with the specified name and implementation.
\r
296 <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</param>
\r
297 <param name="name">The name of the health check.</param>
\r
298 <param name="tags">A list of tags that can be used to filter health checks.</param>
\r
299 <param name="check">A delegate that provides the health check implementation.</param>
\r
300 <param name="timeout">An optional <see cref="T:System.TimeSpan"/> representing the timeout of the check.</param>
\r
301 <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</returns>
\r
303 <member name="M:Microsoft.Extensions.DependencyInjection.HealthChecksBuilderDelegateExtensions.AddCheck(Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder,System.String,System.Func{System.Threading.CancellationToken,Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult},System.Collections.Generic.IEnumerable{System.String})">
\r
305 Adds a new health check with the specified name and implementation.
\r
307 <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</param>
\r
308 <param name="name">The name of the health check.</param>
\r
309 <param name="tags">A list of tags that can be used to filter health checks.</param>
\r
310 <param name="check">A delegate that provides the health check implementation.</param>
\r
311 <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</returns>
\r
313 <member name="M:Microsoft.Extensions.DependencyInjection.HealthChecksBuilderDelegateExtensions.AddCheck(Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder,System.String,System.Func{System.Threading.CancellationToken,Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult},System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.TimeSpan})">
\r
315 Adds a new health check with the specified name and implementation.
\r
317 <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</param>
\r
318 <param name="name">The name of the health check.</param>
\r
319 <param name="tags">A list of tags that can be used to filter health checks.</param>
\r
320 <param name="check">A delegate that provides the health check implementation.</param>
\r
321 <param name="timeout">An optional <see cref="T:System.TimeSpan"/> representing the timeout of the check.</param>
\r
322 <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</returns>
\r
324 <member name="M:Microsoft.Extensions.DependencyInjection.HealthChecksBuilderDelegateExtensions.AddAsyncCheck(Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder,System.String,System.Func{System.Threading.Tasks.Task{Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult}},System.Collections.Generic.IEnumerable{System.String})">
\r
326 Adds a new health check with the specified name and implementation.
\r
328 <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</param>
\r
329 <param name="name">The name of the health check.</param>
\r
330 <param name="tags">A list of tags that can be used to filter health checks.</param>
\r
331 <param name="check">A delegate that provides the health check implementation.</param>
\r
332 <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</returns>
\r
334 <member name="M:Microsoft.Extensions.DependencyInjection.HealthChecksBuilderDelegateExtensions.AddAsyncCheck(Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder,System.String,System.Func{System.Threading.Tasks.Task{Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult}},System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.TimeSpan})">
\r
336 Adds a new health check with the specified name and implementation.
\r
338 <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</param>
\r
339 <param name="name">The name of the health check.</param>
\r
340 <param name="tags">A list of tags that can be used to filter health checks.</param>
\r
341 <param name="check">A delegate that provides the health check implementation.</param>
\r
342 <param name="timeout">An optional <see cref="T:System.TimeSpan"/> representing the timeout of the check.</param>
\r
343 <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</returns>
\r
345 <member name="M:Microsoft.Extensions.DependencyInjection.HealthChecksBuilderDelegateExtensions.AddAsyncCheck(Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder,System.String,System.Func{System.Threading.CancellationToken,System.Threading.Tasks.Task{Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult}},System.Collections.Generic.IEnumerable{System.String})">
\r
347 Adds a new health check with the specified name and implementation.
\r
349 <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</param>
\r
350 <param name="name">The name of the health check.</param>
\r
351 <param name="tags">A list of tags that can be used to filter health checks.</param>
\r
352 <param name="check">A delegate that provides the health check implementation.</param>
\r
353 <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</returns>
\r
355 <member name="M:Microsoft.Extensions.DependencyInjection.HealthChecksBuilderDelegateExtensions.AddAsyncCheck(Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder,System.String,System.Func{System.Threading.CancellationToken,System.Threading.Tasks.Task{Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult}},System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.TimeSpan})">
\r
357 Adds a new health check with the specified name and implementation.
\r
359 <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</param>
\r
360 <param name="name">The name of the health check.</param>
\r
361 <param name="tags">A list of tags that can be used to filter health checks.</param>
\r
362 <param name="check">A delegate that provides the health check implementation.</param>
\r
363 <param name="timeout">An optional <see cref="T:System.TimeSpan"/> representing the timeout of the check.</param>
\r
364 <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</returns>
\r
366 <member name="T:Microsoft.Extensions.DependencyInjection.HealthCheckServiceCollectionExtensions">
\r
368 Provides extension methods for registering <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckService"/> in an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.
\r
371 <member name="M:Microsoft.Extensions.DependencyInjection.HealthCheckServiceCollectionExtensions.AddHealthChecks(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
\r
373 Adds the <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckService"/> to the container, using the provided delegate to register
\r
377 This operation is idempotent - multiple invocations will still only result in a single
\r
378 <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckService"/> instance in the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>. It can be invoked
\r
379 multiple times in order to get access to the <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/> in multiple places.
\r
381 <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to add the <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckService"/> to.</param>
\r
382 <returns>An instance of <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/> from which health checks can be registered.</returns>
\r
384 <member name="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder">
\r
386 A builder used to register health checks.
\r
389 <member name="M:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder.Add(Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration)">
\r
391 Adds a <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration"/> for a health check.
\r
393 <param name="registration">The <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration"/>.</param>
\r
395 <member name="P:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder.Services">
\r
397 Gets the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> into which <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/> instances should be registered.
\r